Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
Loading...
Searching...
No Matches
Eigen::SparseMapBase< Derived, WriteAccessors > Class Template Reference

Detailed Description

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

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

class SparseMapBase

Inheritance diagram for Eigen::SparseMapBase< Derived, WriteAccessors >:

Public Member Functions

Scalar & coeffRef (Index row, Index col)
StorageIndex * innerIndexPtr ()
StorageIndex * innerNonZeroPtr ()
StorageIndex * outerIndexPtr ()
Scalar * valuePtr ()
 ~SparseMapBase ()

Constructor & Destructor Documentation

◆ ~SparseMapBase()

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

Empty destructor

Member Function Documentation

◆ coeffRef()

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

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.

◆ innerIndexPtr()

template<typename Derived>
StorageIndex * Eigen::SparseMapBase< Derived, WriteAccessors >::innerIndexPtr ( )
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>
StorageIndex * Eigen::SparseMapBase< Derived, WriteAccessors >::innerNonZeroPtr ( )
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

◆ outerIndexPtr()

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

◆ valuePtr()

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