Public Member Functions | List of all members
CompressedStorage< _Scalar, _Index > Class Template Reference

Public Member Functions

Scalar at (Index key, Scalar defaultValue=Scalar(0)) const
 
Scalar atInRange (size_t start, size_t end, Index key, Scalar defaultValue=Scalar(0)) const
 
Scalar & atWithInsertion (Index key, Scalar defaultValue=Scalar(0))
 
Index searchLowerIndex (Index key) const
 
Index searchLowerIndex (size_t start, size_t end, Index key) const
 

Detailed Description

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

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

Member Function Documentation

Scalar 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.
Scalar 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)

Scalar& 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.
Index searchLowerIndex ( Index  key) const
inline
Returns
the largest k such that for all j in [0,k) index[j]<key
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

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