#include <SkylineStorage.h>

Public Member Functions
Index	allocatedSize () const

void	clear ()

Scalar &	diag (Index i)

const Scalar &	diag (Index i) const

Index	diagSize () const

Scalar &	lower (Index i)

const Scalar &	lower (Index i) const

Index &	lowerProfile (Index i)

const Index &	lowerProfile (Index i) const

Index	lowerProfileSize () const

Index	lowerSize () const

SkylineStorage &	operator= (const SkylineStorage &other)

void	prune (Scalar reference, RealScalar epsilon=dummy_precision< RealScalar >())

void	reserve (Index size, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize)

void	reset ()

void	resize (Index diagSize, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize, float reserveSizeFactor=0)

	SkylineStorage ()

	SkylineStorage (const SkylineStorage &other)

void	squeeze ()

void	swap (SkylineStorage &other)

Scalar &	upper (Index i)

const Scalar &	upper (Index i) const

Index &	upperProfile (Index i)

const Index &	upperProfile (Index i) const

Index	upperProfileSize () const

Index	upperSize () const

	~SkylineStorage ()

Static Public Member Functions
static SkylineStorage	Map (Index upperProfile, Index lowerProfile, Scalar diag, Scalar upper, Scalar *lower, Index size, Index upperSize, Index lowerSize)

Public Attributes
Index	m_allocatedSize

Scalar *	m_diag

Index	m_diagSize

Scalar *	m_lower

Index *	m_lowerProfile

Index	m_lowerProfileSize

Index	m_lowerSize

Scalar *	m_upper

Index *	m_upperProfile

Index	m_upperProfileSize

Index	m_upperSize

Protected Member Functions
void	reallocate (Index diagSize, Index upperProfileSize, Index lowerProfileSize, Index upperSize, Index lowerSize)

Private Types
typedef SparseIndex	Index

typedef NumTraits< Scalar >::Real	RealScalar

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 22 of file SkylineStorage.h.

Member Typedef Documentation

◆ Index

template<typename Scalar>

typedef SparseIndex Eigen::SkylineStorage< Scalar >::Index

private

Definition at line 24 of file SkylineStorage.h.

◆ RealScalar

template<typename Scalar>

typedef NumTraits<Scalar>::Real Eigen::SkylineStorage< Scalar >::RealScalar

private

Definition at line 23 of file SkylineStorage.h.

Constructor & Destructor Documentation

◆ SkylineStorage() [1/2]

template<typename Scalar>

Eigen::SkylineStorage< Scalar >::SkylineStorage ( )

inline

Definition at line 27 of file SkylineStorage.h.

◆ SkylineStorage() [2/2]

template<typename Scalar>

Eigen::SkylineStorage< Scalar >::SkylineStorage ( const SkylineStorage< Scalar > & other )

inline

Definition at line 41 of file SkylineStorage.h.

◆ ~SkylineStorage()

template<typename Scalar>

Eigen::SkylineStorage< Scalar >::~SkylineStorage ( )

inline

Definition at line 78 of file SkylineStorage.h.

Member Function Documentation

◆ allocatedSize()

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::allocatedSize ( ) const

inline

Definition at line 128 of file SkylineStorage.h.

◆ clear()

template<typename Scalar>

void Eigen::SkylineStorage< Scalar >::clear ( void )

inline

Definition at line 132 of file SkylineStorage.h.

◆ diag() [1/2]

template<typename Scalar>

Scalar& Eigen::SkylineStorage< Scalar >::diag ( Index i )

inline

Definition at line 136 of file SkylineStorage.h.

◆ diag() [2/2]

template<typename Scalar>

const Scalar& Eigen::SkylineStorage< Scalar >::diag ( Index i ) const

inline

Definition at line 140 of file SkylineStorage.h.

◆ diagSize()

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::diagSize ( ) const

inline

Definition at line 108 of file SkylineStorage.h.

◆ lower() [1/2]

template<typename Scalar>

Scalar& Eigen::SkylineStorage< Scalar >::lower ( Index i )

inline

Definition at line 152 of file SkylineStorage.h.

◆ lower() [2/2]

template<typename Scalar>

const Scalar& Eigen::SkylineStorage< Scalar >::lower ( Index i ) const

inline

Definition at line 156 of file SkylineStorage.h.

◆ lowerProfile() [1/2]

template<typename Scalar>

Index& Eigen::SkylineStorage< Scalar >::lowerProfile ( Index i )

inline

Definition at line 168 of file SkylineStorage.h.

◆ lowerProfile() [2/2]

template<typename Scalar>

const Index& Eigen::SkylineStorage< Scalar >::lowerProfile ( Index i ) const

inline

Definition at line 172 of file SkylineStorage.h.

◆ lowerProfileSize()

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::lowerProfileSize ( ) const

inline

Definition at line 124 of file SkylineStorage.h.

◆ lowerSize()

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::lowerSize ( ) const

inline

Definition at line 116 of file SkylineStorage.h.

