Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Eigen::internal::CompressedStorage< _Scalar, _StorageIndex > Class Template Reference

#include <CompressedStorage.h>

Public Types

typedef _Scalar Scalar
 
typedef _StorageIndex StorageIndex
 

Public Member Functions

Index allocatedSize () const
 
void append (const Scalar &v, Index i)
 
Scalar at (Index key, const Scalar &defaultValue=Scalar(0)) const
 
Scalar atInRange (Index start, Index end, Index key, const Scalar &defaultValue=Scalar(0)) const
 
ScalaratWithInsertion (Index key, const Scalar &defaultValue=Scalar(0))
 
void clear ()
 
 CompressedStorage ()
 
 CompressedStorage (const CompressedStorage &other)
 
 CompressedStorage (Index size)
 
StorageIndexindex (Index i)
 
const StorageIndexindex (Index i) const
 
StorageIndexindexPtr ()
 
const StorageIndexindexPtr () const
 
void moveChunk (Index from, Index to, Index chunkSize)
 
CompressedStorageoperator= (const CompressedStorage &other)
 
void prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
 
void reserve (Index size)
 
void resize (Index size, double reserveSizeFactor=0)
 
Index searchLowerIndex (Index key) const
 
Index searchLowerIndex (Index start, Index end, Index key) const
 
Index size () const
 
void squeeze ()
 
void swap (CompressedStorage &other)
 
Scalarvalue (Index i)
 
const Scalarvalue (Index i) const
 
ScalarvaluePtr ()
 
const ScalarvaluePtr () const
 
 ~CompressedStorage ()
 

Protected Types

typedef NumTraits< Scalar >::Real RealScalar
 

Protected Member Functions

void reallocate (Index size)
 

Protected Attributes

Index m_allocatedSize
 
StorageIndexm_indices
 
Index m_size
 
Scalarm_values
 

Detailed Description

template<typename _Scalar, typename _StorageIndex>
class Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >

Definition at line 22 of file CompressedStorage.h.

Member Typedef Documentation

◆ RealScalar

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

Definition at line 31 of file CompressedStorage.h.

◆ Scalar

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

Definition at line 26 of file CompressedStorage.h.

◆ StorageIndex

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

Definition at line 27 of file CompressedStorage.h.

Constructor & Destructor Documentation

◆ CompressedStorage() [1/3]

template<typename _Scalar , typename _StorageIndex >
Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::CompressedStorage ( )
inline

Definition at line 35 of file CompressedStorage.h.

◆ CompressedStorage() [2/3]

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

Definition at line 39 of file CompressedStorage.h.

◆ CompressedStorage() [3/3]

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

Definition at line 45 of file CompressedStorage.h.

◆ ~CompressedStorage()

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

Definition at line 70 of file CompressedStorage.h.

Member Function Documentation

◆ allocatedSize()

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

Definition at line 110 of file CompressedStorage.h.

◆ append()

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

Definition at line 101 of file CompressedStorage.h.

◆ 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.

Definition at line 146 of file CompressedStorage.h.

◆ 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)

Definition at line 159 of file CompressedStorage.h.

◆ 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.

Definition at line 174 of file CompressedStorage.h.

◆ clear()

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

Definition at line 111 of file CompressedStorage.h.

◆ index() [1/2]

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

Definition at line 121 of file CompressedStorage.h.

◆ index() [2/2]

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

Definition at line 122 of file CompressedStorage.h.

◆ indexPtr() [1/2]

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

Definition at line 116 of file CompressedStorage.h.

◆ indexPtr() [2/2]

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

Definition at line 115 of file CompressedStorage.h.

◆ moveChunk()

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

Definition at line 210 of file CompressedStorage.h.

◆ operator=()

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

Definition at line 51 of file CompressedStorage.h.

◆ prune()

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

Definition at line 226 of file CompressedStorage.h.

◆ reallocate()

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

Definition at line 244 of file CompressedStorage.h.

◆ reserve()

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

Definition at line 76 of file CompressedStorage.h.

◆ resize()

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

Definition at line 89 of file CompressedStorage.h.

◆ 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

Definition at line 125 of file CompressedStorage.h.

◆ 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

Definition at line 131 of file CompressedStorage.h.

◆ size()

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

Definition at line 109 of file CompressedStorage.h.

◆ squeeze()

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

Definition at line 83 of file CompressedStorage.h.

◆ swap()

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

Definition at line 62 of file CompressedStorage.h.

◆ value() [1/2]

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

Definition at line 118 of file CompressedStorage.h.

◆ value() [2/2]

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

Definition at line 119 of file CompressedStorage.h.

◆ valuePtr() [1/2]

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

Definition at line 114 of file CompressedStorage.h.

◆ valuePtr() [2/2]

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

Definition at line 113 of file CompressedStorage.h.

Member Data Documentation

◆ m_allocatedSize

template<typename _Scalar , typename _StorageIndex >
Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::m_allocatedSize
protected

Definition at line 266 of file CompressedStorage.h.

◆ m_indices

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

Definition at line 264 of file CompressedStorage.h.

◆ m_size

template<typename _Scalar , typename _StorageIndex >
Index Eigen::internal::CompressedStorage< _Scalar, _StorageIndex >::m_size
protected

Definition at line 265 of file CompressedStorage.h.

◆ m_values

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

Definition at line 263 of file CompressedStorage.h.


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


gtsam
Author(s):
autogenerated on Sat Nov 16 2024 04:13:04