Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.99 (git rev 10c77b0ff44d0b9cb0b252cfa0ccaaa39d3c5da4)
Eigen::SparseMapBase< Derived, ReadOnlyAccessors > Class Template Reference

Detailed Description

template<typename Derived>
class Eigen::SparseMapBase< Derived, ReadOnlyAccessors >

Common base class for Map and Ref instance of sparse matrix and vector.

class SparseMapBase

+ Inheritance diagram for Eigen::SparseMapBase< Derived, ReadOnlyAccessors >:

Public Member Functions

Scalar coeff (Index row, Index col) const
 
Index cols () const
 
const StorageIndex * innerIndexPtr () const
 
const StorageIndex * innerNonZeroPtr () const
 
Index innerSize () const
 
bool isCompressed () const
 
Index nonZeros () const
 
const StorageIndex * outerIndexPtr () const
 
Index outerSize () const
 
Index rows () const
 
const Scalar * valuePtr () const
 
 ~SparseMapBase ()
 
- Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Map< Array< Scalar, Dynamic, 1 > > coeffs ()
 
const Map< const Array< Scalar, Dynamic, 1 > > coeffs () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
bool isCompressed () const
 
Index nonZeros () const
 
StorageIndexouterIndexPtr ()
 
const StorageIndexouterIndexPtr () const
 
Scalar * valuePtr ()
 
const Scalar * valuePtr () const
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
Index cols () const
 
const internal::eval< Derived >::type eval () const
 
Index innerSize () const
 
bool isVector () const
 
template<typename OtherDerived >
const Product< Derived, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
Index outerSize () const
 
const SparseView< Derived > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
Index rows () const
 
Index size () const
 
SparseSymmetricPermutationProduct< Derived, Upper|LowertwistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
Index cols () const
 
Derived & derived ()
 
const Derived & derived () const
 
Index rows () const
 
Index size () const
 

Additional Inherited Members

- Public Types inherited from Eigen::SparseMatrixBase< Derived >
enum  {
  RowsAtCompileTime ,
  ColsAtCompileTime ,
  SizeAtCompileTime ,
  MaxRowsAtCompileTime ,
  MaxColsAtCompileTime ,
  MaxSizeAtCompileTime ,
  IsVectorAtCompileTime ,
  NumDimensions ,
  Flags ,
  IsRowMajor ,
  InnerSizeAtCompileTime
}
 
typedef internal::traits< Derived >::StorageIndex StorageIndex
 
typedef Scalar value_type
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
- Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
 SparseCompressedBase ()
 

Constructor & Destructor Documentation

◆ ~SparseMapBase()

template<typename Derived >
Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::~SparseMapBase ( )
inline

Empty destructor

Member Function Documentation

◆ coeff()

template<typename Derived >
Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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

◆ cols()

template<typename Derived >
Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::cols ( void  ) const
inline

Returns
the number of columns.
See also
rows()

◆ innerIndexPtr()

template<typename Derived >
const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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()

◆ innerNonZeroPtr()

template<typename Derived >
const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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

◆ innerSize()

template<typename Derived >
Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::innerSize ( ) const
inline

Returns
the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

◆ isCompressed()

template<typename Derived >
bool Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::isCompressed ( ) const
inline

Returns
whether *this is in compressed form.

◆ nonZeros()

template<typename Derived >
Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::nonZeros ( ) const
inline

Returns
the number of non zero coefficients

◆ outerIndexPtr()

template<typename Derived >
const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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()

◆ outerSize()

template<typename Derived >
Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::outerSize ( ) const
inline

Returns
the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

◆ rows()

template<typename Derived >
Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::rows ( void  ) const
inline

Returns
the number of rows.
See also
cols()

◆ valuePtr()

template<typename Derived >
const Scalar* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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()

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