Eigen::SparseMapBase< Derived, ReadOnlyAccessors > Class Template Reference

---

Detailed Description

template<typename Derived>
class Eigen::SparseMapBase< Derived, ReadOnlyAccessors >

Common base class for Map and Ref instance of sparse matrix and vector.

class SparseMapBase

Inheritance diagram for Eigen::SparseMapBase< Derived, ReadOnlyAccessors >:

List of all members.

Public Types
typedef Base::StorageIndex	StorageIndex
Public Member Functions
Scalar	coeff (Index row, Index col) const
Index	cols () const
const StorageIndex *	innerIndexPtr () const
const StorageIndex *	innerNonZeroPtr () const
Index	innerSize () const
bool	isCompressed () const
Index	nonZeros () const
const StorageIndex *	outerIndexPtr () const
Index	outerSize () const
Index	rows () const
const Scalar *	valuePtr () const
	~SparseMapBase ()

---

Member Typedef Documentation

template<typename Derived >

typedef Base::StorageIndex Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::StorageIndex

The integer type used to store indices within a SparseMatrix. For a SparseMatrix<Scalar,Options,IndexType> it an alias of the third template parameter IndexType.

Reimplemented from Eigen::SparseMatrixBase< Derived >.

Reimplemented in Eigen::SparseMapBase< Derived, WriteAccessors >.

---

Constructor & Destructor Documentation

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::~SparseMapBase

(

)

[inline]

Empty destructor

Reimplemented in Eigen::SparseMapBase< Derived, WriteAccessors >.

---

Member Function Documentation

template<typename Derived >

Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Returns:

the value of the matrix at position i, j This function returns Scalar(0) if the element is an explicit zero

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows()

Reimplemented from Eigen::SparseMatrixBase< Derived >.

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::innerIndexPtr

(

)

const [inline]

Returns:

a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

See also:

valuePtr(), outerIndexPtr()

Reimplemented from Eigen::SparseCompressedBase< Derived >.

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::innerNonZeroPtr

(

)

const [inline]

Returns:

a const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.

Warning:

it returns the null pointer 0 in compressed mode

Reimplemented from Eigen::SparseCompressedBase< Derived >.

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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< Derived >.

template<typename Derived >

bool Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::isCompressed

(

)

const [inline]

Returns:

whether *this is in compressed form.

Reimplemented from Eigen::SparseCompressedBase< Derived >.

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::nonZeros

(

)

const [inline]

Returns:

the number of non zero coefficients

Reimplemented from Eigen::SparseCompressedBase< Derived >.

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::outerIndexPtr

(

)

const [inline]

Returns:

a const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

See also:

valuePtr(), innerIndexPtr()

Reimplemented from Eigen::SparseCompressedBase< Derived >.

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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< Derived >.

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols()

Reimplemented from Eigen::SparseMatrixBase< Derived >.

template<typename Derived >

const Scalar* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::valuePtr

(

)

const [inline]

Returns:

a const pointer to the array of values. This function is aimed at interoperability with other libraries.

See also:

innerIndexPtr(), outerIndexPtr()

Reimplemented from Eigen::SparseCompressedBase< Derived >.

---

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

• SparseMap.h