Eigen  3.3.3
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 >:

List of all members.

Public Member Functions

 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 ()

Constructor & Destructor Documentation

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.

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<const SparseMatrix<double> >  
template<typename SparseMatrixType >
Eigen::Map< SparseMatrixType >::~Map ( ) [inline]

Empty destructor


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends