OSVR-Core
Classes | Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index > Class Template Reference

A sparse matrix class designed for matrix assembly purpose. More...

#include <DynamicSparseMatrix.h>

Inheritance diagram for Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >:
Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > > Eigen::internal::special_scalar_op_base< DynamicSparseMatrix< _Scalar, _Options, _Index >, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar, NumTraits< internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar >::Real, EigenBase< DynamicSparseMatrix< _Scalar, _Options, _Index > > > Eigen::EigenBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >

Classes

class  InnerIterator
 
class  ReverseInnerIterator
 

Public Types

enum  { Options = _Options }
 
typedef MappedSparseMatrix< Scalar, FlagsMap
 
- Public Types inherited from Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >
enum  
 
typedef internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar Scalar
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::StorageKind StorageKind
 
typedef internal::traits< DynamicSparseMatrix< _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 DynamicSparseMatrix< _Scalar, _Options, _Index > > >, Transpose< const DynamicSparseMatrix< _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< DynamicSparseMatrix< _Scalar, _Options, _Index >, Scalar, RealScalar, EigenBase< DynamicSparseMatrix< _Scalar, _Options, _Index > > > Base
 
typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > ScalarMultipleReturnType
 
typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > ScalarQuotient1ReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > >, const DynamicSparseMatrix< _Scalar, _Options, _Index > & >::type ConjugateReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > >, const DynamicSparseMatrix< _Scalar, _Options, _Index > & >::type RealReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, DynamicSparseMatrix< _Scalar, _Options, _Index > >, DynamicSparseMatrix< _Scalar, _Options, _Index > & >::type NonConstRealReturnType
 
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > ImagReturnType
 
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, DynamicSparseMatrix< _Scalar, _Options, _Index > > NonConstImagReturnType
 
typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, internal::cmp_EQ >, const DynamicSparseMatrix< _Scalar, _Options, _Index >, const ConstantReturnTypeCwiseScalarEqualReturnType
 
typedef Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1, !IsRowMajor > ColXpr
 
typedef const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1, !IsRowMajor > ConstColXpr
 
typedef Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, 1, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor > RowXpr
 
typedef const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, 1, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor > ConstRowXpr
 
typedef Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic, !IsRowMajor > ColsBlockXpr
 
typedef const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic, !IsRowMajor > ConstColsBlockXpr
 
typedef Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, Dynamic, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor > RowsBlockXpr
 
typedef const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, Dynamic, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor > ConstRowsBlockXpr
 
typedef VectorBlock< DynamicSparseMatrix< _Scalar, _Options, _Index > > SegmentReturnType
 
typedef const VectorBlock< const DynamicSparseMatrix< _Scalar, _Options, _Index > > ConstSegmentReturnType
 
typedef Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType
 
typedef Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > ConstInnerVectorReturnType
 
typedef Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, Dynamic, Dynamic, true > InnerVectorsReturnType
 
typedef Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, Dynamic, Dynamic, true > ConstInnerVectorsReturnType
 
- Public Types inherited from Eigen::EigenBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >
typedef internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::StorageKind StorageKind
 
typedef internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Index Index
 

Public Member Functions

Index rows () const
 
Index cols () const
 
Index innerSize () const
 
Index outerSize () const
 
Index innerNonZeros (Index j) const
 
std::vector< internal::CompressedStorage< Scalar, Index > > & _data ()
 
const std::vector< internal::CompressedStorage< Scalar, Index > > & _data () const
 
Scalar coeff (Index row, Index col) const
 
Scalar & coeffRef (Index row, Index col)
 
void setZero ()
 
Index nonZeros () const
 
void reserve (Index reserveSize=1000)
 
void startVec (Index)
 Does nothing: provided for compatibility with SparseMatrix.
 
Scalar & insertBack (Index row, Index col)
 
Scalar & insertBackByOuterInner (Index outer, Index inner)
 
Scalar & insert (Index row, Index col)
 
void finalize ()
 Does nothing: provided for compatibility with SparseMatrix.
 
void prune (Scalar reference, RealScalar epsilon=NumTraits< RealScalar >::dummy_precision())
 Suppress all nonzeros which are smaller than reference under the tolerence epsilon.
 
void resize (Index rows, Index cols)
 Resize the matrix without preserving the data (the matrix is set to zero)
 
void resizeAndKeepData (Index rows, Index cols)
 
EIGEN_DEPRECATED DynamicSparseMatrix ()
 The class DynamicSparseMatrix is deprectaed.
 
EIGEN_DEPRECATED DynamicSparseMatrix (Index rows, Index cols)
 The class DynamicSparseMatrix is deprectaed.
 
template<typename OtherDerived >
EIGEN_DEPRECATED DynamicSparseMatrix (const SparseMatrixBase< OtherDerived > &other)
 The class DynamicSparseMatrix is deprectaed.
 
 DynamicSparseMatrix (const DynamicSparseMatrix &other)
 
void swap (DynamicSparseMatrix &other)
 
DynamicSparseMatrixoperator= (const DynamicSparseMatrix &other)
 
 ~DynamicSparseMatrix ()
 Destructor.
 
