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

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

Contents

class SparseMapBase

Base classes

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

Derived classes

template<typename SparseMatrixType>
class Map<SparseMatrixType>
Specialization of class Map for SparseMatrix-like storage.
template<typename SparseMatrixType, int Options>
class Ref<SparseMatrixType, Options>
A sparse matrix expression referencing an existing sparse expression.
template<typename SparseVectorType>
class Ref<SparseVectorType>
A sparse vector expression referencing an existing sparse vector expression.

Constructors, destructors, conversion operators

~SparseMapBase()

Public functions

auto coeffRef(Index row, Index col) -> Scalar&
auto innerIndexPtr() -> StorageIndex*
auto innerNonZeroPtr() -> StorageIndex*
auto outerIndexPtr() -> StorageIndex*
auto valuePtr() -> Scalar*

Function documentation

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

Empty destructor

template<typename Derived>
Scalar& Eigen::SparseMapBase<Derived, WriteAccessors><Derived>::coeffRef(Index row, Index col)

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.

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

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

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

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>
StorageIndex* Eigen::SparseMapBase<Derived, WriteAccessors><Derived>::outerIndexPtr()

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>
Scalar* Eigen::SparseMapBase<Derived, WriteAccessors><Derived>::valuePtr()

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