A versatible sparse matrix representation. More...

#include <SparseMatrix.h>

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

Classes
class	InnerIterator

class	ReverseInnerIterator

class	SingletonVector

Public Types
enum	{ Options = _Options }

typedef MappedSparseMatrix< Scalar, Flags >	Map

typedef internal::CompressedStorage< Scalar, Index >	Storage

Public Types inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >
enum

typedef internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar	Scalar

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::StorageKind	StorageKind

typedef internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Index	Index

typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType

typedef SparseMatrixBase	StorageBaseType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const SparseMatrix< _Scalar, _Options, _Index > > >, Transpose< const SparseMatrix< _Scalar, _Options, _Index > > >::type	AdjointReturnType

typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, Index >	PlainObject

typedef NumTraits< Scalar >::Real	RealScalar
	This is the "real scalar" type; if the Scalar type is already real numbers (e.g. More...

typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type	CoeffReturnType

typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
	type of the equivalent square matrix

typedef internal::special_scalar_op_base< SparseMatrix< _Scalar, _Options, _Index >, Scalar, RealScalar, EigenBase< SparseMatrix< _Scalar, _Options, _Index > > >	Base

typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	ScalarMultipleReturnType

typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	ScalarQuotient1ReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >, const SparseMatrix< _Scalar, _Options, _Index > & >::type	ConjugateReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >, const SparseMatrix< _Scalar, _Options, _Index > & >::type	RealReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrix< _Scalar, _Options, _Index > & >::type	NonConstRealReturnType

typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	ImagReturnType

typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, SparseMatrix< _Scalar, _Options, _Index > >	NonConstImagReturnType

typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, internal::cmp_EQ >, const SparseMatrix< _Scalar, _Options, _Index >, const ConstantReturnType >	CwiseScalarEqualReturnType

typedef Block< SparseMatrix< _Scalar, _Options, _Index >, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1, !IsRowMajor >	ColXpr

typedef const Block< const SparseMatrix< _Scalar, _Options, _Index >, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1, !IsRowMajor >	ConstColXpr

typedef Block< SparseMatrix< _Scalar, _Options, _Index >, 1, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	RowXpr

typedef const Block< const SparseMatrix< _Scalar, _Options, _Index >, 1, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr

typedef Block< SparseMatrix< _Scalar, _Options, _Index >, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic, !IsRowMajor >	ColsBlockXpr

typedef const Block< const SparseMatrix< _Scalar, _Options, _Index >, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic, !IsRowMajor >	ConstColsBlockXpr

typedef Block< SparseMatrix< _Scalar, _Options, _Index >, Dynamic, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr

typedef const Block< const SparseMatrix< _Scalar, _Options, _Index >, Dynamic, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr

typedef VectorBlock< SparseMatrix< _Scalar, _Options, _Index > >	SegmentReturnType

typedef const VectorBlock< const SparseMatrix< _Scalar, _Options, _Index > >	ConstSegmentReturnType

typedef Block< SparseMatrix< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType

typedef Block< const SparseMatrix< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	ConstInnerVectorReturnType

typedef Block< SparseMatrix< _Scalar, _Options, _Index >, Dynamic, Dynamic, true >	InnerVectorsReturnType

typedef Block< const SparseMatrix< _Scalar, _Options, _Index >, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType

Public Types inherited from Eigen::EigenBase< SparseMatrix< _Scalar, _Options, _Index > >
typedef internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::StorageKind	StorageKind

typedef internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Index	Index

Public Member Functions
bool	isCompressed () const

Index	rows () const

Index	cols () const

Index	innerSize () const

Index	outerSize () const

const Scalar *	valuePtr () const

Scalar *	valuePtr ()

const Index *	innerIndexPtr () const

Index *	innerIndexPtr ()

const Index *	outerIndexPtr () const

Index *	outerIndexPtr ()

const Index *	innerNonZeroPtr () const

Index *	innerNonZeroPtr ()

Storage &	data ()

const Storage &	data () const

Scalar	coeff (Index row, Index col) const

Scalar &	coeffRef (Index row, Index col)

Scalar &	insert (Index row, Index col)

void	setZero ()
	Removes all non zeros but keep allocated memory.

Index	nonZeros () const

void	reserve (Index reserveSize)
	Preallocates reserveSize non zeros. More...

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())

Scalar &	insertBack (Index row, Index col)

Scalar &	insertBackByOuterInner (Index outer, Index inner)

Scalar &	insertBackByOuterInnerUnordered (Index outer, Index inner)

void	startVec (Index outer)

void	finalize ()

template<typename InputIterators >
void	setFromTriplets (const InputIterators &begin, const InputIterators &end)
	Fill the matrix `this` with the list of triplets* defined by the iterator range begin - end. More...

void	sumupDuplicates ()

Scalar &	insertByOuterInner (Index j, Index i)

void	makeCompressed ()
	Turns the matrix into the compressed format.

void	uncompress ()
	Turns the matrix into the uncompressed mode.

void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
	Suppresses all nonzeros which are much smaller than reference under the tolerence epsilon.

template<typename KeepFunc >
void	prune (const KeepFunc &keep=KeepFunc())
	Turns the matrix into compressed format, and suppresses all nonzeros which do not satisfy the predicate keep. More...

void	conservativeResize (Index rows, Index cols)
	Resizes the matrix to a rows x cols matrix leaving old values untouched. More...

void	resize (Index rows, Index cols)
	Resizes the matrix to a rows x cols matrix and initializes it to zero. More...

void	resizeNonZeros (Index size)

const Diagonal< const SparseMatrix >	diagonal () const

	SparseMatrix ()
	Default constructor yielding an empty `0` `x` `0` matrix.

	SparseMatrix (Index rows, Index cols)
	Constructs a rows `x` cols empty matrix.

template<typename OtherDerived >
	SparseMatrix (const SparseMatrixBase< OtherDerived > &other)
	Constructs a sparse matrix from the sparse expression other.

template<typename OtherDerived , unsigned int UpLo>
	SparseMatrix (const SparseSelfAdjointView< OtherDerived, UpLo > &other)
	Constructs a sparse matrix from the sparse selfadjoint view other.

	SparseMatrix (const SparseMatrix &other)
	Copy constructor (it performs a deep copy)

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

void	swap (SparseMatrix &other)
	Swaps the content of two sparse matrices of the same type. More...

void	setIdentity ()
	Sets *this to the identity matrix. More...

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)

	~SparseMatrix ()
	Destructor.

Scalar	sum () const
	Overloaded for performance.

EIGEN_STRONG_INLINE Scalar &	insertBackUncompressed (Index row, Index col)

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

Public Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >
SparseMatrix< _Scalar, _Options, _Index > &	operator= (const EigenBase< OtherDerived > &other)

SparseMatrix< _Scalar, _Options, _Index > &	operator= (const ReturnByValue< OtherDerived > &other)

SparseMatrix< _Scalar, _Options, _Index > &	operator= (const SparseMatrixBase< OtherDerived > &other)

SparseMatrix< _Scalar, _Options, _Index > &	operator= (const SparseMatrix< _Scalar, _Options, _Index > &other)

SparseMatrix< _Scalar, _Options, _Index > &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)

const SparseMatrix< _Scalar, _Options, _Index > &	derived () const

SparseMatrix< _Scalar, _Options, _Index > &	derived ()

SparseMatrix< _Scalar, _Options, _Index > &	const_cast_derived () const

const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	operator- () const

const ScalarMultipleReturnType	operator* (const Scalar &scalar) const

const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const SparseMatrix< _Scalar, _Options, _Index > >	operator* (const std::complex< Scalar > &scalar) const
	Overloaded for efficient real matrix times complex scalar value.

const SparseSparseProductReturnType< SparseMatrix< _Scalar, _Options, _Index >, OtherDerived >::Type	operator* (const SparseMatrixBase< OtherDerived > &other) const

const SparseDiagonalProduct< SparseMatrix< _Scalar, _Options, _Index >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const

const SparseDenseProductReturnType< SparseMatrix< _Scalar, _Options, _Index >, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const
	sparse * dense (returns a dense object unless it is an outer product)

const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	operator/ (const Scalar &scalar) const

internal::cast_return_type< SparseMatrix< _Scalar, _Options, _Index >, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar, NewType >, const SparseMatrix< _Scalar, _Options, _Index > > >::type	cast () const

ConjugateReturnType	conjugate () const

RealReturnType	real () const

NonConstRealReturnType	real ()

const ImagReturnType	imag () const

NonConstImagReturnType	imag ()

const CwiseUnaryOp< CustomUnaryOp, const SparseMatrix< _Scalar, _Options, _Index > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...

const CwiseUnaryView< CustomViewOp, const SparseMatrix< _Scalar, _Options, _Index > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseMatrix< _Scalar, _Options, _Index >, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	cwiseAbs () const

EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	cwiseAbs2 () const

const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	cwiseSqrt () const

const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index > >	cwiseInverse () const

EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (SparseMatrix< _Scalar, _Options, _Index >, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

const CwiseBinaryOp< std::equal_to< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

const CwiseBinaryOp< std::not_equal_to< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const ConstantReturnType >	cwiseMin (const Scalar &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const ConstantReturnType >	cwiseMax (const Scalar &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseMatrix< _Scalar, _Options, _Index >, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

Block< SparseMatrix< _Scalar, _Options, _Index > >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index > >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol)

const Block< const SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index > >	topRightCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index > >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner ()

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner () const
	This is the const version of topRightCorner<int, int>(). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index > >	topLeftCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index > >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner ()

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>(). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index > >	bottomRightCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index > >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner ()

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>(). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index > >	bottomLeftCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index > >	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner ()

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>(). More...

Block< SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols)

const Block< const SparseMatrix< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index). More...

RowsBlockXpr	topRows (Index n)

ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index). More...

NRowsBlockXpr< N >::Type	topRows (Index n=N)

ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>(). More...

RowsBlockXpr	bottomRows (Index n)

ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index). More...

NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>(). More...

RowsBlockXpr	middleRows (Index startRow, Index n)

ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
	This is the const version of middleRows(Index,Index). More...

NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>(). More...

ColsBlockXpr	leftCols (Index n)

ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index). More...

NColsBlockXpr< N >::Type	leftCols (Index n=N)

ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>(). More...

ColsBlockXpr	rightCols (Index n)

ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index). More...

NColsBlockXpr< N >::Type	rightCols (Index n=N)

ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>(). More...

ColsBlockXpr	middleCols (Index startCol, Index numCols)

ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index). More...

NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>(). More...

ColXpr	col (Index i)

ConstColXpr	col (Index i) const
	This is the const version of col(). More...

RowXpr	row (Index i)

ConstRowXpr	row (Index i) const
	This is the const version of row(). More...

SegmentReturnType	segment (Index start, Index n)

ConstSegmentReturnType	segment (Index start, Index n) const
	This is the const version of segment(Index,Index). More...

FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index). More...

SegmentReturnType	head (Index n)

ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index). More...

FixedSegmentReturnType< N >::Type	head (Index n=N)

ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>(). More...

SegmentReturnType	tail (Index n)

ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index). More...

FixedSegmentReturnType< N >::Type	tail (Index n=N)

ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>. More...

Index	rows () const

Index	cols () const

Index	size () const

Index	nonZeros () const

bool	isVector () const

Index	outerSize () const

Index	innerSize () const

bool	isRValue () const

SparseMatrix< _Scalar, _Options, _Index > &	markAsRValue ()

SparseMatrix< _Scalar, _Options, _Index > &	operator+= (const SparseMatrixBase< OtherDerived > &other)

EIGEN_STRONG_INLINE SparseMatrix< _Scalar, _Options, _Index > &	operator+= (const SparseMatrixBase< OtherDerived > &other)

SparseMatrix< _Scalar, _Options, _Index > &	operator-= (const SparseMatrixBase< OtherDerived > &other)

EIGEN_STRONG_INLINE SparseMatrix< _Scalar, _Options, _Index > &	operator-= (const SparseMatrixBase< OtherDerived > &other)

SparseMatrix< _Scalar, _Options, _Index > &	*operator=** (const Scalar &other)

SparseMatrix< _Scalar, _Options, _Index > &	*operator=** (const SparseMatrixBase< OtherDerived > &other)

SparseMatrix< _Scalar, _Options, _Index > &	operator/= (const Scalar &other)

EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

EIGEN_STRONG_INLINE const SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

SparseSymmetricPermutationProduct< SparseMatrix< _Scalar, _Options, _Index >, Upper\|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const

const SparseTriangularView< SparseMatrix< _Scalar, _Options, _Index >, Mode >	triangularView () const

const SparseSelfAdjointView< SparseMatrix< _Scalar, _Options, _Index >, UpLo >	selfadjointView () const

SparseSelfAdjointView< SparseMatrix< _Scalar, _Options, _Index >, UpLo >	selfadjointView ()

Scalar	dot (const MatrixBase< OtherDerived > &other) const

Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar	dot (const MatrixBase< OtherDerived > &other) const

internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

RealScalar	squaredNorm () const

