template<typename SparseMatrixType>
class Eigen::Map< SparseMatrixType >
Specialization of class Map for SparseMatrix-like storage.
- Template Parameters
-
SparseMatrixType | the equivalent sparse matrix type of the referenced data, it must be a template instance of class SparseMatrix. |
- See also
- class Map, class SparseMatrix, class Ref<SparseMatrixType,Options>
|
| Map (Index rows, Index cols, Index nnz, const StorageIndex *outerIndexPtr, const StorageIndex *innerIndexPtr, const Scalar *valuePtr, const StorageIndex *innerNonZerosPtr=0) |
|
| Map (Index rows, Index cols, Index nnz, StorageIndex *outerIndexPtr, StorageIndex *innerIndexPtr, Scalar *valuePtr, StorageIndex *innerNonZerosPtr=0) |
|
| Map (PointerArgType dataPtr, const StrideType &stride=StrideType()) |
|
| Map (PointerArgType dataPtr, Index rows, Index cols, const StrideType &stride=StrideType()) |
|
| Map (PointerArgType dataPtr, Index size, const StrideType &stride=StrideType()) |
|
| ~Map () |
|
Scalar & | coeffRef (Index row, Index col) |
|
StorageIndex * | innerIndexPtr () |
|
StorageIndex * | innerNonZeroPtr () |
|
StorageIndex * | outerIndexPtr () |
|
Scalar * | valuePtr () |
|
| ~SparseMapBase () |
|
◆ Map() [1/5]
template<typename SparseMatrixType>
Eigen::Map< SparseMatrixType >::Map |
( |
Index | rows, |
|
|
Index | cols, |
|
|
Index | nnz, |
|
|
StorageIndex * | outerIndexPtr, |
|
|
StorageIndex * | innerIndexPtr, |
|
|
Scalar * | valuePtr, |
|
|
StorageIndex * | innerNonZerosPtr = 0 ) |
|
inline |
Constructs a read-write Map to a sparse matrix of size rows x cols, containing nnz non-zero coefficients, stored as a sparse format as defined by the pointers outerIndexPtr, innerIndexPtr, and valuePtr. If the optional parameter innerNonZerosPtr is the null pointer, then a standard compressed format is assumed.
This constructor is available only if SparseMatrixType
is non-const.
More details on the expected storage schemes are given in the manual pages.
◆ Map() [2/5]
template<typename SparseMatrixType>
Eigen::Map< SparseMatrixType >::Map |
( |
Index | rows, |
|
|
Index | cols, |
|
|
Index | nnz, |
|
|
const StorageIndex * | outerIndexPtr, |
|
|
const StorageIndex * | innerIndexPtr, |
|
|
const Scalar * | valuePtr, |
|
|
const StorageIndex * | innerNonZerosPtr = 0 ) |
|
inline |
This is the const version of the above constructor.
This constructor is available only if SparseMatrixType
is const, e.g.:
Map(Index rows, Index cols, Index nnz, StorageIndex *outerIndexPtr, StorageIndex *innerIndexPtr, Scalar *valuePtr, StorageIndex *innerNonZerosPtr=0)
Definition SparseMap.h:245
◆ ~Map()
template<typename SparseMatrixType>
◆ Map() [3/5]
Eigen::Map< SparseMatrixType, MapOptions, StrideType >::Map |
( |
PointerArgType | dataPtr, |
|
|
const StrideType & | stride = StrideType() ) |
|
inlineexplicit |
Constructor in the fixed-size case.
- Parameters
-
dataPtr | pointer to the array to map |
stride | optional Stride object, passing the strides. |
◆ Map() [4/5]
Eigen::Map< SparseMatrixType, MapOptions, StrideType >::Map |
( |
PointerArgType | dataPtr, |
|
|
Index | size, |
|
|
const StrideType & | stride = StrideType() ) |
|
inline |
Constructor in the dynamic-size vector case.
- Parameters
-
dataPtr | pointer to the array to map |
size | the size of the vector expression |
stride | optional Stride object, passing the strides. |
◆ Map() [5/5]
Eigen::Map< SparseMatrixType, MapOptions, StrideType >::Map |
( |
PointerArgType | dataPtr, |
|
|
Index | rows, |
|
|
Index | cols, |
|
|
const StrideType & | stride = StrideType() ) |
|
inline |
Constructor in the dynamic-size matrix case.
- Parameters
-
dataPtr | pointer to the array to map |
rows | the number of rows of the matrix expression |
cols | the number of columns of the matrix expression |
stride | optional Stride object, passing the strides. |
The documentation for this class was generated from the following file: