Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index > Class Template Reference

Sparse matrix. More...

#include <MappedSparseMatrix.h>

Inheritance diagram for Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >:

List of all members.

Classes
class	InnerIterator
class	ReverseInnerIterator
Public Types
enum	{ IsRowMajor = Base::IsRowMajor }
Public Member Functions
Scalar	coeff (Index row, Index col) const
Scalar &	coeffRef (Index row, Index col)
Index	cols () const
const Index *	innerIndexPtr () const
Index *	innerIndexPtr ()
Index	innerSize () const
bool	isCompressed () const
	MappedSparseMatrix (Index rows, Index cols, Index nnz, Index *outerIndexPtr, Index *innerIndexPtr, Scalar *valuePtr)
Index	nonZeros () const
const Index *	outerIndexPtr () const
Index *	outerIndexPtr ()
Index	outerSize () const
Index	rows () const
const Scalar *	valuePtr () const
Scalar *	valuePtr ()
	~MappedSparseMatrix ()
Protected Attributes
Index *	m_innerIndices
Index	m_innerSize
Index	m_nnz
Index *	m_outerIndex
Index	m_outerSize
Scalar *	m_values

---

Detailed Description

template<typename _Scalar, int _Flags, typename _Index>
class Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >

Sparse matrix.

Parameters:

_Scalar

the scalar type, i.e. the type of the coefficients

See http://www.netlib.org/linalg/html_templates/node91.html for details on the storage scheme.

Definition at line 31 of file MappedSparseMatrix.h.

---

Member Enumeration Documentation

template<typename _Scalar, int _Flags, typename _Index>

anonymous enum

Enumerator:

IsRowMajor

Definition at line 36 of file MappedSparseMatrix.h.

---

Constructor & Destructor Documentation

template<typename _Scalar, int _Flags, typename _Index>

Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::MappedSparseMatrix	(	Index	rows,
		Index	cols,
		Index	nnz,
		Index *	outerIndexPtr,
		Index *	innerIndexPtr,
		Scalar *	valuePtr
	)		[inline]

Definition at line 108 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::~MappedSparseMatrix

(

)

[inline]

Empty destructor

Definition at line 114 of file MappedSparseMatrix.h.

---

Member Function Documentation

template<typename _Scalar, int _Flags, typename _Index>

Scalar Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 68 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Scalar& Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::coeffRef	(	Index	row,
		Index	col
	)		[inline]

Definition at line 87 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows()

Reimplemented from Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

Definition at line 50 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

const Index* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::innerIndexPtr

(

)

const [inline]

Definition at line 61 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::innerIndexPtr

(

)

[inline]

Definition at line 62 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::innerSize

(

)

const [inline]

Returns:

the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Reimplemented from Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

Definition at line 51 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

bool Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::isCompressed

(

)

const [inline]

Definition at line 54 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::nonZeros

(

)

const [inline]

Returns:

the number of non zero coefficients

Reimplemented from Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

Definition at line 106 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

const Index* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::outerIndexPtr

(

)

const [inline]

Definition at line 64 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::outerIndexPtr

(

)

[inline]

Definition at line 65 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::outerSize

(

)

const [inline]

Returns:

the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Reimplemented from Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

Definition at line 52 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols()

Reimplemented from Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

Definition at line 49 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

const Scalar* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::valuePtr

(

)

const [inline]

Definition at line 58 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Scalar* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::valuePtr

(

)

[inline]

Definition at line 59 of file MappedSparseMatrix.h.

---

Member Data Documentation

template<typename _Scalar, int _Flags, typename _Index>

Index* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::m_innerIndices [protected]

Definition at line 44 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::m_innerSize [protected]

Definition at line 41 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::m_nnz [protected]

Definition at line 42 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::m_outerIndex [protected]

Definition at line 43 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Index Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::m_outerSize [protected]

Definition at line 40 of file MappedSparseMatrix.h.

template<typename _Scalar, int _Flags, typename _Index>

Scalar* Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >::m_values [protected]

Definition at line 45 of file MappedSparseMatrix.h.

---

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

• MappedSparseMatrix.h