Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
Loading...
Searching...
No Matches
Eigen::Map< SparseMatrixType > Class Template Reference

Detailed Description

template<typename SparseMatrixType>
class Eigen::Map< SparseMatrixType >

Specialization of class Map for SparseMatrix-like storage.

Template Parameters
SparseMatrixTypethe 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>
Inheritance diagram for Eigen::Map< SparseMatrixType >:

Public Member Functions

 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 ()
Public Member Functions inherited from Eigen::SparseMapBase< Derived, WriteAccessors >
Scalar & coeffRef (Index row, Index col)
StorageIndex * innerIndexPtr ()
StorageIndex * innerNonZeroPtr ()
StorageIndex * outerIndexPtr ()
Scalar * valuePtr ()
 ~SparseMapBase ()

Constructor & Destructor Documentation

◆ Map() [1/2]

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/2]

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>
Eigen::Map< SparseMatrixType >::~Map ( )
inline

Empty destructor


The documentation for this class was generated from the following file: