A versatible sparse matrix representation. More...

#include <SparseMatrix.h>

Inheritance diagram for Eigen::SparseMatrix< _Scalar, _Options, _Index >:

Classes
struct	default_prunning_func
class	InnerIterator
class	ReverseInnerIterator
class	SingletonVector
Public Types
enum	{ Options = _Options }
typedef MappedSparseMatrix < Scalar, Flags >	Map
typedef internal::CompressedStorage < Scalar, Index >	Storage
Public Member Functions
Scalar	coeff (Index row, Index col) const
Scalar &	coeffRef (Index row, Index col)
Index	cols () const
void	conservativeResize (Index rows, Index cols)
Storage &	data ()
const Storage &	data () const
const Diagonal< const SparseMatrix >	diagonal () const
void	finalize ()
const Index *	innerIndexPtr () const
Index *	innerIndexPtr ()
const Index *	innerNonZeroPtr () const
Index *	innerNonZeroPtr ()
Index	innerSize () const
Scalar &	insert (Index row, Index col)
Scalar &	insertBack (Index row, Index col)
Scalar &	insertBackByOuterInner (Index outer, Index inner)
Scalar &	insertBackByOuterInnerUnordered (Index outer, Index inner)
EIGEN_STRONG_INLINE Scalar &	insertBackUncompressed (Index row, Index col)
Scalar &	insertByOuterInner (Index j, Index i)
bool	isCompressed () const
void	makeCompressed ()
Index	nonZeros () const
SparseMatrix &	operator= (const SparseMatrix &other)
template<typename Lhs , typename Rhs >
SparseMatrix &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)
template<typename OtherDerived >
SparseMatrix &	operator= (const ReturnByValue< OtherDerived > &other)
template<typename OtherDerived >
SparseMatrix &	operator= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix &	operator= (const SparseMatrixBase< OtherDerived > &other)
const Index *	outerIndexPtr () const
Index *	outerIndexPtr ()
Index	outerSize () const
void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
template<typename KeepFunc >
void	prune (const KeepFunc &keep=KeepFunc())
void	reserve (Index reserveSize)
template<class SizesType >
void	reserve (const SizesType &reserveSizes, const typename SizesType::value_type &enableif=typename SizesType::value_type())
template<class SizesType >
void	reserve (const SizesType &reserveSizes, const typename SizesType::Scalar &enableif=typename SizesType::Scalar())
void	resize (Index rows, Index cols)
void	resizeNonZeros (Index size)
Index	rows () const
template<typename InputIterators >
void	setFromTriplets (const InputIterators &begin, const InputIterators &end)
void	setIdentity ()
void	setZero ()
	SparseMatrix ()
	SparseMatrix (Index rows, Index cols)
template<typename OtherDerived >
	SparseMatrix (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived , unsigned int UpLo>
	SparseMatrix (const SparseSelfAdjointView< OtherDerived, UpLo > &other)
	SparseMatrix (const SparseMatrix &other)
template<typename OtherDerived >
	SparseMatrix (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation.
void	startVec (Index outer)
Scalar	sum () const
void	sumupDuplicates ()
void	swap (SparseMatrix &other)
void	uncompress ()
const Scalar *	valuePtr () const
Scalar *	valuePtr ()
	~SparseMatrix ()
Protected Types
typedef SparseMatrix< Scalar,(Flags &~RowMajorBit)\|(IsRowMajor?RowMajorBit:0)>	TransposedSparseMatrix
Protected Member Functions
template<typename Other >
void	initAssignment (const Other &other)
Eigen::Map< Matrix< Index, Dynamic, 1 > >	innerNonZeros ()
const Eigen::Map< const Matrix < Index, Dynamic, 1 > >	innerNonZeros () const
EIGEN_DONT_INLINE Scalar &	insertCompressed (Index row, Index col)
EIGEN_DONT_INLINE Scalar &	insertUncompressed (Index row, Index col)
template<class SizesType >
void	reserveInnerVectors (const SizesType &reserveSizes)
Protected Attributes
Storage	m_data
Index *	m_innerNonZeros
Index	m_innerSize
Index *	m_outerIndex
Index	m_outerSize
Static Private Member Functions
static void	check_template_parameters ()
Friends
std::ostream &	operator<< (std::ostream &s, const SparseMatrix &m)

Detailed Description

template<typename _Scalar, int _Options, typename _Index>
class Eigen::SparseMatrix< _Scalar, _Options, _Index >

A versatible sparse matrix representation.

This class implements a more versatile variants of the common compressed row/column storage format. Each colmun's (resp. row) non zeros are stored as a pair of value with associated row (resp. colmiun) index. All the non zeros are stored in a single large buffer. Unlike the compressed format, there might be extra space inbetween the nonzeros of two successive colmuns (resp. rows) such that insertion of new non-zero can be done with limited memory reallocation and copies.

A call to the function makeCompressed() turns the matrix into the standard compressed format compatible with many library.

More details on this storage sceheme are given in the manual pages.

Template Parameters:

_Scalar	the scalar type, i.e. the type of the coefficients
_Options	Union of bit flags controlling the storage scheme. Currently the only possibility is ColMajor or RowMajor. The default is 0 which means column-major.
_Index	the type of the indices. It has to be a signed type (e.g., short, int, std::ptrdiff_t). Default is `int`.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_SPARSEMATRIX_PLUGIN.

Definition at line 85 of file SparseMatrix.h.

Member Typedef Documentation

template<typename _Scalar, int _Options, typename _Index>

typedef MappedSparseMatrix<Scalar,Flags> Eigen::SparseMatrix< _Scalar, _Options, _Index >::Map

Definition at line 93 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

typedef internal::CompressedStorage<Scalar,Index> Eigen::SparseMatrix< _Scalar, _Options, _Index >::Storage

Definition at line 95 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

typedef SparseMatrix<Scalar,(Flags&~RowMajorBit)|(IsRowMajor?RowMajorBit:0)> Eigen::SparseMatrix< _Scalar, _Options, _Index >::TransposedSparseMatrix [protected]

Definition at line 102 of file SparseMatrix.h.

Member Enumeration Documentation

template<typename _Scalar, int _Options, typename _Index>

anonymous enum

Enumerator:

Options

Definition at line 96 of file SparseMatrix.h.

Constructor & Destructor Documentation

template<typename _Scalar, int _Options, typename _Index>

Eigen::SparseMatrix< _Scalar, _Options, _Index >::SparseMatrix ( ) [inline]

Default constructor yielding an empty 0 x 0 matrix

Definition at line 629 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Eigen::SparseMatrix< _Scalar, _Options, _Index >::SparseMatrix	(	Index	rows,
		Index	cols
	)		`[inline]`

Constructs a rows x cols empty matrix

Definition at line 637 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _Index >::SparseMatrix ( const SparseMatrixBase< OtherDerived > & other ) [inline]

Constructs a sparse matrix from the sparse expression other

Definition at line 646 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived , unsigned int UpLo>

Eigen::SparseMatrix< _Scalar, _Options, _Index >::SparseMatrix ( const SparseSelfAdjointView< OtherDerived, UpLo > & other ) [inline]

Constructs a sparse matrix from the sparse selfadjoint view other

Definition at line 657 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Eigen::SparseMatrix< _Scalar, _Options, _Index >::SparseMatrix ( const SparseMatrix< _Scalar, _Options, _Index > & other ) [inline]

Copy constructor (it performs a deep copy)

Definition at line 665 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _Index >::SparseMatrix ( const ReturnByValue< OtherDerived > & other ) [inline]

Copy constructor with in-place evaluation.

Definition at line 674 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Eigen::SparseMatrix< _Scalar, _Options, _Index >::~SparseMatrix ( ) [inline]

Destructor

Definition at line 783 of file SparseMatrix.h.

Member Function Documentation

template<typename _Scalar, int _Options, typename _Index>

static void Eigen::SparseMatrix< _Scalar, _Options, _Index >::check_template_parameters ( ) [inline, static, private]

Definition at line 851 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar Eigen::SparseMatrix< _Scalar, _Options, _Index >::coeff	(	Index	row,
		Index	col
	)		const `[inline]`

Returns:: the value of the matrix at position i, j This function returns Scalar(0) if the element is an explicit zero

Definition at line 171 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::coeffRef	(	Index	row,
		Index	col
	)		`[inline]`

Returns:: a non-const reference to the value of the matrix at position i, j

If the element does not exist then it is inserted via the insert(Index,Index) function which itself turns the matrix into a non compressed form if that was not the case.

This is a O(log(nnz_j)) operation (binary search) plus the cost of insert(Index,Index) function if the element does not already exist.

Definition at line 189 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::cols ( void ) const [inline]

Returns:: the number of columns of the matrix

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 121 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::conservativeResize	(	Index	rows,
		Index	cols
	)		`[inline]`

Resizes the matrix to a rows x cols matrix leaving old values untouched.

See also:: resizeNonZeros(Index), reserve(), setZero()

Definition at line 532 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Storage& Eigen::SparseMatrix< _Scalar, _Options, _Index >::data ( ) [inline]

Definition at line 165 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Storage& Eigen::SparseMatrix< _Scalar, _Options, _Index >::data ( ) const [inline]

Definition at line 167 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Diagonal<const SparseMatrix> Eigen::SparseMatrix< _Scalar, _Options, _Index >::diagonal ( ) const [inline]

Returns:: a const expression of the diagonal coefficients

Definition at line 626 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::finalize ( ) [inline]

Definition at line 413 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename Other >

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::initAssignment ( const Other & other ) [inline, protected]

Definition at line 801 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerIndexPtr ( ) const [inline]

Returns:: a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

See also:: valuePtr(), outerIndexPtr()

Definition at line 140 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerIndexPtr ( ) [inline]

Returns:: a non-const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

See also:: valuePtr(), outerIndexPtr()

Definition at line 144 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerNonZeroPtr ( ) const [inline]

Returns:: a const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.

Warning:: it returns the null pointer 0 in compressed mode

Definition at line 158 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerNonZeroPtr ( ) [inline]

Returns:: a non-const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.

Warning:: it returns the null pointer 0 in compressed mode

Definition at line 162 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Eigen::Map<Matrix<Index,Dynamic,1> > Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerNonZeros ( ) [inline, protected]

Definition at line 110 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Eigen::Map<const Matrix<Index,Dynamic,1> > Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerNonZeros ( ) const [inline, protected]

Definition at line 111 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::innerSize ( ) const [inline]

Returns:: the number of rows (resp. columns) of the matrix if the storage order column major (resp. row major)

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 124 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::insert	(	Index	row,
		Index	col
	)		`[inline]`

Returns:: a reference to a novel non zero coefficient with coordinates row x col. The non zero coefficient must not already exist.

If the matrix *this is in compressed mode, then *this is turned into uncompressed mode while reserving room for 2 non zeros per inner vector. It is strongly recommended to first call reserve(const SizesType &) to reserve a more appropriate number of elements per inner vector that better match your scenario.

This function performs a sorted insertion in O(1) if the elements of each inner vector are inserted in increasing inner index order, and in O(nnz_j) for a random insertion.

Definition at line 220 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertBack	(	Index	row,
		Index	col
	)		`[inline]`

Definition at line 374 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertBackByOuterInner	(	Index	outer,
		Index	inner
	)		`[inline]`

Definition at line 381 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertBackByOuterInnerUnordered	(	Index	outer,
		Index	inner
	)		`[inline]`

Definition at line 393 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertBackUncompressed	(	Index	row,
		Index	col
	)		`[inline]`

Definition at line 837 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertByOuterInner	(	Index	j,
		Index	i
	)		`[inline]`

Definition at line 442 of file SparseMatrix.h.

template<typename _Scalar , int _Options, typename _Index >

EIGEN_DONT_INLINE SparseMatrix< _Scalar, _Options, _Index >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertCompressed	(	Index	row,
		Index	col
	)		`[protected]`

Definition at line 1151 of file SparseMatrix.h.

template<typename _Scalar , int _Options, typename _Index >

EIGEN_DONT_INLINE SparseMatrix< _Scalar, _Options, _Index >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _Index >::insertUncompressed	(	Index	row,
		Index	col
	)		`[protected]`

Definition at line 1119 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

bool Eigen::SparseMatrix< _Scalar, _Options, _Index >::isCompressed ( ) const [inline]

Returns:: whether *this is in compressed form.

Definition at line 116 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::makeCompressed ( ) [inline]

Turns the matrix into the compressed format.

Definition at line 449 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::nonZeros ( ) const [inline]

Returns:: the number of non zero coefficients

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 246 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _Index >::operator= ( const SparseMatrix< _Scalar, _Options, _Index > & other ) [inline]

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 703 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename Lhs , typename Rhs >

SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _Index >::operator= ( const SparseSparseProduct< Lhs, Rhs > & product ) [inline]

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 727 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _Index >::operator= ( const ReturnByValue< OtherDerived > & other ) [inline]

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 731 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _Index >::operator= ( const EigenBase< OtherDerived > & other ) [inline]

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 738 of file SparseMatrix.h.

template<typename Scalar , int _Options, typename _Index >

template<typename OtherDerived >

EIGEN_DONT_INLINE SparseMatrix< Scalar, _Options, _Index > & Eigen::SparseMatrix< Scalar, _Options, _Index >::operator= ( const SparseMatrixBase< OtherDerived > & other )

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 1058 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::outerIndexPtr ( ) const [inline]

Returns:: a const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

See also:: valuePtr(), innerIndexPtr()

Definition at line 149 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::outerIndexPtr ( ) [inline]

Returns:: a non-const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

See also:: valuePtr(), innerIndexPtr()

Definition at line 153 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::outerSize ( ) const [inline]

Returns:: the number of columns (resp. rows) of the matrix if the storage order column major (resp. row major)

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 126 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::prune	(	const Scalar &	reference,
		const RealScalar &	epsilon = `NumTraits<RealScalar>::dummy_precision()`
	)		`[inline]`

Suppresses all nonzeros which are much smaller than reference under the tolerence epsilon

Definition at line 490 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename KeepFunc >

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::prune ( const KeepFunc & keep = KeepFunc() ) [inline]

Turns the matrix into compressed format, and suppresses all nonzeros which do not satisfy the predicate keep. The functor type KeepFunc must implement the following function:

 bool operator() (const Index& row, const Index& col, const Scalar& value) const;

See also:: prune(Scalar,RealScalar)

Definition at line 503 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::reserve ( Index reserveSize ) [inline]

Preallocates reserveSize non zeros.

Precondition: the matrix must be in compressed mode.

Definition at line 256 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<class SizesType >

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::reserve	(	const SizesType &	reserveSizes,
		const typename SizesType::value_type &	enableif = `typename SizesType::value_type()`
	)		`[inline]`

Definition at line 270 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<class SizesType >

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::reserve	(	const SizesType &	reserveSizes,
		const typename SizesType::Scalar &	enableif = `typename SizesType::Scalar()`
	)		`[inline]`

Definition at line 276 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

template<class SizesType >

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::reserveInnerVectors ( const SizesType & reserveSizes ) [inline, protected]

Definition at line 288 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::resize	(	Index	rows,
		Index	cols
	)		`[inline]`

Resizes the matrix to a rows x cols matrix and initializes it to zero.

See also:: resizeNonZeros(Index), reserve(), setZero()

Definition at line 596 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::resizeNonZeros ( Index size ) [inline]

Definition at line 619 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::rows ( void ) const [inline]

Returns:: the number of rows of the matrix

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 119 of file SparseMatrix.h.

template<typename Scalar , int _Options, typename _Index >

template<typename InputIterators >

void Eigen::SparseMatrix< Scalar, _Options, _Index >::setFromTriplets	(	const InputIterators &	begin,
		const InputIterators &	end
	)

Fill the matrix *this with the list of triplets defined by the iterator range begin - end.

A triplet is a tuple (i,j,value) defining a non-zero element. The input list of triplets does not have to be sorted, and can contains duplicated elements. In any case, the result is a sorted and compressed sparse matrix where the duplicates have been summed up. This is a O(n) operation, with n the number of triplet elements. The initial contents of *this is destroyed. The matrix *this must be properly resized beforehand using the SparseMatrix(Index,Index) constructor, or the resize(Index,Index) method. The sizes are not extracted from the triplet list.

The InputIterators value_type must provide the following interface:

 Scalar value() const; // the value
 Scalar row() const;   // the row index i
 Scalar col() const;   // the column index j

See for instance the Eigen::Triplet template class.

Here is a typical usage example:

    typedef Triplet<double> T;
    std::vector<T> tripletList;
    triplets.reserve(estimation_of_entries);
    for(...)
    {
      // ...
      tripletList.push_back(T(i,j,v_ij));
    }
    SparseMatrixType m(rows,cols);
    m.setFromTriplets(tripletList.begin(), tripletList.end());
    // m is ready to go!

Warning:: The list of triplets is read multiple times (at least twice). Therefore, it is not recommended to define an abstract iterator over a complex data-structure that would be expensive to evaluate. The triplets should rather be explicitely stored into a std::vector for instance.

Definition at line 1011 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::setIdentity ( ) [inline]

Sets *this to the identity matrix

Definition at line 695 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::setZero ( ) [inline]

Removes all non zeros but keep allocated memory

Definition at line 237 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::startVec ( Index outer ) [inline]

Definition at line 403 of file SparseMatrix.h.

template<typename _Scalar , int _Options, typename _Index >

internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar Eigen::SparseMatrix< _Scalar, _Options, _Index >::sum ( ) const

Overloaded for performance

Reimplemented from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >.

Definition at line 29 of file SparseRedux.h.

template<typename Scalar , int _Options, typename _Index >

void Eigen::SparseMatrix< Scalar, _Options, _Index >::sumupDuplicates ( )

Definition at line 1018 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::swap ( SparseMatrix< _Scalar, _Options, _Index > & other ) [inline]

Swaps the content of two sparse matrices of the same type. This is a fast operation that simply swaps the underlying pointers and parameters.

Definition at line 684 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseMatrix< _Scalar, _Options, _Index >::uncompress ( ) [inline]

Turns the matrix into the uncompressed mode

Definition at line 478 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

const Scalar* Eigen::SparseMatrix< _Scalar, _Options, _Index >::valuePtr ( ) const [inline]

Returns:: a const pointer to the array of values. This function is aimed at interoperability with other libraries.

See also:: innerIndexPtr(), outerIndexPtr()

Definition at line 131 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar* Eigen::SparseMatrix< _Scalar, _Options, _Index >::valuePtr ( ) [inline]

Returns:: a non-const pointer to the array of values. This function is aimed at interoperability with other libraries.

See also:: innerIndexPtr(), outerIndexPtr()

Definition at line 135 of file SparseMatrix.h.

Friends And Related Function Documentation

template<typename _Scalar, int _Options, typename _Index>

std::ostream& operator<<	(	std::ostream &	s,
		const SparseMatrix< _Scalar, _Options, _Index > &	m
	)		`[friend]`

Definition at line 745 of file SparseMatrix.h.

Member Data Documentation

template<typename _Scalar, int _Options, typename _Index>

Storage Eigen::SparseMatrix< _Scalar, _Options, _Index >::m_data [protected]

Definition at line 108 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::m_innerNonZeros [protected]

Definition at line 107 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::m_innerSize [protected]

Definition at line 105 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index* Eigen::SparseMatrix< _Scalar, _Options, _Index >::m_outerIndex [protected]

Definition at line 106 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseMatrix< _Scalar, _Options, _Index >::m_outerSize [protected]

Definition at line 104 of file SparseMatrix.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Private Member Functions

Friends

Detailed Description

template<typename _Scalar, int _Options, typename _Index> class Eigen::SparseMatrix< _Scalar, _Options, _Index >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename _Scalar, int _Options, typename _Index>
class Eigen::SparseMatrix< _Scalar, _Options, _Index >