RealScalar	norm () const

RealScalar	blueNorm () const

Transpose< SparseMatrix< _Scalar, _Options, _Index > >	transpose ()

const Transpose< const SparseMatrix< _Scalar, _Options, _Index > >	transpose () const

const AdjointReturnType	adjoint () const

InnerVectorReturnType	innerVector (Index outer)

const ConstInnerVectorReturnType	innerVector (Index outer) const

InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const

void	evalTo (MatrixBase< DenseDerived > &dst) const

Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () const

bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

const internal::eval< SparseMatrix< _Scalar, _Options, _Index > >::type	eval () const

Scalar	sum () const

Public Member Functions inherited from Eigen::internal::special_scalar_op_base< SparseMatrix< _Scalar, _Options, _Index >, internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar, NumTraits< internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar >::Real, EigenBase< SparseMatrix< _Scalar, _Options, _Index > > >
void	operator* () const

Public Member Functions inherited from Eigen::EigenBase< SparseMatrix< _Scalar, _Options, _Index > >
SparseMatrix< _Scalar, _Options, _Index > &	derived ()

const SparseMatrix< _Scalar, _Options, _Index > &	derived () const

SparseMatrix< _Scalar, _Options, _Index > &	const_cast_derived () const

const SparseMatrix< _Scalar, _Options, _Index > &	const_derived () const

Index	rows () const

Index	cols () const

Index	size () const

void	evalTo (Dest &dst) const

void	addTo (Dest &dst) const

void	subTo (Dest &dst) const

void	applyThisOnTheRight (Dest &dst) const

void	applyThisOnTheLeft (Dest &dst) const

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

Protected Member Functions
Eigen::Map< Matrix< Index, Dynamic, 1 > >	innerNonZeros ()

const Eigen::Map< const Matrix< Index, Dynamic, 1 > >	innerNonZeros () const

template<class SizesType >
void	reserveInnerVectors (const SizesType &reserveSizes)

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)

Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >
SparseMatrix< _Scalar, _Options, _Index > &	assign (const OtherDerived &other)

void	assignGeneric (const OtherDerived &other)

Protected Attributes
Index	m_outerSize

Index	m_innerSize

Index *	m_outerIndex

Index *	m_innerNonZeros

Storage	m_data

Protected Attributes inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >
bool	m_isRValue

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 Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_SPARSEMATRIX_PLUGIN.

Member Function Documentation

§ coeff()

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

§ coeffRef()

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.

§ cols()

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

§ conservativeResize()

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()

§ diagonal()

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

§ innerIndexPtr() [1/2]

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()

§ innerIndexPtr() [2/2]

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()

§ innerNonZeroPtr() [1/2]

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

§ innerNonZeroPtr() [2/2]

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

§ innerSize()

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)

§ insert()

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.

§ isCompressed()

template<typename _Scalar, int _Options, typename _Index>

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

inline

Returns: whether *this is in compressed form.

§ nonZeros()

template<typename _Scalar, int _Options, typename _Index>

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

inline

Returns: the number of non zero coefficients

§ outerIndexPtr() [1/2]

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()

§ outerIndexPtr() [2/2]

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()

§ outerSize()

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)

§ prune()

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)

§ reserve()

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.

§ resize()

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()

§ rows()

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

§ setFromTriplets()

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.

§ setIdentity()

template<typename _Scalar, int _Options, typename _Index>

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

inline

Sets *this to the identity matrix.

This function also turns the matrix into compressed mode, and drop any reserved memory.

§ swap()

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.

§ valuePtr() [1/2]

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()

§ valuePtr() [2/2]

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()

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

vendor/eigen/Eigen/src/SparseCore/SparseMatrix.h
vendor/eigen/Eigen/src/SparseCore/SparseRedux.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

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

Member Function Documentation

§ coeff()

§ coeffRef()

§ cols()

§ conservativeResize()

§ diagonal()

§ innerIndexPtr() [1/2]

§ innerIndexPtr() [2/2]

§ innerNonZeroPtr() [1/2]

§ innerNonZeroPtr() [2/2]

§ innerSize()

§ insert()

§ isCompressed()

§ nonZeros()

§ outerIndexPtr() [1/2]

§ outerIndexPtr() [2/2]

§ outerSize()

§ prune()

§ reserve()

§ resize()

§ rows()

§ setFromTriplets()

§ setIdentity()

§ swap()

§ valuePtr() [1/2]

§ valuePtr() [2/2]

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