Eigen::internal::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, const Scalar &defaultValue=Scalar(0)) const
Scalar	atInRange (size_t start, size_t end, Index key, const Scalar &defaultValue=Scalar(0)) const
Scalar &	atWithInsertion (Index key, const Scalar &defaultValue=Scalar(0))
void	clear ()
	CompressedStorage ()
	CompressedStorage (size_t size)
	CompressedStorage (const CompressedStorage &other)
Index &	index (size_t i)
const Index &	index (size_t i) const
CompressedStorage &	operator= (const CompressedStorage &other)
void	prune (const Scalar &reference, const 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)
Scalar &	value (size_t i)
const Scalar &	value (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
Index *	m_indices
size_t	m_size
Scalar *	m_values

---

Detailed Description

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

Definition at line 22 of file CompressedStorage.h.

---

Member Typedef Documentation

template<typename _Scalar, typename _Index>

typedef _Index Eigen::internal::CompressedStorage< _Scalar, _Index >::Index

Definition at line 27 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

typedef NumTraits<Scalar>::Real Eigen::internal::CompressedStorage< _Scalar, _Index >::RealScalar [protected]

Definition at line 31 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

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

Definition at line 26 of file CompressedStorage.h.

---

Constructor & Destructor Documentation

template<typename _Scalar, typename _Index>

Eigen::internal::CompressedStorage< _Scalar, _Index >::CompressedStorage

(

)

[inline]

Definition at line 35 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Eigen::internal::CompressedStorage< _Scalar, _Index >::CompressedStorage

(

size_t

size

)

[inline]

Definition at line 39 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Eigen::internal::CompressedStorage< _Scalar, _Index >::CompressedStorage

(

const CompressedStorage< _Scalar, _Index > &

other

)

[inline]

Definition at line 45 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Eigen::internal::CompressedStorage< _Scalar, _Index >::~CompressedStorage

(

)

[inline]

Definition at line 67 of file CompressedStorage.h.

---

Member Function Documentation

template<typename _Scalar, typename _Index>

size_t Eigen::internal::CompressedStorage< _Scalar, _Index >::allocatedSize

(

)

const [inline]

Definition at line 102 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

void Eigen::internal::CompressedStorage< _Scalar, _Index >::append	(	const Scalar &	v,
		Index	i
	)		[inline]

Definition at line 93 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Scalar Eigen::internal::CompressedStorage< _Scalar, _Index >::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 142 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Scalar Eigen::internal::CompressedStorage< _Scalar, _Index >::atInRange	(	size_t	start,
		size_t	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 155 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Scalar& Eigen::internal::CompressedStorage< _Scalar, _Index >::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 170 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

void Eigen::internal::CompressedStorage< _Scalar, _Index >::clear

(

)

[inline]

Definition at line 103 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Index& Eigen::internal::CompressedStorage< _Scalar, _Index >::index

(

size_t

i

)

[inline]

Definition at line 108 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

const Index& Eigen::internal::CompressedStorage< _Scalar, _Index >::index

(

size_t

i

)

const [inline]

Definition at line 109 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

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

Definition at line 111 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

CompressedStorage& Eigen::internal::CompressedStorage< _Scalar, _Index >::operator=

(

const CompressedStorage< _Scalar, _Index > &

other

)

[inline]

Definition at line 51 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

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

Definition at line 187 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

void Eigen::internal::CompressedStorage< _Scalar, _Index >::reallocate

(

size_t

size

)

[inline, protected]

Definition at line 205 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

void Eigen::internal::CompressedStorage< _Scalar, _Index >::reserve

(

size_t

size

)

[inline]

Definition at line 73 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

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

Definition at line 86 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Index Eigen::internal::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 121 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Index Eigen::internal::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 127 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

size_t Eigen::internal::CompressedStorage< _Scalar, _Index >::size

(

void

)

const [inline]

Definition at line 101 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

void Eigen::internal::CompressedStorage< _Scalar, _Index >::squeeze

(

)

[inline]

Definition at line 80 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

void Eigen::internal::CompressedStorage< _Scalar, _Index >::swap

(

CompressedStorage< _Scalar, _Index > &

other

)

[inline]

Definition at line 59 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Scalar& Eigen::internal::CompressedStorage< _Scalar, _Index >::value

(

size_t

i

)

[inline]

Definition at line 105 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

const Scalar& Eigen::internal::CompressedStorage< _Scalar, _Index >::value

(

size_t

i

)

const [inline]

Definition at line 106 of file CompressedStorage.h.

---

Member Data Documentation

template<typename _Scalar, typename _Index>

size_t Eigen::internal::CompressedStorage< _Scalar, _Index >::m_allocatedSize [protected]

Definition at line 225 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Index* Eigen::internal::CompressedStorage< _Scalar, _Index >::m_indices [protected]

Definition at line 223 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

size_t Eigen::internal::CompressedStorage< _Scalar, _Index >::m_size [protected]

Definition at line 224 of file CompressedStorage.h.

template<typename _Scalar, typename _Index>

Scalar* Eigen::internal::CompressedStorage< _Scalar, _Index >::m_values [protected]

Definition at line 222 of file CompressedStorage.h.

---

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

• CompressedStorage.h