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

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

Contents

class SparseMapBase

Base classes

template<typename Derived>
class SparseCompressedBase
Common base class for sparse [compressed]-{row|column}-storage format.

Derived classes

template<typename Derived>
class SparseMapBase<Derived, WriteAccessors>
Common base class for writable Map and Ref instance of sparse matrix and vector.

Constructors, destructors, conversion operators

~SparseMapBase()

Public functions

auto coeff(Index row, Index col) const -> Scalar
auto cols() const -> Index
auto innerIndexPtr() const -> const StorageIndex*
auto innerNonZeroPtr() const -> const StorageIndex*
auto innerSize() const -> Index
auto isCompressed() const -> bool
auto nonZeros() const -> Index
auto outerIndexPtr() const -> const StorageIndex*
auto outerSize() const -> Index
auto rows() const -> Index
auto valuePtr() const -> const Scalar*

Function documentation

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

Empty destructor

template<typename Derived>
Scalar Eigen::SparseMapBase<Derived, ReadOnlyAccessors><Derived>::coeff(Index row, Index col) const

Returns the value of the matrix at position i, j This function returns Scalar(0) if the element is an explicit zero

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

Returns the number of columns.

template<typename Derived>
const StorageIndex* Eigen::SparseMapBase<Derived, ReadOnlyAccessors><Derived>::innerIndexPtr() const

Returns a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

template<typename Derived>
const StorageIndex* Eigen::SparseMapBase<Derived, ReadOnlyAccessors><Derived>::innerNonZeroPtr() const

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.

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

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

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

Returns whether *this is in compressed form.

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

Returns the number of non zero coefficients

template<typename Derived>
const StorageIndex* Eigen::SparseMapBase<Derived, ReadOnlyAccessors><Derived>::outerIndexPtr() const

Returns a const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

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

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

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

Returns the number of rows.

template<typename Derived>
const Scalar* Eigen::SparseMapBase<Derived, ReadOnlyAccessors><Derived>::valuePtr() const

Returns a const pointer to the array of values. This function is aimed at interoperability with other libraries.