Eigen::CompressedStorage Class Reference

---

Detailed Description

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

Inheritance diagram for Eigen::CompressedStorage:

List of all members.

Public Types
typedef _Scalar	Scalar
typedef _Index	Index
Public Member Functions
	CompressedStorage ()
	CompressedStorage (size_t size)
	CompressedStorage (const CompressedStorage &other)
CompressedStorage &	operator= (const CompressedStorage &other)
void	swap (CompressedStorage &other)
	~CompressedStorage ()
void	reserve (size_t size)
void	squeeze ()
void	resize (size_t size, float reserveSizeFactor=0)
void	append (const Scalar &v, Index i)
size_t	size () const
size_t	allocatedSize () const
void	clear ()
Scalar &	value (size_t i)
const Scalar &	value (size_t i) const
Index &	index (size_t i)
const Index &	index (size_t i) const
Index	searchLowerIndex (Index key) const
Index	searchLowerIndex (size_t start, size_t end, Index key) const
Scalar	at (Index key, Scalar defaultValue=Scalar(0)) const
Scalar	atInRange (size_t start, size_t end, Index key, Scalar defaultValue=Scalar(0)) const
	Like at(), but the search is performed in the range [start,end)
Scalar &	atWithInsertion (Index key, Scalar defaultValue=Scalar(0))
void	prune (Scalar reference, RealScalar epsilon=NumTraits< RealScalar >::dummy_precision())
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
Scalar *	m_values
Index *	m_indices
size_t	m_size
size_t	m_allocatedSize

---

Member Typedef Documentation

typedef _Index Eigen::CompressedStorage::Index

Definition at line 38 of file Sparse.

typedef NumTraits<Scalar>::Real Eigen::CompressedStorage::RealScalar [protected]

Definition at line 42 of file Sparse.

typedef _Scalar Eigen::CompressedStorage::Scalar

Definition at line 37 of file Sparse.

---

Constructor & Destructor Documentation

Eigen::CompressedStorage::CompressedStorage

(

)

[inline]

Definition at line 46 of file Sparse.

Eigen::CompressedStorage::CompressedStorage

(

size_t

size

)

[inline]

Definition at line 50 of file Sparse.

Eigen::CompressedStorage::CompressedStorage

(

const CompressedStorage &

other

)

[inline]

Definition at line 56 of file Sparse.

Eigen::CompressedStorage::~CompressedStorage

(

)

[inline]

Definition at line 78 of file Sparse.

---

Member Function Documentation

size_t Eigen::CompressedStorage::allocatedSize

(

)

const [inline]

Definition at line 113 of file Sparse.

void Eigen::CompressedStorage::append	(	const Scalar &	v,
		Index	i
	)		[inline]

Definition at line 104 of file Sparse.

Scalar Eigen::CompressedStorage::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 153 of file Sparse.

Scalar Eigen::CompressedStorage::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 166 of file Sparse.

Scalar& Eigen::CompressedStorage::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 181 of file Sparse.

void Eigen::CompressedStorage::clear

(

void

)

[inline]

Definition at line 114 of file Sparse.

Index& Eigen::CompressedStorage::index

(

size_t

i

)

[inline]

Definition at line 119 of file Sparse.

const Index& Eigen::CompressedStorage::index

(

size_t

i

)

const [inline]

Definition at line 120 of file Sparse.

static CompressedStorage Eigen::CompressedStorage::Map	(	Index *	indices,
		Scalar *	values,
		size_t	size
	)		[inline, static]

Definition at line 122 of file Sparse.

CompressedStorage& Eigen::CompressedStorage::operator=

(

const CompressedStorage &

other

)

[inline]

Definition at line 62 of file Sparse.

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

Definition at line 198 of file Sparse.

void Eigen::CompressedStorage::reallocate

(

size_t

size

)

[inline, protected]

Definition at line 216 of file Sparse.

void Eigen::CompressedStorage::reserve

(

size_t

size

)

[inline]

Definition at line 84 of file Sparse.

void Eigen::CompressedStorage::resize	(	size_t	size,
		float	reserveSizeFactor = 0
	)		[inline]

Definition at line 97 of file Sparse.

Index Eigen::CompressedStorage::searchLowerIndex

(

Index

key

)

const [inline]

Returns:

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

Definition at line 132 of file Sparse.

Index Eigen::CompressedStorage::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 138 of file Sparse.

size_t Eigen::CompressedStorage::size

(

)

const [inline]

Definition at line 112 of file Sparse.

void Eigen::CompressedStorage::squeeze

(

)

[inline]

Definition at line 91 of file Sparse.

void Eigen::CompressedStorage::swap

(

CompressedStorage &

other

)

[inline]

Definition at line 70 of file Sparse.

Scalar& Eigen::CompressedStorage::value

(

size_t

i

)

[inline]

Definition at line 116 of file Sparse.

const Scalar& Eigen::CompressedStorage::value

(

size_t

i

)

const [inline]

Definition at line 117 of file Sparse.

---

Member Data Documentation

size_t Eigen::CompressedStorage::m_allocatedSize [protected]

Definition at line 236 of file Sparse.

Index* Eigen::CompressedStorage::m_indices [protected]

Definition at line 234 of file Sparse.

size_t Eigen::CompressedStorage::m_size [protected]

Definition at line 235 of file Sparse.

Scalar* Eigen::CompressedStorage::m_values [protected]

Definition at line 233 of file Sparse.