Eigen::Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType > Class Template Reference

Specialization of class Map for SparseMatrix-like storage. More...

#include <SparseMap.h>

Inheritance diagram for Eigen::Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >:

Public Types
enum	{ IsRowMajor = Base::IsRowMajor }
typedef SparseMapBase< Map >	Base

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

Detailed Description

template<typename MatScalar, int MatOptions, typename MatIndex, int Options, typename StrideType>
class Eigen::Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >

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>

Definition at line 222 of file SparseMap.h.

Member Typedef Documentation

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

typedef SparseMapBase<Map> Eigen::Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Base

Definition at line 231 of file SparseMap.h.

Member Enumeration Documentation

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

anonymous enum

Enumerator
IsRowMajor

Definition at line 233 of file SparseMap.h.

Constructor & Destructor Documentation

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

Eigen::Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::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.

Definition at line 245 of file SparseMap.h.

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

Eigen::Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::~Map ( )

inline

Empty destructor

Definition at line 251 of file SparseMap.h.

---

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

• SparseMap.h