Eigen::internal::CompressedStorage< _Scalar, _StorageIndex > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/CompressedStorage.h>

Public Types
typedef _Scalar	Scalar
typedef _StorageIndex	StorageIndex

Public Member Functions
	CompressedStorage ()
	CompressedStorage (Index size)
	CompressedStorage (const CompressedStorage &other)
CompressedStorage &	operator= (const CompressedStorage &other)
void	swap (CompressedStorage &other)
	~CompressedStorage ()
void	reserve (Index size)
void	squeeze ()
void	resize (Index size, double reserveSizeFactor=0)
void	append (const Scalar &v, Index i)
Index	size () const
Index	allocatedSize () const
void	clear ()
const Scalar *	valuePtr () const
Scalar *	valuePtr ()
const StorageIndex *	indexPtr () const
StorageIndex *	indexPtr ()
Scalar &	value (Index i)
const Scalar &	value (Index i) const
StorageIndex &	index (Index i)
const StorageIndex &	index (Index i) const
Index	searchLowerIndex (Index key) const
Index	searchLowerIndex (Index start, Index end, Index key) const
Scalar	at (Index key, const Scalar &defaultValue=Scalar(0)) const
Scalar	atInRange (Index start, Index end, Index key, const Scalar &defaultValue=Scalar(0)) const
	Like at(), but the search is performed in the range [start,end) More...
Scalar &	atWithInsertion (Index key, const Scalar &defaultValue=Scalar(0))
void	moveChunk (Index from, Index to, Index chunkSize)
void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())

Protected Types
typedef NumTraits< Scalar >::Real	RealScalar

Protected Member Functions
void	reallocate (Index size)

Protected Attributes
Scalar *	m_values
StorageIndex *	m_indices
Index	m_size
Index	m_allocatedSize

Member Typedef Documentation

RealScalar

template<typename _Scalar , typename _StorageIndex >

typedef NumTraits<Scalar>::Real Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::RealScalar

protected

Scalar

template<typename _Scalar , typename _StorageIndex >

typedef _Scalar Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::Scalar

StorageIndex

template<typename _Scalar , typename _StorageIndex >

typedef _StorageIndex Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::StorageIndex

Constructor & Destructor Documentation

CompressedStorage() [1/3]

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::CompressedStorage ( )

inline

CompressedStorage() [2/3]

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::CompressedStorage ( Index  size )

inlineexplicit

CompressedStorage() [3/3]

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::CompressedStorage ( const CompressedStorage< _Scalar, _StorageIndex > &  other )

inline

~CompressedStorage()

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::~CompressedStorage ( )

inline

Member Function Documentation

allocatedSize()

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::allocatedSize ( ) const

inline

append()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::append ( const Scalar &  v, Index  i  )

inline

at()

template<typename _Scalar , typename _StorageIndex >

Scalar Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::at ( Index  key, const Scalar &  defaultValue = Scalar(0)  ) const

inline

Returns

the stored value at index key If the value does not exist, then the value defaultValue is returned without any insertion.

atInRange()

template<typename _Scalar , typename _StorageIndex >

Scalar Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::atInRange ( Index  start, Index  end, Index  key, const Scalar &  defaultValue = Scalar(0)  ) const

inline

Like at(), but the search is performed in the range [start,end)

atWithInsertion()

template<typename _Scalar , typename _StorageIndex >

Scalar & Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::atWithInsertion ( Index  key, const Scalar &  defaultValue = Scalar(0)  )

inline

Returns

a reference to the value at index key If the value does not exist, then the value defaultValue is inserted such that the keys are sorted.

clear()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::clear ( )

inline

index() [1/2]

template<typename _Scalar , typename _StorageIndex >

StorageIndex & Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::index ( Index  i )

inline

index() [2/2]

template<typename _Scalar , typename _StorageIndex >

const StorageIndex & Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::index ( Index  i ) const

inline

indexPtr() [1/2]

template<typename _Scalar , typename _StorageIndex >

StorageIndex * Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::indexPtr ( )

inline

indexPtr() [2/2]

template<typename _Scalar , typename _StorageIndex >

const StorageIndex * Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::indexPtr ( ) const

inline

moveChunk()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::moveChunk ( Index  from, Index  to, Index  chunkSize  )

inline

operator=()

template<typename _Scalar , typename _StorageIndex >

CompressedStorage & Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::operator= ( const CompressedStorage< _Scalar, _StorageIndex > &  other )

inline

prune()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::prune ( const Scalar &  reference, const RealScalar &  epsilon = NumTraits<RealScalar>::dummy_precision()  )

inline

reallocate()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::reallocate ( Index  size )

inlineprotected

reserve()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::reserve ( Index  size )

inline

resize()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::resize ( Index  size, double  reserveSizeFactor = 0  )

inline

searchLowerIndex() [1/2]

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::searchLowerIndex ( Index  key ) const

inline

Returns

the largest k such that for all j in [0,k) index[j]<key

searchLowerIndex() [2/2]

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::searchLowerIndex ( Index  start, Index  end, Index  key  ) const

inline

Returns

the largest k in [start,end) such that for all j in [start,k) index[j]<key

size()

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::size ( ) const

inline

squeeze()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::squeeze ( )

inline

swap()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::swap ( CompressedStorage< _Scalar, _StorageIndex > &  other )

inline

value() [1/2]

template<typename _Scalar , typename _StorageIndex >

Scalar & Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::value ( Index  i )

inline

value() [2/2]

template<typename _Scalar , typename _StorageIndex >

const Scalar & Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::value ( Index  i ) const

inline

valuePtr() [1/2]

template<typename _Scalar , typename _StorageIndex >

Scalar * Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::valuePtr ( )

inline

valuePtr() [2/2]

template<typename _Scalar , typename _StorageIndex >

const Scalar * Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::valuePtr ( ) const

inline

Member Data Documentation

m_allocatedSize

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::m_allocatedSize

protected

m_indices

template<typename _Scalar , typename _StorageIndex >

StorageIndex* Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::m_indices

protected

m_size

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::m_size

protected

m_values

template<typename _Scalar , typename _StorageIndex >

Scalar* Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::m_values

protected

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/CompressedStorage.h