Eigen::SparseMapBase< Derived, WriteAccessors > Class Template Reference

#include <Eigen/src/SparseCore/SparseMap.h>

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 ()

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 row, col

The element must already exist: unlike SparseMatrix::coeffRef, this function cannot insert a new one because *this does not own the buffers it points to.

This is a O(log(nnz_j)) operation (binary search).

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:

• /builds/libeigen/eigen/Eigen/src/SparseCore/SparseMap.h