W3cubDocs

/Eigen3

Eigen::SparseMapBase

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

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

class SparseMapBase

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
StorageIndex * innerIndexPtr ()
const StorageIndex * innerIndexPtr () const
StorageIndex * innerNonZeroPtr ()
const StorageIndex * innerNonZeroPtr () const
bool isCompressed () const
Index nonZeros () const
StorageIndex * outerIndexPtr ()
const StorageIndex * outerIndexPtr () 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|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
- Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
- 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 ()

~SparseMapBase()

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

Empty destructor

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:

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1SparseMapBase_3_01Derived_00_01ReadOnlyAccessors_01_4.html