EIGEN_DEPRECATED void startFill (Index reserveSize=1000)
 
EIGEN_DEPRECATED Scalar & fill (Index row, Index col)
 
EIGEN_DEPRECATED Scalar & fillrand (Index row, Index col)
 
EIGEN_DEPRECATED void endFill ()
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator= (const EigenBase< OtherDerived > &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator= (const ReturnByValue< OtherDerived > &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator= (const SparseMatrixBase< OtherDerived > &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator= (const DynamicSparseMatrix< _Scalar, _Options, _Index > &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator= (const SparseSparseProduct< Lhs, Rhs > &product)
 
const DynamicSparseMatrix< _Scalar, _Options, _Index > & derived () const
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & derived ()
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & const_cast_derived () const
 
const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > operator- () const
 
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
 
const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > operator* (const std::complex< Scalar > &scalar) const
 Overloaded for efficient real matrix times complex scalar value.
 
const SparseSparseProductReturnType< DynamicSparseMatrix< _Scalar, _Options, _Index >, OtherDerived >::Type operator* (const SparseMatrixBase< OtherDerived > &other) const
 
const SparseDiagonalProduct< DynamicSparseMatrix< _Scalar, _Options, _Index >, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const SparseDenseProductReturnType< DynamicSparseMatrix< _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< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > operator/ (const Scalar &scalar) const
 
internal::cast_return_type< DynamicSparseMatrix< _Scalar, _Options, _Index >, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar, NewType >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > >::type cast () const
 
ConjugateReturnType conjugate () const
 
RealReturnType real () const
 
NonConstRealReturnType real ()
 
const ImagReturnType imag () const
 
NonConstImagReturnType imag ()
 
const CwiseUnaryOp< CustomUnaryOp, const DynamicSparseMatrix< _Scalar, _Options, _Index > > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
const CwiseUnaryView< CustomViewOp, const DynamicSparseMatrix< _Scalar, _Options, _Index > > unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const DynamicSparseMatrix< _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 DynamicSparseMatrix< _Scalar, _Options, _Index > > cwiseAbs () const
 
EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > cwiseAbs2 () const
 
const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > cwiseSqrt () const
 
const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index > > cwiseInverse () const
 
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (DynamicSparseMatrix< _Scalar, _Options, _Index >, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const CwiseBinaryOp< std::equal_to< Scalar >, const DynamicSparseMatrix< _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 DynamicSparseMatrix< _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 DynamicSparseMatrix< _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 DynamicSparseMatrix< _Scalar, _Options, _Index >, const ConstantReturnTypecwiseMin (const Scalar &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const DynamicSparseMatrix< _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 DynamicSparseMatrix< _Scalar, _Options, _Index >, const ConstantReturnTypecwiseMax (const Scalar &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const DynamicSparseMatrix< _Scalar, _Options, _Index >, const OtherDerived > cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index > > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
const Block< const DynamicSparseMatrix< _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< DynamicSparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols > block (Index startRow, Index startCol)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols > block (Index startRow, Index startCol) const
 This is the const version of block<>(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
const Block< const DynamicSparseMatrix< _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< DynamicSparseMatrix< _Scalar, _Options, _Index > > topRightCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index > > topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topRightCorner ()
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topRightCorner () const
 This is the const version of topRightCorner<int, int>(). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topRightCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner<int, int>(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index > > topLeftCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index > > topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topLeftCorner ()
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topLeftCorner () const
 This is the const version of topLeftCorner<int, int>(). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topLeftCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner<int, int>(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index > > bottomRightCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index > > bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomRightCorner ()
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomRightCorner () const
 This is the const version of bottomRightCorner<int, int>(). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomRightCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner<int, int>(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index > > bottomLeftCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index > > bottomLeftCorner (Index cRows, Index cCols) const
 This is the const version of bottomLeftCorner(Index, Index). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomLeftCorner ()
 
const Block< const DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomLeftCorner () const
 This is the const version of bottomLeftCorner<int, int>(). More...
 
Block< DynamicSparseMatrix< _Scalar, _Options, _Index >, CRows, CCols > bottomLeftCorner (Index cRows, Index cCols)
 
const Block< const DynamicSparseMatrix< _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
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & markAsRValue ()
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE DynamicSparseMatrix< _Scalar, _Options, _Index > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE DynamicSparseMatrix< _Scalar, _Options, _Index > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator*= (const Scalar &other)
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
DynamicSparseMatrix< _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< DynamicSparseMatrix< _Scalar, _Options, _Index > >::template CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
SparseSymmetricPermutationProduct< DynamicSparseMatrix< _Scalar, _Options, _Index >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const
 
const SparseTriangularView< DynamicSparseMatrix< _Scalar, _Options, _Index >, Mode > triangularView () const
 
const SparseSelfAdjointView< DynamicSparseMatrix< _Scalar, _Options, _Index >, UpLo > selfadjointView () const
 
SparseSelfAdjointView< DynamicSparseMatrix< _Scalar, _Options, _Index >, UpLo > selfadjointView ()
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar dot (const MatrixBase< OtherDerived > &other) const
 
internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
RealScalar squaredNorm () const
 
RealScalar norm () const
 
RealScalar blueNorm () const
 
Transpose< DynamicSparseMatrix< _Scalar, _Options, _Index > > transpose ()
 
const Transpose< const DynamicSparseMatrix< _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, ColsAtCompileTimetoDense () 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< DynamicSparseMatrix< _Scalar, _Options, _Index > >::type eval () const
 
Scalar sum () const
 
- Public Member Functions inherited from Eigen::internal::special_scalar_op_base< DynamicSparseMatrix< _Scalar, _Options, _Index >, internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar, NumTraits< internal::traits< DynamicSparseMatrix< _Scalar, _Options, _Index > >::Scalar >::Real, EigenBase< DynamicSparseMatrix< _Scalar, _Options, _Index > > >
void operator* () const
 
- Public Member Functions inherited from Eigen::EigenBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >
DynamicSparseMatrix< _Scalar, _Options, _Index > & derived ()
 
const DynamicSparseMatrix< _Scalar, _Options, _Index > & derived () const
 
DynamicSparseMatrix< _Scalar, _Options, _Index > & const_cast_derived () const
 
const DynamicSparseMatrix< _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 DynamicSparseMatrix< Scalar,(Flags &~RowMajorBit)|(IsRowMajor?RowMajorBit:0)> TransposedSparseMatrix
 

Protected Attributes

Index m_innerSize
 
std::vector< internal::CompressedStorage< Scalar, Index > > m_data
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >
bool m_isRValue
 

Additional Inherited Members

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

Detailed Description

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

A sparse matrix class designed for matrix assembly purpose.

Deprecated:
use a SparseMatrix in an uncompressed mode
Parameters
_Scalarthe scalar type, i.e. the type of the coefficients

Unlike SparseMatrix, this class provides a much higher degree of flexibility. In particular, it allows random read/write accesses in log(rho*outer_size) where rho is the probability that a coefficient is nonzero and outer_size is the number of columns if the matrix is column-major and the number of rows otherwise.

Internally, the data are stored as a std::vector of compressed vector. The performances of random writes might decrease as the number of nonzeros per inner-vector increase. In practice, we observed very good performance till about 100 nonzeros/vector, and the performance remains relatively good till 500 nonzeros/vectors.

See also
SparseMatrix

Member Function Documentation

§ coeff()

template<typename _Scalar, int _Options, typename _Index>
Scalar Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::coeff ( Index  row,
Index  col 
) const
inline
Returns
the coefficient value at given position row, col This operation involes a log(rho*outer_size) binary search.

§ coeffRef()

template<typename _Scalar, int _Options, typename _Index>
Scalar& Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::coeffRef ( Index  row,
Index  col 
)
inline
Returns
a reference to the coefficient value at given position row, col This operation involes a log(rho*outer_size) binary search. If the coefficient does not exist yet, then a sorted insertion into a sequential buffer is performed.

§ endFill()

template<typename _Scalar, int _Options, typename _Index>
EIGEN_DEPRECATED void Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::endFill ( )
inline
Deprecated:
use finalize() Does nothing.

Provided for compatibility with SparseMatrix.

§ fill()

template<typename _Scalar, int _Options, typename _Index>
EIGEN_DEPRECATED Scalar& Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::fill ( Index  row,
Index  col 
)
inline
Deprecated:
use insert() inserts a nonzero coefficient at given coordinates row, col and returns its reference assuming that: 1 - the coefficient does not exist yet 2 - this the coefficient with greater inner coordinate for the given outer coordinate.

In other words, assuming *this is column-major, then there must not exists any nonzero coefficient of coordinates i x col such that i >= row. Otherwise the matrix is invalid.

See also
fillrand(), coeffRef()

§ fillrand()

template<typename _Scalar, int _Options, typename _Index>
EIGEN_DEPRECATED Scalar& Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::fillrand ( Index  row,
Index  col 
)
inline
Deprecated:
use insert() Like fill() but with random inner coordinates.

Compared to the generic coeffRef(), the unique limitation is that we assume the coefficient does not exist yet.

§ insertBack()

template<typename _Scalar, int _Options, typename _Index>
Scalar& Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::insertBack ( Index  row,
Index  col 
)
inline
Returns
a reference to the non zero coefficient at position row, col assuming that:
  • the nonzero does not already exist
  • the new coefficient is the last one of the given inner vector.
See also
insert, insertBackByOuterInner

§ insertBackByOuterInner()

template<typename _Scalar, int _Options, typename _Index>
Scalar& Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::insertBackByOuterInner ( Index  outer,
Index  inner 
)
inline
See also
insertBack

§ nonZeros()

template<typename _Scalar, int _Options, typename _Index>
Index Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::nonZeros ( ) const
inline
Returns
the number of non zero coefficients

§ startFill()

template<typename _Scalar, int _Options, typename _Index>
EIGEN_DEPRECATED void Eigen::DynamicSparseMatrix< _Scalar, _Options, _Index >::startFill ( Index  reserveSize = 1000)
inline
Deprecated:
Set the matrix to zero and reserve the memory for reserveSize nonzero coefficients.

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