Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Static Private Member Functions | Friends | List of all members
Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex > Class Template Reference

A versatible sparse matrix representation. More...

#include <SparseMatrix.h>

Inheritance diagram for Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >:
Inheritance graph
[legend]

Classes

struct  default_prunning_func
 
class  SingletonVector
 

Public Types

enum  { Options = _Options }
 
typedef Diagonal< const SparseMatrixConstDiagonalReturnType
 
typedef Diagonal< SparseMatrixDiagonalReturnType
 
typedef Base::IndexVector IndexVector
 
typedef Base::InnerIterator InnerIterator
 
typedef MappedSparseMatrix< Scalar, FlagsMap
 
typedef Base::ReverseInnerIterator ReverseInnerIterator
 
typedef Base::ScalarVector ScalarVector
 
typedef internal::CompressedStorage< Scalar, StorageIndexStorage
 
- Public Types inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
typedef SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > > Base
 
- Public Types inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
enum  
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const SparseMatrix< _Scalar, _Options, _StorageIndex > > >, Transpose< const SparseMatrix< _Scalar, _Options, _StorageIndex > > >::type AdjointReturnType
 
typedef EigenBase< SparseMatrix< _Scalar, _Options, _StorageIndex > > Base
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex > > BlockXpr
 
typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type CoeffReturnType
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, Dynamic,!IsRowMajorColsBlockXpr
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, 1,!IsRowMajorColXpr
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > >, const SparseMatrix< _Scalar, _Options, _StorageIndex > & >::type ConjugateReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef const Block< const SparseMatrix< _Scalar, _Options, _StorageIndex > > ConstBlockXpr
 
typedef const Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, Dynamic,!IsRowMajorConstColsBlockXpr
 
typedef const Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, 1,!IsRowMajorConstColXpr
 
typedef Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > ConstInnerVectorReturnType
 
typedef Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, Dynamic, Dynamic, true > ConstInnerVectorsReturnType
 
typedef const Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, Dynamic, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorConstRowsBlockXpr
 
typedef const Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, 1, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorConstRowXpr
 
typedef const VectorBlock< const SparseMatrix< _Scalar, _Options, _StorageIndex > > ConstSegmentReturnType
 
typedef internal::add_const< Transpose< const SparseMatrix< _Scalar, _Options, _StorageIndex > > >::type ConstTransposeReturnType
 
typedef CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > CwiseAbs2ReturnType
 
typedef CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > CwiseAbsReturnType
 
typedef CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > CwiseInverseReturnType
 
typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, Scalar, internal::cmp_EQ >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const ConstantReturnTypeCwiseScalarEqualReturnType
 
typedef CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > CwiseSignReturnType
 
typedef CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > CwiseSqrtReturnType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > ImagReturnType
 
typedef Matrix< StorageIndex, Dynamic, 1 > IndexVector
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, Dynamic, Dynamic, true > InnerVectorsReturnType
 
typedef CwiseUnaryOp< internal::scalar_opposite_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > > NegativeReturnType
 
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, SparseMatrix< _Scalar, _Options, _StorageIndex > > NonConstImagReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, SparseMatrix< _Scalar, _Options, _StorageIndex > >, SparseMatrix< _Scalar, _Options, _StorageIndex > & >::type NonConstRealReturnType
 
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit?RowMajor:ColMajor, StorageIndexPlainObject
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex > >, const SparseMatrix< _Scalar, _Options, _StorageIndex > & >::type RealReturnType
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, Dynamic, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorRowsBlockXpr
 
typedef Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, 1, internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorRowXpr
 
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::Scalar Scalar
 
typedef Matrix< Scalar, Dynamic, 1 > ScalarVector
 
typedef VectorBlock< SparseMatrix< _Scalar, _Options, _StorageIndex > > SegmentReturnType
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::StorageIndex StorageIndex
 
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::StorageKind StorageKind
 
typedef Transpose< SparseMatrix< _Scalar, _Options, _StorageIndex > > TransposeReturnType
 
typedef Scalar value_type
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

Scalar coeff (Index row, Index col) const
 
ScalarcoeffRef (Index row, Index col)
 
template<typename DupFunctor >
void collapseDuplicates (DupFunctor dup_func=DupFunctor())
 
Index cols () const
 
void conservativeResize (Index rows, Index cols)
 
Storagedata ()
 
const Storagedata () const
 
const ConstDiagonalReturnType diagonal () const
 
DiagonalReturnType diagonal ()
 
void finalize ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
Index innerSize () const
 
Scalarinsert (Index row, Index col)
 
ScalarinsertBack (Index row, Index col)
 
