Eigen  3.3.3
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 >:

List of all members.

Public Types

typedef Base::StorageIndex StorageIndex

Public Member Functions

Scalar & coeffRef (Index row, Index col)
StorageIndexinnerIndexPtr ()
StorageIndexinnerNonZeroPtr ()
StorageIndexouterIndexPtr ()
Scalar * valuePtr ()
 ~SparseMapBase ()

Member Typedef Documentation

template<typename Derived >
typedef Base::StorageIndex Eigen::SparseMapBase< Derived, WriteAccessors >::StorageIndex

The integer type used to store indices within a SparseMatrix. For a SparseMatrix<Scalar,Options,IndexType> it an alias of the third template parameter IndexType.

Reimplemented from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >.


Constructor & Destructor Documentation

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

Empty destructor

Reimplemented from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >.


Member Function Documentation

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.

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

Reimplemented from Eigen::SparseCompressedBase< Derived >.

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

Reimplemented from Eigen::SparseCompressedBase< Derived >.

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

Reimplemented from Eigen::SparseCompressedBase< Derived >.

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

Reimplemented from Eigen::SparseCompressedBase< Derived >.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends