Eigen::SkylineStorage< Scalar > Class Template Reference

---

Detailed Description

template<typename Scalar>
class Eigen::SkylineStorage< Scalar >

Stores a skyline set of values in three structures : The diagonal elements The upper elements The lower elements.

Definition at line 36 of file Skyline.

List of all members.

Public Member Functions
	SkylineStorage ()
	SkylineStorage (const SkylineStorage &other)
SkylineStorage &	operator= (const SkylineStorage &other)
void	swap (SkylineStorage &other)
	~SkylineStorage ()
void	reserve (Index size, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize)
void	squeeze ()
void	resize (Index diagSize, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize, float reserveSizeFactor=0)
Index	diagSize () const
Index	upperSize () const
Index	lowerSize () const
Index	upperProfileSize () const
Index	lowerProfileSize () const
Index	allocatedSize () const
void	clear ()
Scalar &	diag (Index i)
const Scalar &	diag (Index i) const
Scalar &	upper (Index i)
const Scalar &	upper (Index i) const
Scalar &	lower (Index i)
const Scalar &	lower (Index i) const
Index &	upperProfile (Index i)
const Index &	upperProfile (Index i) const
Index &	lowerProfile (Index i)
const Index &	lowerProfile (Index i) const
void	reset ()
void	prune (Scalar reference, RealScalar epsilon=dummy_precision< RealScalar >())
	SkylineStorage ()
	SkylineStorage (const SkylineStorage &other)
SkylineStorage &	operator= (const SkylineStorage &other)
void	swap (SkylineStorage &other)
	~SkylineStorage ()
void	reserve (Index size, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize)
void	squeeze ()
void	resize (Index diagSize, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize, float reserveSizeFactor=0)
Index	diagSize () const
Index	upperSize () const
Index	lowerSize () const
Index	upperProfileSize () const
Index	lowerProfileSize () const
Index	allocatedSize () const
void	clear ()
Scalar &	diag (Index i)
const Scalar &	diag (Index i) const
Scalar &	upper (Index i)
const Scalar &	upper (Index i) const
Scalar &	lower (Index i)
const Scalar &	lower (Index i) const
Index &	upperProfile (Index i)
const Index &	upperProfile (Index i) const
Index &	lowerProfile (Index i)
const Index &	lowerProfile (Index i) const
void	reset ()
void	prune (Scalar reference, RealScalar epsilon=dummy_precision< RealScalar >())
Static Public Member Functions
static SkylineStorage	Map (Index *upperProfile, Index *lowerProfile, Scalar *diag, Scalar *upper, Scalar *lower, Index size, Index upperSize, Index lowerSize)
static SkylineStorage	Map (Index *upperProfile, Index *lowerProfile, Scalar *diag, Scalar *upper, Scalar *lower, Index size, Index upperSize, Index lowerSize)
Public Attributes
Scalar *	m_diag
Scalar *	m_upper
Scalar *	m_lower
Index *	m_upperProfile
Index *	m_lowerProfile
Index	m_diagSize
Index	m_upperSize
Index	m_lowerSize
Index	m_upperProfileSize
Index	m_lowerProfileSize
Index	m_allocatedSize
Protected Member Functions
void	reallocate (Index diagSize, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize)
void	reallocate (Index diagSize, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize)
Private Types
typedef NumTraits< Scalar >::Real	RealScalar
typedef SparseIndex	Index
typedef NumTraits< Scalar >::Real	RealScalar
typedef SparseIndex	Index

---

Member Typedef Documentation

template<typename Scalar >

typedef SparseIndex Eigen::SkylineStorage< Scalar >::Index [private]

Definition at line 38 of file Skyline.

template<typename Scalar >

typedef SparseIndex Eigen::SkylineStorage< Scalar >::Index [private]

Definition at line 38 of file Skyline.

template<typename Scalar >

typedef NumTraits<Scalar>::Real Eigen::SkylineStorage< Scalar >::RealScalar [private]

Definition at line 37 of file Skyline.

template<typename Scalar >

typedef NumTraits<Scalar>::Real Eigen::SkylineStorage< Scalar >::RealScalar [private]

Definition at line 37 of file Skyline.

---

Constructor & Destructor Documentation

template<typename Scalar >

Eigen::SkylineStorage< Scalar >::SkylineStorage

(

)

[inline]

Definition at line 41 of file Skyline.

template<typename Scalar >

Eigen::SkylineStorage< Scalar >::SkylineStorage

(

const SkylineStorage< Scalar > &

other

)

[inline]

Definition at line 55 of file Skyline.

template<typename Scalar >

Eigen::SkylineStorage< Scalar >::~SkylineStorage

(

)

[inline]

Definition at line 92 of file Skyline.

template<typename Scalar >

Eigen::SkylineStorage< Scalar >::SkylineStorage

(

)

[inline]

Definition at line 41 of file Skyline.

template<typename Scalar >

Eigen::SkylineStorage< Scalar >::SkylineStorage

(

const SkylineStorage< Scalar > &

other

)

[inline]

Definition at line 55 of file Skyline.

template<typename Scalar >

Eigen::SkylineStorage< Scalar >::~SkylineStorage

(

)

[inline]

Definition at line 92 of file Skyline.

---

Member Function Documentation

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::allocatedSize

(

)

const [inline]

Definition at line 142 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::allocatedSize

(

)

const [inline]

Definition at line 142 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::clear

(

void

)

[inline]

Definition at line 146 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::clear

(

void

)

[inline]

Definition at line 146 of file Skyline.

template<typename Scalar >

Scalar& Eigen::SkylineStorage< Scalar >::diag

(

Index

i

)

[inline]

Definition at line 150 of file Skyline.

template<typename Scalar >

const Scalar& Eigen::SkylineStorage< Scalar >::diag

(

Index

i

)

const [inline]

Definition at line 154 of file Skyline.

template<typename Scalar >

Scalar& Eigen::SkylineStorage< Scalar >::diag

(

Index

i

)

[inline]

Definition at line 150 of file Skyline.

template<typename Scalar >

const Scalar& Eigen::SkylineStorage< Scalar >::diag

(

Index

i

)

const [inline]

Definition at line 154 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::diagSize

(

)

const [inline]

Definition at line 122 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::diagSize

(

)

const [inline]

Definition at line 122 of file Skyline.

template<typename Scalar >

Scalar& Eigen::SkylineStorage< Scalar >::lower

(

Index

i

)

[inline]

Definition at line 166 of file Skyline.

template<typename Scalar >

const Scalar& Eigen::SkylineStorage< Scalar >::lower

(

Index

i

)

const [inline]

Definition at line 170 of file Skyline.

template<typename Scalar >

Scalar& Eigen::SkylineStorage< Scalar >::lower

(

Index

i

)

[inline]

Definition at line 166 of file Skyline.

template<typename Scalar >

const Scalar& Eigen::SkylineStorage< Scalar >::lower

(

Index

i

)

const [inline]

Definition at line 170 of file Skyline.

template<typename Scalar >

Index& Eigen::SkylineStorage< Scalar >::lowerProfile

(

Index

i

)

[inline]

Definition at line 182 of file Skyline.

template<typename Scalar >

const Index& Eigen::SkylineStorage< Scalar >::lowerProfile

(

Index

i

)

const [inline]

Definition at line 186 of file Skyline.

template<typename Scalar >

Index& Eigen::SkylineStorage< Scalar >::lowerProfile

(

Index

i

)

[inline]

Definition at line 182 of file Skyline.

template<typename Scalar >

const Index& Eigen::SkylineStorage< Scalar >::lowerProfile

(

Index

i

)

const [inline]

Definition at line 186 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::lowerProfileSize

(

)

const [inline]

Definition at line 138 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::lowerProfileSize

(

)

const [inline]

Definition at line 138 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::lowerSize

(

)

const [inline]

Definition at line 130 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::lowerSize

(

)

const [inline]

Definition at line 130 of file Skyline.

template<typename Scalar >

static SkylineStorage Eigen::SkylineStorage< Scalar >::Map	(	Index *	upperProfile,
		Index *	lowerProfile,
		Scalar *	diag,
		Scalar *	upper,
		Scalar *	lower,
		Index	size,
		Index	upperSize,
		Index	lowerSize
	)		[inline, static]

Definition at line 190 of file Skyline.

template<typename Scalar >

static SkylineStorage Eigen::SkylineStorage< Scalar >::Map	(	Index *	upperProfile,
		Index *	lowerProfile,
		Scalar *	diag,
		Scalar *	upper,
		Scalar *	lower,
		Index	size,
		Index	upperSize,
		Index	lowerSize
	)		[inline, static]

Definition at line 190 of file Skyline.

template<typename Scalar >

SkylineStorage& Eigen::SkylineStorage< Scalar >::operator=

(

const SkylineStorage< Scalar > &

other

)

[inline]

Definition at line 70 of file Skyline.

template<typename Scalar >

SkylineStorage& Eigen::SkylineStorage< Scalar >::operator=

(

const SkylineStorage< Scalar > &

other

)

[inline]

Definition at line 70 of file Skyline.

template<typename Scalar >

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

Definition at line 211 of file Skyline.

template<typename Scalar >

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

Definition at line 211 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::reallocate	(	Index	diagSize,
		Index	upperProfileSize,
		Index	lowerProfileSize,
		Index	upperSize,
		Index	lowerSize
	)		[inline, protected]

Definition at line 217 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::reallocate	(	Index	diagSize,
		Index	upperProfileSize,
		Index	lowerProfileSize,
		Index	upperSize,
		Index	lowerSize
	)		[inline, protected]

Definition at line 217 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::reserve	(	Index	size,
		Index	upperProfileSize,
		Index	lowerProfileSize,
		Index	upperSize,
		Index	lowerSize
	)		[inline]

Definition at line 101 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::reserve	(	Index	size,
		Index	upperProfileSize,
		Index	lowerProfileSize,
		Index	upperSize,
		Index	lowerSize
	)		[inline]

Definition at line 101 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::reset

(

)

[inline]

Definition at line 203 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::reset

(

)

[inline]

Definition at line 203 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::resize	(	Index	diagSize,
		Index	upperProfileSize,
		Index	lowerProfileSize,
		Index	upperSize,
		Index	lowerSize,
		float	reserveSizeFactor = 0
	)		[inline]

Definition at line 112 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::resize	(	Index	diagSize,
		Index	upperProfileSize,
		Index	lowerProfileSize,
		Index	upperSize,
		Index	lowerSize,
		float	reserveSizeFactor = 0
	)		[inline]

Definition at line 112 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::squeeze

(

)

[inline]

Definition at line 107 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::squeeze

(

)

[inline]

Definition at line 107 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::swap

(

SkylineStorage< Scalar > &

other

)

[inline]

Definition at line 80 of file Skyline.

template<typename Scalar >

void Eigen::SkylineStorage< Scalar >::swap

(

SkylineStorage< Scalar > &

other

)

[inline]

Definition at line 80 of file Skyline.

template<typename Scalar >

const Scalar& Eigen::SkylineStorage< Scalar >::upper

(

Index

i

)

const [inline]

Definition at line 162 of file Skyline.

template<typename Scalar >

Scalar& Eigen::SkylineStorage< Scalar >::upper

(

Index

i

)

[inline]

Definition at line 158 of file Skyline.

template<typename Scalar >

const Scalar& Eigen::SkylineStorage< Scalar >::upper

(

Index

i

)

const [inline]

Definition at line 162 of file Skyline.

template<typename Scalar >

Scalar& Eigen::SkylineStorage< Scalar >::upper

(

Index

i

)

[inline]

Definition at line 158 of file Skyline.

template<typename Scalar >

const Index& Eigen::SkylineStorage< Scalar >::upperProfile

(

Index

i

)

const [inline]

Definition at line 178 of file Skyline.

template<typename Scalar >

Index& Eigen::SkylineStorage< Scalar >::upperProfile

(

Index

i

)

[inline]

Definition at line 174 of file Skyline.

template<typename Scalar >

Index& Eigen::SkylineStorage< Scalar >::upperProfile

(

Index

i

)

[inline]

Definition at line 174 of file Skyline.

template<typename Scalar >

const Index& Eigen::SkylineStorage< Scalar >::upperProfile

(

Index

i

)

const [inline]

Definition at line 178 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::upperProfileSize

(

)

const [inline]

Definition at line 134 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::upperProfileSize

(

)

const [inline]

Definition at line 134 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::upperSize

(

)

const [inline]

Definition at line 126 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::upperSize

(

)

const [inline]

Definition at line 126 of file Skyline.

---

Member Data Documentation

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::m_allocatedSize

Definition at line 267 of file Skyline.

template<typename Scalar >

Scalar * Eigen::SkylineStorage< Scalar >::m_diag

Definition at line 257 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::m_diagSize

Definition at line 262 of file Skyline.

template<typename Scalar >

Scalar * Eigen::SkylineStorage< Scalar >::m_lower

Definition at line 259 of file Skyline.

template<typename Scalar >

Index * Eigen::SkylineStorage< Scalar >::m_lowerProfile

Definition at line 261 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::m_lowerProfileSize

Definition at line 266 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::m_lowerSize

Definition at line 264 of file Skyline.

template<typename Scalar >

Scalar * Eigen::SkylineStorage< Scalar >::m_upper

Definition at line 258 of file Skyline.

template<typename Scalar >

Index * Eigen::SkylineStorage< Scalar >::m_upperProfile

Definition at line 260 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::m_upperProfileSize

Definition at line 265 of file Skyline.

template<typename Scalar >

Index Eigen::SkylineStorage< Scalar >::m_upperSize

Definition at line 263 of file Skyline.