◆ Map()

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
	)

inlinestatic

Definition at line 176 of file SkylineStorage.h.

◆ operator=()

template<typename Scalar>

SkylineStorage& Eigen::SkylineStorage< Scalar >::operator= ( const SkylineStorage< Scalar > & other )

inline

Definition at line 56 of file SkylineStorage.h.

◆ prune()

template<typename Scalar>

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

inline

Definition at line 197 of file SkylineStorage.h.

◆ reallocate()

template<typename Scalar>

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

inlineprotected

Definition at line 203 of file SkylineStorage.h.

◆ reserve()

template<typename Scalar>

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

inline

Definition at line 87 of file SkylineStorage.h.

◆ reset()

template<typename Scalar>

void Eigen::SkylineStorage< Scalar >::reset ( )

inline

Definition at line 189 of file SkylineStorage.h.

◆ resize()

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 98 of file SkylineStorage.h.

◆ squeeze()

template<typename Scalar>

void Eigen::SkylineStorage< Scalar >::squeeze ( )

inline

Definition at line 93 of file SkylineStorage.h.

◆ swap()

template<typename Scalar>

void Eigen::SkylineStorage< Scalar >::swap ( SkylineStorage< Scalar > & other )

inline

Definition at line 66 of file SkylineStorage.h.

◆ upper() [1/2]

template<typename Scalar>

Scalar& Eigen::SkylineStorage< Scalar >::upper ( Index i )

inline

Definition at line 144 of file SkylineStorage.h.

◆ upper() [2/2]

template<typename Scalar>

const Scalar& Eigen::SkylineStorage< Scalar >::upper ( Index i ) const

inline

Definition at line 148 of file SkylineStorage.h.

◆ upperProfile() [1/2]

template<typename Scalar>

Index& Eigen::SkylineStorage< Scalar >::upperProfile ( Index i )

inline

Definition at line 160 of file SkylineStorage.h.

◆ upperProfile() [2/2]

template<typename Scalar>

const Index& Eigen::SkylineStorage< Scalar >::upperProfile ( Index i ) const

inline

Definition at line 164 of file SkylineStorage.h.

◆ upperProfileSize()

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::upperProfileSize ( ) const

inline

Definition at line 120 of file SkylineStorage.h.

◆ upperSize()

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::upperSize ( ) const

inline

Definition at line 112 of file SkylineStorage.h.

Member Data Documentation

◆ m_allocatedSize

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::m_allocatedSize

Definition at line 253 of file SkylineStorage.h.

◆ m_diag

template<typename Scalar>

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

Definition at line 243 of file SkylineStorage.h.

◆ m_diagSize

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::m_diagSize

Definition at line 248 of file SkylineStorage.h.

◆ m_lower

template<typename Scalar>

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

Definition at line 245 of file SkylineStorage.h.

◆ m_lowerProfile

template<typename Scalar>

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

Definition at line 247 of file SkylineStorage.h.

◆ m_lowerProfileSize

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::m_lowerProfileSize

Definition at line 252 of file SkylineStorage.h.

◆ m_lowerSize

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::m_lowerSize

Definition at line 250 of file SkylineStorage.h.

◆ m_upper

template<typename Scalar>

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

Definition at line 244 of file SkylineStorage.h.

◆ m_upperProfile

template<typename Scalar>

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

Definition at line 246 of file SkylineStorage.h.

◆ m_upperProfileSize

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::m_upperProfileSize

Definition at line 251 of file SkylineStorage.h.

◆ m_upperSize

template<typename Scalar>

Index Eigen::SkylineStorage< Scalar >::m_upperSize

Definition at line 249 of file SkylineStorage.h.

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

SkylineStorage.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Types

Detailed Description

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

Member Typedef Documentation

◆ Index

◆ RealScalar

Constructor & Destructor Documentation

◆ SkylineStorage() [1/2]

◆ SkylineStorage() [2/2]

◆ ~SkylineStorage()

Member Function Documentation

◆ allocatedSize()

◆ clear()

◆ diag() [1/2]

◆ diag() [2/2]

◆ diagSize()

◆ lower() [1/2]

◆ lower() [2/2]

◆ lowerProfile() [1/2]

◆ lowerProfile() [2/2]

◆ lowerProfileSize()

◆ lowerSize()

◆ Map()

◆ operator=()

◆ prune()

◆ reallocate()

◆ reserve()

◆ reset()

◆ resize()

◆ squeeze()

◆ swap()

◆ upper() [1/2]

◆ upper() [2/2]

◆ upperProfile() [1/2]

◆ upperProfile() [2/2]

◆ upperProfileSize()

◆ upperSize()

Member Data Documentation

◆ m_allocatedSize

◆ m_diag

◆ m_diagSize

◆ m_lower

◆ m_lowerProfile

◆ m_lowerProfileSize

◆ m_lowerSize

◆ m_upper

◆ m_upperProfile

◆ m_upperProfileSize

◆ m_upperSize

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