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

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.

Contents

Base classes

template<typename Derived>
class SparseMapBase<Derived, WriteAccessors>
Common base class for writable Map and Ref instance of sparse matrix and vector.

Constructors, destructors, conversion operators

Map(Index rows, Index cols, Index nnz, StorageIndex* outerIndexPtr, StorageIndex* innerIndexPtr, Scalar* valuePtr, StorageIndex* innerNonZerosPtr = 0)
Map(Index rows, Index cols, Index nnz, const StorageIndex* outerIndexPtr, const StorageIndex* innerIndexPtr, const Scalar* valuePtr, const StorageIndex* innerNonZerosPtr = 0)
~Map()

Function documentation

template<typename SparseMatrixType>
Eigen::Map<SparseMatrixType><SparseMatrixType>::Map(Index rows, Index cols, Index nnz, StorageIndex* outerIndexPtr, StorageIndex* innerIndexPtr, Scalar* valuePtr, StorageIndex* innerNonZerosPtr = 0)

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.

template<typename SparseMatrixType>
Eigen::Map<SparseMatrixType><SparseMatrixType>::Map(Index rows, Index cols, Index nnz, const StorageIndex* outerIndexPtr, const StorageIndex* innerIndexPtr, const Scalar* valuePtr, const StorageIndex* innerNonZerosPtr = 0)

This is the const version of the above constructor.

This constructor is available only if SparseMatrixType is const, e.g.: Map<const SparseMatrix<double> >

template<typename SparseMatrixType>
Eigen::Map<SparseMatrixType><SparseMatrixType>::~Map()

Empty destructor