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

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

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

Public Member Functions
Scalar &	coeffRef (Index row, Index col)
StorageIndex *	innerIndexPtr ()
StorageIndex *	innerNonZeroPtr ()
StorageIndex *	outerIndexPtr ()
Scalar *	valuePtr ()
	~SparseMapBase ()
Public Member Functions inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
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 ()
Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Map< Array< Scalar, Dynamic, 1 > >	coeffs ()
const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const
StorageIndex *	innerIndexPtr ()
const StorageIndex *	innerIndexPtr () const
StorageIndex *	innerNonZeroPtr ()
const StorageIndex *	innerNonZeroPtr () const
bool	isCompressed () const
Index	nonZeros () const
StorageIndex *	outerIndexPtr ()
const StorageIndex *	outerIndexPtr () const
Scalar *	valuePtr ()
const Scalar *	valuePtr () const
Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
Index	cols () const
const internal::eval< Derived >::type	eval () const
Index	innerSize () const
bool	isVector () const
template<typename OtherDerived >
const Product< Derived, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const
Index	outerSize () const
const SparseView< Derived >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Index	rows () const
Index	size () const
SparseSymmetricPermutationProduct< Derived, Upper|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	derived () const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Additional Inherited Members
Public Types inherited from Eigen::SparseMatrixBase< Derived >
enum	{   RowsAtCompileTime ,   ColsAtCompileTime ,   SizeAtCompileTime ,   MaxRowsAtCompileTime ,   MaxColsAtCompileTime ,   MaxSizeAtCompileTime ,   IsVectorAtCompileTime ,   NumDimensions ,   Flags ,   IsRowMajor ,   InnerSizeAtCompileTime }
typedef internal::traits< Derived >::StorageIndex	StorageIndex
typedef Scalar	value_type
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...
Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
	SparseCompressedBase ()

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.

See also

valuePtr(), innerIndexPtr()

valuePtr()

template<typename Derived >

Scalar* Eigen::SparseMapBase< Derived, WriteAccessors >::valuePtr ( )

inline

Returns

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

See also

innerIndexPtr(), outerIndexPtr()

---

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

• SparseMap.h