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

#include <SparseMap.h>

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

Public Types
enum	{ IsRowMajor = Base::IsRowMajor }

typedef SparseMapBase< Derived, ReadOnlyAccessors >	Base

typedef Base::Scalar	Scalar

typedef Base::StorageIndex	StorageIndex

Public Types inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
enum	{ IsRowMajor = Base::IsRowMajor }

typedef SparseCompressedBase< Derived >	Base

typedef Base::Scalar	Scalar

typedef Base::StorageIndex	StorageIndex

Public Types inherited from Eigen::SparseCompressedBase< Derived >
typedef SparseMatrixBase< Derived >	Base

Public Member Functions
Scalar *	valuePtr ()

StorageIndex *	innerIndexPtr ()

StorageIndex *	outerIndexPtr ()

StorageIndex *	innerNonZeroPtr ()

Scalar &	coeffRef (Index row, Index col)

	SparseMapBase (Index rows, Index cols, Index nnz, StorageIndex outerIndexPtr, StorageIndex innerIndexPtr, Scalar valuePtr, StorageIndex innerNonZerosPtr=0)

	SparseMapBase (Index size, Index nnz, StorageIndex innerIndexPtr, Scalar valuePtr)

	~SparseMapBase ()

template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)

Derived &	operator= (const Derived &other)

Public Member Functions inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
Index	rows () const

Index	cols () const

Index	innerSize () const

Index	outerSize () const

Index	nonZeros () const

bool	isCompressed () const

const Scalar *	valuePtr () const

const StorageIndex *	innerIndexPtr () const

const StorageIndex *	outerIndexPtr () const

const StorageIndex *	innerNonZeroPtr () const

Scalar	coeff (Index row, Index col) const

	SparseMapBase (Index rows, Index cols, Index nnz, IndexPointer outerIndexPtr, IndexPointer innerIndexPtr, ScalarPointer valuePtr, IndexPointer innerNonZerosPtr=0)

	SparseMapBase (Index size, Index nnz, IndexPointer innerIndexPtr, ScalarPointer valuePtr)

	~SparseMapBase ()

template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)

Derived &	operator= (const Derived &other)

Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Index	nonZeros () const

const Scalar *	valuePtr () const

Scalar *	valuePtr ()

const StorageIndex *	innerIndexPtr () const

StorageIndex *	innerIndexPtr ()

const StorageIndex *	outerIndexPtr () const

StorageIndex *	outerIndexPtr ()

const StorageIndex *	innerNonZeroPtr () const

StorageIndex *	innerNonZeroPtr ()

bool	isCompressed () const

const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const

Map< Array< Scalar, Dynamic, 1 > >	coeffs ()

template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)

Derived &	operator= (const Derived &other)

Additional Inherited Members
Protected Types inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), Scalar , const Scalar >::type	ScalarPointer

typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), StorageIndex , const StorageIndex >::type	IndexPointer

Protected Types inherited from Eigen::SparseCompressedBase< Derived >
typedef Base::IndexVector	IndexVector

Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Eigen::Map< IndexVector >	innerNonZeros ()

const Eigen::Map< const IndexVector >	innerNonZeros () const

	SparseCompressedBase ()

internal::LowerBoundIndex	lower_bound (Index row, Index col) const

Protected Attributes inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
Index	m_outerSize

Index	m_innerSize

Array< StorageIndex, 2, 1 >	m_zero_nnz

IndexPointer	m_outerIndex

IndexPointer	m_innerIndices

ScalarPointer	m_values

IndexPointer	m_innerNonZeros

Detailed Description

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

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

class SparseMapBase

Constructor & Destructor Documentation

◆ ~SparseMapBase()

template<typename Derived >

Eigen::SparseMapBase< Derived, WriteAccessors >::~SparseMapBase ( )

inline

Empty destructor

Member Function Documentation

◆ coeffRef()

template<typename Derived >

Scalar& Eigen::SparseMapBase< Derived, WriteAccessors >::coeffRef	(	Index	row,
		Index	col
	)

inline

Returns: a non-const reference to the value of the matrix at position i, j

If the element does not exist then it is inserted via the insert(Index,Index) function which itself turns the matrix into a non compressed form if that was not the case.

This is a O(log(nnz_j)) operation (binary search) plus the cost of insert(Index,Index) function if the element does not already exist.

◆ innerIndexPtr()

template<typename Derived >

StorageIndex* Eigen::SparseMapBase< Derived, WriteAccessors >::innerIndexPtr ( )

inline

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

See also: valuePtr(), outerIndexPtr()

◆ innerNonZeroPtr()

template<typename Derived >

StorageIndex* Eigen::SparseMapBase< Derived, WriteAccessors >::innerNonZeroPtr ( )

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

◆ outerIndexPtr()

template<typename Derived >

StorageIndex* Eigen::SparseMapBase< Derived, WriteAccessors >::outerIndexPtr ( )

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.