ScalarinsertBackByOuterInner (Index outer, Index inner)
 
ScalarinsertBackByOuterInnerUnordered (Index outer, Index inner)
 
EIGEN_STRONG_INLINE ScalarinsertBackUncompressed (Index row, Index col)
 
ScalarinsertByOuterInner (Index j, Index i)
 
void makeCompressed ()
 
SparseMatrixoperator= (const SparseMatrix &other)
 
template<typename OtherDerived >
SparseMatrixoperator= (const EigenBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrixoperator= (const SparseMatrixBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix< Scalar, _Options, _StorageIndex > & operator= (const SparseMatrixBase< OtherDerived > &other)
 
const StorageIndexouterIndexPtr () const
 
StorageIndexouterIndexPtr ()
 
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())
 
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 ()
 
 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. More...
 
template<typename OtherDerived >
 SparseMatrix (const DiagonalBase< OtherDerived > &other)
 Copy constructor with in-place evaluation. More...
 
void startVec (Index outer)
 
Scalar sum () const
 
void sumupDuplicates ()
 
void swap (SparseMatrix &other)
 
void uncompress ()
 
const ScalarvaluePtr () const
 
ScalarvaluePtr ()
 
 ~SparseMatrix ()
 
- Public Member Functions inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
const Map< const Array< Scalar, Dynamic, 1 > > coeffs () const
 
Map< Array< Scalar, Dynamic, 1 > > coeffs ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
bool isCompressed () const
 
Index nonZeros () const
 
const StorageIndexouterIndexPtr () const
 
StorageIndexouterIndexPtr ()
 
const ScalarvaluePtr () const
 
ScalarvaluePtr ()
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
const AdjointReturnType adjoint () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
EIGEN_DEVICE_FUNC const ConstBlockXpr block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 This is the const version of block(Index,Index,Index,Index). */. More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol)
 
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol) const
 This is the const version of block<>(Index, Index). */. More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
const ConstFixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 This is the const version of block<>(Index, Index, Index, Index). More...
 
