Common base class for Map and Ref instance of sparse matrix and vector. More...
#include <SparseMap.h>
Inheritance diagram for Eigen::SparseMapBase< Derived, ReadOnlyAccessors >:
Public Types | |
| 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 |
Public Member Functions | |
| Scalar | coeff (Index row, Index col) const |
| Index | cols () const |
| const StorageIndex * | innerIndexPtr () const |
| const StorageIndex * | innerNonZeroPtr () const |
| Index | innerSize () const |
| bool | isCompressed () const |
| Index | nonZeros () const |
| const StorageIndex * | outerIndexPtr () const |
| Index | outerSize () const |
| Index | rows () const |
| SparseMapBase (Index rows, Index cols, Index nnz, IndexPointer outerIndexPtr, IndexPointer innerIndexPtr, ScalarPointer valuePtr, IndexPointer innerNonZerosPtr=0) | |
| SparseMapBase (Index size, Index nnz, IndexPointer innerIndexPtr, ScalarPointer valuePtr) | |
| const Scalar * | valuePtr () const |
| ~SparseMapBase () | |
| Public Member Functions inherited from Eigen::SparseCompressedBase< Derived > | |
| Map< Array< Scalar, Dynamic, 1 > > | coeffs () |
| const Map< const Array< Scalar, Dynamic, 1 > > | coeffs () const |
| StorageIndex * | innerIndexPtr () |
| const StorageIndex * | innerIndexPtr () const |
| StorageIndex * | innerNonZeroPtr () |
| const StorageIndex * | innerNonZeroPtr () const |
| bool | isCompressed () const |
| Index | nonZeros () const |
| Derived & | operator= (const Derived &other) |
| Derived & | operator= (const Derived &other) |
| Derived & | operator= (const EigenBase< OtherDerived > &other) |
| Derived & | operator= (const ReturnByValue< OtherDerived > &other) |
| Derived & | operator= (const SparseMatrixBase< OtherDerived > &other) |
| StorageIndex * | outerIndexPtr () |
| const StorageIndex * | outerIndexPtr () const |
| Scalar * | valuePtr () |
| const Scalar * | valuePtr () const |
Protected Types | |
| 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 Member Functions | |
| 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 () | |
Protected Attributes | |
| 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, ReadOnlyAccessors >
Common base class for Map and Ref instance of sparse matrix and vector.
class SparseMapBase
Definition at line 50 of file SparseMap.h.
Member Typedef Documentation
◆ Base
template<typename Derived >
| typedef SparseCompressedBase<Derived> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::Base |
Definition at line 54 of file SparseMap.h.
◆ IndexPointer
template<typename Derived >
|
protected |
Definition at line 66 of file SparseMap.h.
◆ Scalar
template<typename Derived >
| typedef Base::Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::Scalar |
Definition at line 55 of file SparseMap.h.
◆ ScalarPointer
template<typename Derived >
|
protected |
Definition at line 63 of file SparseMap.h.
◆ StorageIndex
template<typename Derived >
| typedef Base::StorageIndex Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::StorageIndex |
Definition at line 56 of file SparseMap.h.
Member Enumeration Documentation
◆ anonymous enum
template<typename Derived >
| anonymous enum |
| Enumerator | |
|---|---|
| IsRowMajor | |
Definition at line 57 of file SparseMap.h.
Constructor & Destructor Documentation
◆ SparseMapBase() [1/3]
template<typename Derived >
|
inline |
Definition at line 124 of file SparseMap.h.
◆ SparseMapBase() [2/3]
template<typename Derived >
|
inline |
Definition at line 131 of file SparseMap.h.
◆ ~SparseMapBase()
template<typename Derived >
|
inline |
Empty destructor
Definition at line 137 of file SparseMap.h.
◆ SparseMapBase() [3/3]
template<typename Derived >
|
inlineprotected |
Definition at line 140 of file SparseMap.h.
Member Function Documentation
◆ coeff()
template<typename Derived >
|
inline |
- Returns
- the value of the matrix at position i, j This function returns Scalar(0) if the element is an explicit zero
Definition at line 105 of file SparseMap.h.
◆ cols()
template<typename Derived >
|
inline |
◆ 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 97 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 101 of file SparseMap.h.
◆ innerSize()
template<typename Derived >
|
inline |
- Returns
- the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise
Definition at line 83 of file SparseMap.h.
◆ isCompressed()
template<typename Derived >
|
inline |
- Returns
- whether
*thisis in compressed form.
Definition at line 90 of file SparseMap.h.
◆ nonZeros()
template<typename Derived >
|
inline |
- Returns
- the number of non zero coefficients
Definition at line 87 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 99 of file SparseMap.h.
◆ outerSize()
template<typename Derived >
|
inline |
- Returns
- the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise
Definition at line 85 of file SparseMap.h.
◆ rows()
template<typename Derived >
|
inline |
◆ 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 95 of file SparseMap.h.
Member Data Documentation
◆ m_innerIndices
template<typename Derived >
|
protected |
Definition at line 72 of file SparseMap.h.
◆ m_innerNonZeros
template<typename Derived >
|
protected |
Definition at line 74 of file SparseMap.h.
◆ m_innerSize
template<typename Derived >
|
protected |
Definition at line 69 of file SparseMap.h.
◆ m_outerIndex
template<typename Derived >
|
protected |
Definition at line 71 of file SparseMap.h.
◆ m_outerSize
template<typename Derived >
|
protected |
Definition at line 68 of file SparseMap.h.
◆ m_values
template<typename Derived >
|
protected |
Definition at line 73 of file SparseMap.h.
◆ m_zero_nnz
template<typename Derived >
|
protected |
Definition at line 70 of file SparseMap.h.
The documentation for this class was generated from the following file: