A versatible sparse matrix representation. More...

#include <SparseMatrix.h>

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

Classes
struct	default_prunning_func

class	SingletonVector

Public Types
enum	{ Options = _Options }

typedef Diagonal< const SparseMatrix >	ConstDiagonalReturnType

typedef Diagonal< SparseMatrix >	DiagonalReturnType

typedef Base::IndexVector	IndexVector

typedef Base::InnerIterator	InnerIterator

typedef MappedSparseMatrix< Scalar, Flags >	Map

typedef Base::ReverseInnerIterator	ReverseInnerIterator

typedef Base::ScalarVector	ScalarVector

typedef internal::CompressedStorage< Scalar, StorageIndex >	Storage

Public Types inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
typedef SparseMatrixBase< Derived >	Base

Public Member Functions
Scalar	coeff (Index row, Index col) const

Scalar &	coeffRef (Index row, Index col)

template<typename DupFunctor >
void	collapseDuplicates (DupFunctor dup_func=DupFunctor())

Index	cols () const

void	conservativeResize (Index rows, Index cols)

Storage &	data ()

const Storage &	data () const

DiagonalReturnType	diagonal ()

const ConstDiagonalReturnType	diagonal () const

void	finalize ()

StorageIndex *	innerIndexPtr ()

const StorageIndex *	innerIndexPtr () const

StorageIndex *	innerNonZeroPtr ()

const StorageIndex *	innerNonZeroPtr () const

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

template<typename OtherDerived >
SparseMatrix &	operator= (const EigenBase< OtherDerived > &other)

SparseMatrix &	operator= (const SparseMatrix &other)

template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix &	operator= (const SparseMatrixBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix< Scalar, _Options, _StorageIndex > &	operator= (const SparseMatrixBase< OtherDerived > &other)

StorageIndex *	outerIndexPtr ()

const StorageIndex *	outerIndexPtr () const

Index	outerSize () const

template<typename KeepFunc >
void	prune (const KeepFunc &keep=KeepFunc())

void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())

template<class SizesType >
void	reserve (const SizesType &reserveSizes, const typename SizesType::value_type &enableif=typename SizesType::value_type())

void	reserve (Index reserveSize)

void	resize (Index rows, Index cols)

void	resizeNonZeros (Index size)

Index	rows () const

template<typename InputIterators >
void	setFromTriplets (const InputIterators &begin, const InputIterators &end)

template<typename InputIterators , typename DupFunctor >
void	setFromTriplets (const InputIterators &begin, const InputIterators &end, DupFunctor dup_func)

void	setIdentity ()

void	setZero ()

	SparseMatrix ()

template<typename OtherDerived >
	SparseMatrix (const DiagonalBase< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...

template<typename OtherDerived >
	SparseMatrix (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...

	SparseMatrix (const SparseMatrix &other)

template<typename OtherDerived >
	SparseMatrix (const SparseMatrixBase< OtherDerived > &other)

template<typename OtherDerived , unsigned int UpLo>
	SparseMatrix (const SparseSelfAdjointView< OtherDerived, UpLo > &other)

	SparseMatrix (Index rows, Index cols)

void	startVec (Index outer)

Scalar	sum () const

void	sumupDuplicates ()

void	swap (SparseMatrix &other)

void	uncompress ()

Scalar *	valuePtr ()

const Scalar *	valuePtr () const

	~SparseMatrix ()

Public Member Functions inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
Map< Array< Scalar, Dynamic, 1 > >	coeffs ()

const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const

StorageIndex *	innerIndexPtr ()

const StorageIndex *	innerIndexPtr () const

StorageIndex *	innerNonZeroPtr ()

const StorageIndex *	innerNonZeroPtr () const

bool	isCompressed () const

Index	nonZeros () const

Derived &	operator= (const Derived &other)

Derived &	operator= (const Derived &other)

Derived &	operator= (const EigenBase< OtherDerived > &other)

Derived &	operator= (const ReturnByValue< OtherDerived > &other)

Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)

StorageIndex *	outerIndexPtr ()

const StorageIndex *	outerIndexPtr () const

Scalar *	valuePtr ()

const Scalar *	valuePtr () const

Protected Types
typedef SparseMatrix< Scalar,(Flags &~RowMajorBit)\|(IsRowMajor?RowMajorBit:0)>	TransposedSparseMatrix

Protected Types inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
typedef Base::IndexVector	IndexVector

Protected Member Functions
template<typename Other >
void	initAssignment (const Other &other)

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 Member Functions inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
Eigen::Map< IndexVector >	innerNonZeros ()

const Eigen::Map< const IndexVector >	innerNonZeros () const

	SparseCompressedBase ()

Protected Attributes
Storage	m_data

StorageIndex *	m_innerNonZeros

Index	m_innerSize

StorageIndex *	m_outerIndex

Index	m_outerSize

Private Types
typedef SparseCompressedBase< SparseMatrix >	Base

Static Private Member Functions
static void	check_template_parameters ()

Friends
std::ostream &	operator<< (std::ostream &s, const SparseMatrix &m)

class	SparseVector< _Scalar, 0, _StorageIndex >

Detailed Description

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

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.
_StorageIndex	the type of the indices. It has to be a signed type (e.g., short, int, std::ptrdiff_t). Default is `int`.

Warning: In Eigen 3.2, the undocumented type SparseMatrix::Index was improperly defined as the storage index type (e.g., int), whereas it is now (starting from Eigen 3.3) deprecated and always defined as Eigen::Index. Codes making use of SparseMatrix::Index, might thus likely have to be changed to use SparseMatrix::StorageIndex instead.

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

Definition at line 96 of file SparseMatrix.h.

Member Typedef Documentation

◆ Base

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef SparseCompressedBase<SparseMatrix> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::Base

private

Definition at line 99 of file SparseMatrix.h.

◆ ConstDiagonalReturnType

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Diagonal<const SparseMatrix> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::ConstDiagonalReturnType

Definition at line 111 of file SparseMatrix.h.

◆ DiagonalReturnType

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Diagonal<SparseMatrix> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::DiagonalReturnType

Definition at line 110 of file SparseMatrix.h.

◆ IndexVector

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::IndexVector Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::IndexVector

Definition at line 122 of file SparseMatrix.h.

◆ InnerIterator

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::InnerIterator Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::InnerIterator

Definition at line 112 of file SparseMatrix.h.

◆ Map

template<typename _Scalar , int _Options, typename _StorageIndex >

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

Definition at line 109 of file SparseMatrix.h.

◆ ReverseInnerIterator

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::ReverseInnerIterator Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::ReverseInnerIterator

Definition at line 113 of file SparseMatrix.h.

◆ ScalarVector

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::ScalarVector Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::ScalarVector

Definition at line 123 of file SparseMatrix.h.

◆ Storage

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef internal::CompressedStorage<Scalar,StorageIndex> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::Storage

Definition at line 117 of file SparseMatrix.h.

◆ TransposedSparseMatrix

template<typename _Scalar , int _Options, typename _StorageIndex >

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

protected

Definition at line 125 of file SparseMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , int _Options, typename _StorageIndex >

anonymous enum

Enumerator
Options

Definition at line 118 of file SparseMatrix.h.

Constructor & Destructor Documentation

◆ SparseMatrix() [1/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( )

inline

Default constructor yielding an empty 0 x 0 matrix

Definition at line 659 of file SparseMatrix.h.

◆ SparseMatrix() [2/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix	(	Index	rows,
		Index	cols
	)

inline

Constructs a rows x cols empty matrix

Definition at line 667 of file SparseMatrix.h.

◆ SparseMatrix() [3/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const SparseMatrixBase< OtherDerived > & other )

inline

Constructs a sparse matrix from the sparse expression other

Definition at line 676 of file SparseMatrix.h.

◆ SparseMatrix() [4/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived , unsigned int UpLo>

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const SparseSelfAdjointView< OtherDerived, UpLo > & other )

inline

Constructs a sparse matrix from the sparse selfadjoint view other

Definition at line 696 of file SparseMatrix.h.

◆ SparseMatrix() [5/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const SparseMatrix< _Scalar, _Options, _StorageIndex > & other )

inline

Copy constructor (it performs a deep copy)

Definition at line 704 of file SparseMatrix.h.

◆ SparseMatrix() [6/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const ReturnByValue< OtherDerived > & other )

inline

Copy constructor with in-place evaluation.

Definition at line 713 of file SparseMatrix.h.

◆ SparseMatrix() [7/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const DiagonalBase< OtherDerived > & other )

inlineexplicit

Copy constructor with in-place evaluation.

Definition at line 723 of file SparseMatrix.h.

◆ ~SparseMatrix()

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::~SparseMatrix ( )

inline

Destructor

Definition at line 834 of file SparseMatrix.h.

Member Function Documentation

◆ check_template_parameters()

template<typename _Scalar , int _Options, typename _StorageIndex >

static void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::check_template_parameters ( )

inlinestaticprivate

Definition at line 900 of file SparseMatrix.h.

◆ coeff()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 188 of file SparseMatrix.h.

◆ coeffRef()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 206 of file SparseMatrix.h.

◆ collapseDuplicates()

template<typename Scalar , int _Options, typename _StorageIndex >

template<typename DupFunctor >

void Eigen::SparseMatrix< Scalar, _Options, _StorageIndex >::collapseDuplicates ( DupFunctor dup_func = DupFunctor() )

Definition at line 1017 of file SparseMatrix.h.

◆ cols()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::cols ( ) const

inline

Returns: the number of columns of the matrix

Definition at line 138 of file SparseMatrix.h.

◆ conservativeResize()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::conservativeResize	(	Index	rows,
		Index	cols
	)

inline

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

If the sizes of the matrix are decreased, then the matrix is turned to uncompressed-mode and the storage of the out of bounds coefficients is kept and reserved. Call makeCompressed() to pack the entries and squeeze extra memory.

See also: reserve(), setZero(), makeCompressed()

Definition at line 553 of file SparseMatrix.h.

◆ data() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

Storage& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::data ( )

inline

Definition at line 182 of file SparseMatrix.h.

◆ data() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const Storage& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::data ( ) const

inline

Definition at line 184 of file SparseMatrix.h.

◆ diagonal() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

DiagonalReturnType Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::diagonal ( )

inline

Returns: a read-write expression of the diagonal coefficients.

Warning: If the diagonal entries are written, then all diagonal entries must already exist, otherwise an assertion will be raised.

Definition at line 656 of file SparseMatrix.h.

◆ diagonal() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const ConstDiagonalReturnType Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::diagonal ( ) const

inline

Returns: a const expression of the diagonal coefficients.

Definition at line 650 of file SparseMatrix.h.

◆ finalize()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::finalize ( )

inline

Definition at line 422 of file SparseMatrix.h.

◆ initAssignment()

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename Other >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::initAssignment ( const Other & other )

inlineprotected

Definition at line 850 of file SparseMatrix.h.

◆ innerIndexPtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 161 of file SparseMatrix.h.

◆ innerIndexPtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 157 of file SparseMatrix.h.

◆ innerNonZeroPtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 179 of file SparseMatrix.h.

◆ innerNonZeroPtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 175 of file SparseMatrix.h.

◆ innerSize()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::innerSize ( ) const

inline

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

Definition at line 141 of file SparseMatrix.h.

◆ insert()

template<typename _Scalar , int _Options, typename _StorageIndex >

SparseMatrix< _Scalar, _Options, _StorageIndex >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insert	(	Index	row,
		Index	col
	)

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 x this->innerSize() non zeros if reserve(Index) has not been called earlier. In this case, the insertion procedure is optimized for a sequential insertion mode where elements are assumed to be inserted by increasing outer-indices.

If that's not the case, then it is strongly recommended to either use a triplet-list to assemble the matrix, or to first call reserve(const SizesType &) to reserve the appropriate number of non-zero elements per inner vector.

Assuming memory has been appropriately reserved, 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 1129 of file SparseMatrix.h.

◆ insertBack()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBack	(	Index	row,
		Index	col
	)

inline

Definition at line 383 of file SparseMatrix.h.

◆ insertBackByOuterInner()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBackByOuterInner	(	Index	outer,
		Index	inner
	)

inline

Definition at line 390 of file SparseMatrix.h.

◆ insertBackByOuterInnerUnordered()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBackByOuterInnerUnordered	(	Index	outer,
		Index	inner
	)

inline

Definition at line 402 of file SparseMatrix.h.

◆ insertBackUncompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

EIGEN_STRONG_INLINE Scalar& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBackUncompressed	(	Index	row,
		Index	col
	)

inline

Definition at line 886 of file SparseMatrix.h.

◆ insertByOuterInner()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertByOuterInner	(	Index	j,
		Index	i
	)

inline

Definition at line 457 of file SparseMatrix.h.

◆ insertCompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

EIGEN_DONT_INLINE SparseMatrix< _Scalar, _Options, _StorageIndex >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertCompressed	(	Index	row,
		Index	col
	)

protected

Definition at line 1281 of file SparseMatrix.h.

◆ insertUncompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

EIGEN_DONT_INLINE SparseMatrix< _Scalar, _Options, _StorageIndex >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertUncompressed	(	Index	row,
		Index	col
	)

protected

Definition at line 1249 of file SparseMatrix.h.

◆ isCompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

bool Eigen::SparseCompressedBase::isCompressed

inline

Returns: whether *this is in compressed form.

Definition at line 107 of file SparseCompressedBase.h.

◆ makeCompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::makeCompressed ( )

inline

Turns the matrix into the compressed format.

Definition at line 464 of file SparseMatrix.h.

◆ nonZeros()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseCompressedBase::nonZeros

inline

Returns: the number of non zero coefficients

Definition at line 56 of file SparseCompressedBase.h.

◆ operator=() [1/4]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator= ( const EigenBase< OtherDerived > & other )

inline

Definition at line 781 of file SparseMatrix.h.

◆ operator=() [2/4]

template<typename _Scalar , int _Options, typename _StorageIndex >

SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator= ( const SparseMatrix< _Scalar, _Options, _StorageIndex > & other )

inline

Definition at line 754 of file SparseMatrix.h.

◆ operator=() [3/4]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

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

◆ operator=() [4/4]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

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

Definition at line 1057 of file SparseMatrix.h.

◆ outerIndexPtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 170 of file SparseMatrix.h.

◆ outerIndexPtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 166 of file SparseMatrix.h.

◆ outerSize()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::outerSize ( ) const

inline

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

Definition at line 143 of file SparseMatrix.h.

◆ prune() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename KeepFunc >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 520 of file SparseMatrix.h.

◆ prune() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 507 of file SparseMatrix.h.

◆ reserve() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<class SizesType >

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

inline

Definition at line 285 of file SparseMatrix.h.

◆ reserve() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::reserve ( Index reserveSize )

inline

Preallocates reserveSize non zeros.

Precondition: the matrix must be in compressed mode.

Definition at line 262 of file SparseMatrix.h.

◆ reserveInnerVectors()

template<typename _Scalar , int _Options, typename _StorageIndex >

template<class SizesType >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::reserveInnerVectors ( const SizesType & reserveSizes )

inlineprotected

Definition at line 297 of file SparseMatrix.h.

◆ resize()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::resize	(	Index	rows,
		Index	cols
	)

inline

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

This function does not free the currently allocated memory. To release as much as memory as possible, call

mat.data().squeeze();

after resizing it.

See also: reserve(), setZero()

Definition at line 621 of file SparseMatrix.h.

◆ resizeNonZeros()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::resizeNonZeros ( Index size )

inline

Definition at line 644 of file SparseMatrix.h.

◆ rows()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::rows ( ) const

inline

Returns: the number of rows of the matrix

Definition at line 136 of file SparseMatrix.h.

◆ setFromTriplets() [1/2]

template<typename Scalar , int _Options, typename _StorageIndex >

template<typename InputIterators >

void Eigen::SparseMatrix< Scalar, _Options, _StorageIndex >::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 993 of file SparseMatrix.h.

◆ setFromTriplets() [2/2]

template<typename Scalar , int _Options, typename _StorageIndex >

template<typename InputIterators , typename DupFunctor >

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

The same as setFromTriplets but when duplicates are met the functor dup_func is applied:

value = dup_func(OldValue, NewValue)

Here is a C++11 example keeping the latest entry only:

mat.setFromTriplets(triplets.begin(), triplets.end(), [] (const Scalar&,const Scalar &b) { return b; });

Definition at line 1009 of file SparseMatrix.h.

◆ setIdentity()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::setIdentity ( )

inline

Sets *this to the identity matrix. This function also turns the matrix into compressed mode, and drop any reserved memory.

Definition at line 744 of file SparseMatrix.h.

◆ setZero()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::setZero ( )

inline

Removes all non zeros but keep allocated memory

This function does not free the currently allocated memory. To release as much as memory as possible, call

mat.data().squeeze();

after resizing it.

See also: resize(Index,Index), data()

Definition at line 251 of file SparseMatrix.h.

◆ startVec()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::startVec ( Index outer )

inline

Definition at line 412 of file SparseMatrix.h.

◆ sum()

template<typename _Scalar , int _Options, typename _Index >

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

Overloaded for performance

Definition at line 30 of file SparseRedux.h.

◆ sumupDuplicates()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::sumupDuplicates ( )

inline

Definition at line 448 of file SparseMatrix.h.

◆ swap()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::swap ( SparseMatrix< _Scalar, _Options, _StorageIndex > & 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 732 of file SparseMatrix.h.

◆ uncompress()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::uncompress ( )

inline

Turns the matrix into the uncompressed mode

Definition at line 495 of file SparseMatrix.h.

◆ valuePtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 152 of file SparseMatrix.h.

◆ valuePtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const Scalar* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::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 148 of file SparseMatrix.h.

Friends And Related Function Documentation

◆ operator<<

template<typename _Scalar , int _Options, typename _StorageIndex >

std::ostream& operator<<	(	std::ostream &	s,
		const SparseMatrix< _Scalar, _Options, _StorageIndex > &	m
	)

friend

Definition at line 788 of file SparseMatrix.h.

◆ SparseVector< _Scalar, 0, _StorageIndex >

template<typename _Scalar , int _Options, typename _StorageIndex >

friend class SparseVector< _Scalar, 0, _StorageIndex >

friend

Definition at line 101 of file SparseMatrix.h.

Member Data Documentation

◆ m_data

template<typename _Scalar , int _Options, typename _StorageIndex >

Storage Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_data

protected

Definition at line 131 of file SparseMatrix.h.

◆ m_innerNonZeros

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_innerNonZeros

protected

Definition at line 130 of file SparseMatrix.h.

◆ m_innerSize

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_innerSize

protected

Definition at line 128 of file SparseMatrix.h.

◆ m_outerIndex

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_outerIndex

protected

Definition at line 129 of file SparseMatrix.h.

◆ m_outerSize

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_outerSize

protected

Definition at line 127 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

Private Types

Static Private Member Functions

Friends

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ ConstDiagonalReturnType

◆ DiagonalReturnType

◆ IndexVector

◆ InnerIterator

◆ Map

◆ ReverseInnerIterator

◆ ScalarVector

◆ Storage

◆ TransposedSparseMatrix

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SparseMatrix() [1/7]

◆ SparseMatrix() [2/7]

◆ SparseMatrix() [3/7]

◆ SparseMatrix() [4/7]

◆ SparseMatrix() [5/7]

◆ SparseMatrix() [6/7]

◆ SparseMatrix() [7/7]

◆ ~SparseMatrix()

Member Function Documentation

◆ check_template_parameters()

◆ coeff()

◆ coeffRef()

◆ collapseDuplicates()

◆ cols()

◆ conservativeResize()

◆ data() [1/2]

◆ data() [2/2]

◆ diagonal() [1/2]

◆ diagonal() [2/2]

◆ finalize()

◆ initAssignment()

◆ innerIndexPtr() [1/2]

◆ innerIndexPtr() [2/2]

◆ innerNonZeroPtr() [1/2]

◆ innerNonZeroPtr() [2/2]

◆ innerSize()

◆ insert()

◆ insertBack()

◆ insertBackByOuterInner()

◆ insertBackByOuterInnerUnordered()

◆ insertBackUncompressed()

◆ insertByOuterInner()

◆ insertCompressed()

◆ insertUncompressed()

◆ isCompressed()

◆ makeCompressed()

◆ nonZeros()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ outerIndexPtr() [1/2]

◆ outerIndexPtr() [2/2]

◆ outerSize()

◆ prune() [1/2]

◆ prune() [2/2]

◆ reserve() [1/2]

◆ reserve() [2/2]

◆ reserveInnerVectors()

◆ resize()

◆ resizeNonZeros()

◆ rows()

◆ setFromTriplets() [1/2]

◆ setFromTriplets() [2/2]

◆ setIdentity()

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