Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
CompressedStorage< _Scalar, _Index > Class Template Reference

#include <CompressedStorage.h>

List of all members.

Public Types

typedef _Index Index
typedef _Scalar Scalar

Public Member Functions

size_t allocatedSize () const
void append (const Scalar &v, Index i)
Scalar at (Index key, Scalar defaultValue=Scalar(0)) const
Scalar atInRange (size_t start, size_t end, Index key, Scalar defaultValue=Scalar(0)) const
ScalaratWithInsertion (Index key, Scalar defaultValue=Scalar(0))
void clear ()
 CompressedStorage ()
 CompressedStorage (size_t size)
 CompressedStorage (const CompressedStorage &other)
Indexindex (size_t i)
const Indexindex (size_t i) const
CompressedStorageoperator= (const CompressedStorage &other)
void prune (Scalar reference, RealScalar epsilon=NumTraits< RealScalar >::dummy_precision())
void reserve (size_t size)
void resize (size_t size, float reserveSizeFactor=0)
Index searchLowerIndex (Index key) const
Index searchLowerIndex (size_t start, size_t end, Index key) const
size_t size () const
void squeeze ()
void swap (CompressedStorage &other)
Scalarvalue (size_t i)
const Scalarvalue (size_t i) const
 ~CompressedStorage ()

Static Public Member Functions

static CompressedStorage Map (Index *indices, Scalar *values, size_t size)

Protected Types

typedef NumTraits< Scalar >::Real RealScalar

Protected Member Functions

void reallocate (size_t size)

Protected Attributes

size_t m_allocatedSize
Indexm_indices
size_t m_size
Scalarm_values

Detailed Description

template<typename _Scalar, typename _Index>
class CompressedStorage< _Scalar, _Index >

Stores a sparse set of values as a list of values and a list of indices.

Definition at line 32 of file CompressedStorage.h.


Member Typedef Documentation

template<typename _Scalar, typename _Index>
typedef _Index CompressedStorage< _Scalar, _Index >::Index

Definition at line 37 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
typedef NumTraits<Scalar>::Real CompressedStorage< _Scalar, _Index >::RealScalar [protected]

Definition at line 41 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
typedef _Scalar CompressedStorage< _Scalar, _Index >::Scalar

Definition at line 36 of file CompressedStorage.h.


Constructor & Destructor Documentation

template<typename _Scalar, typename _Index>
CompressedStorage< _Scalar, _Index >::CompressedStorage ( ) [inline]

Definition at line 45 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
CompressedStorage< _Scalar, _Index >::CompressedStorage ( size_t  size) [inline]

Definition at line 49 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
CompressedStorage< _Scalar, _Index >::CompressedStorage ( const CompressedStorage< _Scalar, _Index > &  other) [inline]

Definition at line 55 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
CompressedStorage< _Scalar, _Index >::~CompressedStorage ( ) [inline]

Definition at line 77 of file CompressedStorage.h.


Member Function Documentation

template<typename _Scalar, typename _Index>
size_t CompressedStorage< _Scalar, _Index >::allocatedSize ( ) const [inline]

Definition at line 112 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::append ( const Scalar v,
Index  i 
) [inline]

Definition at line 103 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Scalar CompressedStorage< _Scalar, _Index >::at ( Index  key,
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 152 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Scalar CompressedStorage< _Scalar, _Index >::atInRange ( size_t  start,
size_t  end,
Index  key,
Scalar  defaultValue = Scalar(0) 
) const [inline]

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

Definition at line 165 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Scalar& CompressedStorage< _Scalar, _Index >::atWithInsertion ( Index  key,
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 180 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::clear ( void  ) [inline]

Definition at line 113 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Index& CompressedStorage< _Scalar, _Index >::index ( size_t  i) [inline]

Definition at line 118 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
const Index& CompressedStorage< _Scalar, _Index >::index ( size_t  i) const [inline]

Definition at line 119 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
static CompressedStorage CompressedStorage< _Scalar, _Index >::Map ( Index indices,
Scalar values,
size_t  size 
) [inline, static]

Definition at line 121 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
CompressedStorage& CompressedStorage< _Scalar, _Index >::operator= ( const CompressedStorage< _Scalar, _Index > &  other) [inline]

Definition at line 61 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::prune ( Scalar  reference,
RealScalar  epsilon = NumTraits<RealScalar>::dummy_precision() 
) [inline]

Definition at line 197 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::reallocate ( size_t  size) [inline, protected]

Definition at line 215 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::reserve ( size_t  size) [inline]

Definition at line 83 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::resize ( size_t  size,
float  reserveSizeFactor = 0 
) [inline]

Definition at line 96 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Index CompressedStorage< _Scalar, _Index >::searchLowerIndex ( Index  key) const [inline]
Returns:
the largest k such that for all j in [0,k) index[j]<key

Definition at line 131 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Index CompressedStorage< _Scalar, _Index >::searchLowerIndex ( size_t  start,
size_t  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 137 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
size_t CompressedStorage< _Scalar, _Index >::size ( ) const [inline]

Definition at line 111 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::squeeze ( ) [inline]

Definition at line 90 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
void CompressedStorage< _Scalar, _Index >::swap ( CompressedStorage< _Scalar, _Index > &  other) [inline]

Definition at line 69 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Scalar& CompressedStorage< _Scalar, _Index >::value ( size_t  i) [inline]

Definition at line 115 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
const Scalar& CompressedStorage< _Scalar, _Index >::value ( size_t  i) const [inline]

Definition at line 116 of file CompressedStorage.h.


Member Data Documentation

template<typename _Scalar, typename _Index>
size_t CompressedStorage< _Scalar, _Index >::m_allocatedSize [protected]

Definition at line 235 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Index* CompressedStorage< _Scalar, _Index >::m_indices [protected]

Definition at line 233 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
size_t CompressedStorage< _Scalar, _Index >::m_size [protected]

Definition at line 234 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>
Scalar* CompressedStorage< _Scalar, _Index >::m_values [protected]

Definition at line 232 of file CompressedStorage.h.


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


libicr
Author(s): Robert Krug
autogenerated on Mon Jan 6 2014 11:34:12