RealScalar blueNorm () const
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr bottomLeftCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC const ConstBlockXpr bottomLeftCorner (Index cRows, Index cCols) const
 This is the const version of bottomLeftCorner(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner ()
 
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type bottomLeftCorner () const
 This is the const version of bottomLeftCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner (Index cRows, Index cCols)
 
const ConstFixedBlockXpr< CRows, CCols >::Type bottomLeftCorner (Index cRows, Index cCols) const
 This is the const version of bottomLeftCorner<int, int>(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr bottomRightCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC const ConstBlockXpr bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type bottomRightCorner ()
 
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type bottomRightCorner () const
 This is the const version of bottomRightCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type bottomRightCorner (Index cRows, Index cCols)
 
const ConstFixedBlockXpr< CRows, CCols >::Type bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner<int, int>(Index, Index). More...
 
EIGEN_DEVICE_FUNC RowsBlockXpr bottomRows (Index n)
 
EIGEN_DEVICE_FUNC ConstRowsBlockXpr bottomRows (Index n) const
 This is the const version of bottomRows(Index). More...
 
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type bottomRows (Index n=N)
 
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type bottomRows (Index n=N) const
 This is the const version of bottomRows<int>(). More...
 
EIGEN_DEVICE_FUNC CastXpr< NewType >::Type cast () const
 
EIGEN_DEVICE_FUNC ColXpr col (Index i)
 
EIGEN_DEVICE_FUNC ConstColXpr col (Index i) const
 This is the const version of col(). More...
 
Index cols () const
 
EIGEN_DEVICE_FUNC ConjugateReturnType conjugate () const
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & const_cast_derived () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType cwiseAbs () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType cwiseAbs2 () const
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< std::equal_to< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType cwiseEqual (const Scalar &s) const
 
EIGEN_DEVICE_FUNC const CwiseInverseReturnType cwiseInverse () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const ConstantReturnTypecwiseMax (const Scalar &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const ConstantReturnTypecwiseMin (const Scalar &other) const
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< std::not_equal_to< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const CwiseSignReturnType cwiseSign () const
 
EIGEN_DEVICE_FUNC const CwiseSqrtReturnType cwiseSqrt () const
 
const SparseMatrix< _Scalar, _Options, _StorageIndex > & derived () const
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & derived ()
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const EIGEN_CWISE_BINARY_RETURN_TYPE (SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived, product) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const internal::eval< SparseMatrix< _Scalar, _Options, _StorageIndex > >::type eval () const
 
EIGEN_DEVICE_FUNC SegmentReturnType head (Index n)
 
EIGEN_DEVICE_FUNC ConstSegmentReturnType head (Index n) const
 This is the const version of head(Index). More...
 
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type head (Index n=N)
 
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type head (Index n=N) const
 This is the const version of head<int>(). More...
 
EIGEN_DEVICE_FUNC const ImagReturnType imag () const
 
EIGEN_DEVICE_FUNC NonConstImagReturnType imag ()
 
Index innerSize () 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
 
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
 
bool isRValue () const
 
bool isVector () const
 
EIGEN_DEVICE_FUNC ColsBlockXpr leftCols (Index n)
 
EIGEN_DEVICE_FUNC ConstColsBlockXpr leftCols (Index n) const
 This is the const version of leftCols(Index). More...
 
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type leftCols (Index n=N)
 
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type leftCols (Index n=N) const
 This is the const version of leftCols<int>(). More...
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & markAsRValue ()
 
EIGEN_DEVICE_FUNC ColsBlockXpr middleCols (Index startCol, Index numCols)
 
EIGEN_DEVICE_FUNC ConstColsBlockXpr middleCols (Index startCol, Index numCols) const
 This is the const version of middleCols(Index,Index). More...
 
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type middleCols (Index startCol, Index n=N)
 
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type middleCols (Index startCol, Index n=N) const
 This is the const version of middleCols<int>(). More...
 
EIGEN_DEVICE_FUNC RowsBlockXpr middleRows (Index startRow, Index n)
 
EIGEN_DEVICE_FUNC ConstRowsBlockXpr middleRows (Index startRow, Index n) const
 This is the const version of middleRows(Index,Index). More...
 
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type middleRows (Index startRow, Index n=N)
 
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type middleRows (Index startRow, Index n=N) const
 This is the const version of middleRows<int>(). More...
 
RealScalar norm () const
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_and_op, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator&& (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const Product< SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const Product< SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
const Product< SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator*= (const Scalar &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator+= (const DiagonalBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator+= (const EigenBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC const NegativeReturnType operator- () const
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator-= (const DiagonalBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator-= (const EigenBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator/= (const Scalar &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator= (const EigenBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator= (const ReturnByValue< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator= (const SparseMatrixBase< OtherDerived > &other)
 
SparseMatrix< _Scalar, _Options, _StorageIndex > & operator= (const SparseMatrix< _Scalar, _Options, _StorageIndex > &other)
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_or_op, const SparseMatrix< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator|| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
Index outerSize () const
 
const SparseView< SparseMatrix< _Scalar, _Options, _StorageIndex > > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC RealReturnType real () const
 
EIGEN_DEVICE_FUNC NonConstRealReturnType real ()
 
EIGEN_DEVICE_FUNC ColsBlockXpr rightCols (Index n)
 
EIGEN_DEVICE_FUNC ConstColsBlockXpr rightCols (Index n) const
 This is the const version of rightCols(Index). More...
 
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type rightCols (Index n=N)
 
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type rightCols (Index n=N) const
 This is the const version of rightCols<int>(). More...
 
EIGEN_DEVICE_FUNC RowXpr row (Index i)
 
EIGEN_DEVICE_FUNC ConstRowXpr row (Index i) const
 This is the const version of row(). */. More...
 
Index rows () const
 
EIGEN_DEVICE_FUNC SegmentReturnType segment (Index start, Index n)
 
EIGEN_DEVICE_FUNC ConstSegmentReturnType segment (Index start, Index n) const
 This is the const version of segment(Index,Index). More...
 
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type segment (Index start, Index n=N)
 
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type segment (Index start, Index n=N) const
 This is the const version of segment<int>(Index). More...
 
ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
Index size () const
 
 SparseMatrixBase ()
 
RealScalar squaredNorm () const
 
Scalar sum () const
 
EIGEN_DEVICE_FUNC SegmentReturnType tail (Index n)
 
EIGEN_DEVICE_FUNC ConstSegmentReturnType tail (Index n) const
 This is the const version of tail(Index). More...
 
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type tail (Index n=N)
 
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type tail (Index n=N) const
 This is the const version of tail<int>. More...
 
DenseMatrixType toDense () const
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr topLeftCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC const ConstBlockXpr topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type topLeftCorner ()
 
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type topLeftCorner () const
 This is the const version of topLeftCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type topLeftCorner (Index cRows, Index cCols)
 
const ConstFixedBlockXpr< CRows, CCols >::Type topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner<int, int>(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr topRightCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC const ConstBlockXpr topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type topRightCorner ()
 
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type topRightCorner () const
 This is the const version of topRightCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type topRightCorner (Index cRows, Index cCols)
 
const ConstFixedBlockXpr< CRows, CCols >::Type topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner<int, int>(Index, Index). More...
 
EIGEN_DEVICE_FUNC RowsBlockXpr topRows (Index n)
 
EIGEN_DEVICE_FUNC ConstRowsBlockXpr topRows (Index n) const
 This is the const version of topRows(Index). More...
 
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type topRows (Index n=N)
 
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type topRows (Index n=N) const
 This is the const version of topRows<int>(). More...
 
TransposeReturnType transpose ()
 
const ConstTransposeReturnType transpose () const
 
const TriangularView< const SparseMatrix< _Scalar, _Options, _StorageIndex >, Mode > triangularView () const
 
SparseSymmetricPermutationProduct< SparseMatrix< _Scalar, _Options, _StorageIndex >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
EIGEN_DEVICE_FUNC const CwiseUnaryOp< CustomUnaryOp, const SparseMatrix< _Scalar, _Options, _StorageIndex > > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
EIGEN_DEVICE_FUNC const CwiseUnaryView< CustomViewOp, const SparseMatrix< _Scalar, _Options, _StorageIndex > > unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & const_derived () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC Index rows () const
 
EIGEN_DEVICE_FUNC Index size () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void subTo (Dest &dst) 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 ScalarinsertCompressed (Index row, Index col)
 
EIGEN_DONT_INLINE ScalarinsertUncompressed (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< IndexVectorinnerNonZeros ()
 
const Eigen::Map< const IndexVectorinnerNonZeros () const
 
 SparseCompressedBase ()
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
SparseMatrix< _Scalar, _Options, _StorageIndex > & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 

Protected Attributes

Storage m_data
 
StorageIndexm_innerNonZeros
 
Index m_innerSize
 
StorageIndexm_outerIndex
 
Index m_outerSize
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
bool m_isRValue
 

Private Types

typedef SparseCompressedBase< SparseMatrixBase
 

Static Private Member Functions

static void check_template_parameters ()
 

Friends

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

Additional Inherited Members

- Static Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
static StorageIndex convert_index (const Index idx)
 

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
_Scalarthe scalar type, i.e. the type of the coefficients
_OptionsUnion of bit flags controlling the storage scheme. Currently the only possibility is ColMajor or RowMajor. The default is 0 which means column-major.
_StorageIndexthe 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 Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_SPARSEMATRIX_PLUGIN.

Definition at line 96 of file SparseMatrix.h.

Member Typedef Documentation

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.

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.

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

Definition at line 110 of file SparseMatrix.h.

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

Definition at line 122 of file SparseMatrix.h.

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

Definition at line 112 of file SparseMatrix.h.

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.

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

Definition at line 113 of file SparseMatrix.h.

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

Definition at line 123 of file SparseMatrix.h.

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.

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

template<typename _Scalar, int _Options, typename _StorageIndex>
anonymous enum
Enumerator
Options 

Definition at line 118 of file SparseMatrix.h.

Constructor & Destructor Documentation

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

template<typename _Scalar, int _Options, typename _StorageIndex>
Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::cols ( void  ) const
inline
Returns
the number of columns of the matrix

Definition at line 138 of file SparseMatrix.h.

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.

template<typename _Scalar, int _Options, typename _StorageIndex>
Storage& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::data ( )
inline

Definition at line 182 of file SparseMatrix.h.

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.

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.

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.

template<typename _Scalar, int _Options, typename _StorageIndex>
void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::finalize ( )
inline

Definition at line 422 of file SparseMatrix.h.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

template<typename _Scalar, int _Options, typename _StorageIndex>
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix& Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator= ( const SparseMatrixBase< OtherDerived > &  other)
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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

template<typename _Scalar, int _Options, typename _StorageIndex>
Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::rows ( void  ) const
inline
Returns
the number of rows of the matrix

Definition at line 136 of file SparseMatrix.h.

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.

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.

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.

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.

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.

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

Overloaded for performance

Definition at line 30 of file SparseRedux.h.

template<typename _Scalar, int _Options, typename _StorageIndex>
void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::sumupDuplicates ( )
inline

Definition at line 448 of file SparseMatrix.h.

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.

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.

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.

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.

Friends And Related Function Documentation

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.

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

template<typename _Scalar, int _Options, typename _StorageIndex>
Storage Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_data
protected

Definition at line 131 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _StorageIndex>
StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_innerNonZeros
protected

Definition at line 130 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _StorageIndex>
Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_innerSize
protected

Definition at line 128 of file SparseMatrix.h.

template<typename _Scalar, int _Options, typename _StorageIndex>
StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_outerIndex
protected

Definition at line 129 of file SparseMatrix.h.

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:


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:54:51