Common base class for writable Map and Ref instance of sparse matrix and vector. More...
#include <SparseMap.h>
Inheritance diagram for Eigen::SparseMapBase< Derived, WriteAccessors >:
Public Types | |
| enum | { IsRowMajor = Base::IsRowMajor } |
| typedef SparseMapBase< Derived, ReadOnlyAccessors > | Base |
| typedef Base::Scalar | Scalar |
| typedef Base::StorageIndex | StorageIndex |
 Public Types inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors > | |
| enum | { IsRowMajor = Base::IsRowMajor } |
| typedef SparseCompressedBase< Derived > | Base |
| typedef Base::Scalar | Scalar |
| typedef Base::StorageIndex | StorageIndex |
| Public Types inherited from Eigen::SparseCompressedBase< Derived > | |
| typedef SparseMatrixBase< Derived > | Base |
Protected Member Functions | |
| SparseMapBase () | |
| Protected Member Functions inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors > | |
| SparseMapBase () | |
| Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived > | |
| Eigen::Map< IndexVector > | innerNonZeros () |
| const Eigen::Map< const IndexVector > | innerNonZeros () const |
| internal::LowerBoundIndex | lower_bound (Index row, Index col) const |
| SparseCompressedBase () | |
Private Types | |
| typedef MapBase< Derived, ReadOnlyAccessors > | ReadOnlyMapBase |
Additional Inherited Members | |
| Protected Types inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors > | |
| typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), StorageIndex *, const StorageIndex * >::type | IndexPointer |
| typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), Scalar *, const Scalar * >::type | ScalarPointer |
| Protected Types inherited from Eigen::SparseCompressedBase< Derived > | |
| typedef Base::IndexVector | IndexVector |
| Protected Attributes inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors > | |
| IndexPointer | m_innerIndices |
| IndexPointer | m_innerNonZeros |
| Index | m_innerSize |
| IndexPointer | m_outerIndex |
| Index | m_outerSize |
| ScalarPointer | m_values |
| Array< StorageIndex, 2, 1 > | m_zero_nnz |
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
Definition at line 148 of file SparseMap.h.
Member Typedef Documentation
◆ Base
template<typename Derived >
| typedef SparseMapBase<Derived, ReadOnlyAccessors> Eigen::SparseMapBase< Derived, WriteAccessors >::Base |
Definition at line 154 of file SparseMap.h.
◆ ReadOnlyMapBase
template<typename Derived >
|
private |
Definition at line 151 of file SparseMap.h.
◆ Scalar
template<typename Derived >
| typedef Base::Scalar Eigen::SparseMapBase< Derived, WriteAccessors >::Scalar |
Definition at line 155 of file SparseMap.h.
◆ StorageIndex
template<typename Derived >
| typedef Base::StorageIndex Eigen::SparseMapBase< Derived, WriteAccessors >::StorageIndex |
Definition at line 156 of file SparseMap.h.
Member Enumeration Documentation
◆ anonymous enum
template<typename Derived >
| anonymous enum |
| Enumerator | |
|---|---|
| IsRowMajor | |
Definition at line 157 of file SparseMap.h.
Constructor & Destructor Documentation
◆ SparseMapBase() [1/3]
template<typename Derived >
|
inline |
Definition at line 195 of file SparseMap.h.
◆ SparseMapBase() [2/3]
template<typename Derived >
|
inline |
Definition at line 201 of file SparseMap.h.
◆ ~SparseMapBase()
template<typename Derived >
|
inline |
Empty destructor
Definition at line 206 of file SparseMap.h.
◆ SparseMapBase() [3/3]
template<typename Derived >
|
inlineprotected |
Definition at line 209 of file SparseMap.h.
Member Function Documentation
◆ coeffRef()
template<typename Derived >
|
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.
Definition at line 180 of file SparseMap.h.
◆ innerIndexPtr()
template<typename Derived >
|
inline |
- Returns
- a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.
- See also
- valuePtr(), outerIndexPtr()
Definition at line 172 of file SparseMap.h.
◆ innerNonZeroPtr()
template<typename Derived >
|
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
Definition at line 176 of file SparseMap.h.
◆ outerIndexPtr()
template<typename Derived >
|
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()
Definition at line 174 of file SparseMap.h.
◆ valuePtr()
template<typename Derived >
|
inline |
- Returns
- a const pointer to the array of values. This function is aimed at interoperability with other libraries.
- See also
- innerIndexPtr(), outerIndexPtr()
Definition at line 170 of file SparseMap.h.
The documentation for this class was generated from the following file: