The main skyline matrix class. More...

#include <SkylineMatrix.h>

Inheritance diagram for Eigen::SkylineMatrix< _Scalar, _Options >:

Classes
class	InnerLowerIterator

class	InnerUpperIterator

Public Member Functions
Index	rows () const

Index	cols () const

Index	innerSize () const

Index	outerSize () const

Index	upperNonZeros () const

Index	lowerNonZeros () const

Index	upperNonZeros (Index j) const

Index	lowerNonZeros (Index j) const

const Scalar *	_diagPtr () const

Scalar *	_diagPtr ()

const Scalar *	_upperPtr () const

Scalar *	_upperPtr ()

const Scalar *	_lowerPtr () const

Scalar *	_lowerPtr ()

const Index *	_upperProfilePtr () const

Index *	_upperProfilePtr ()

const Index *	_lowerProfilePtr () const

Index *	_lowerProfilePtr ()

Scalar	coeff (Index row, Index col) const

Scalar &	coeffRef (Index row, Index col)

Scalar	coeffDiag (Index idx) const

Scalar	coeffLower (Index row, Index col) const

Scalar	coeffUpper (Index row, Index col) const

Scalar &	coeffRefDiag (Index idx)

Scalar &	coeffRefLower (Index row, Index col)

bool	coeffExistLower (Index row, Index col)

Scalar &	coeffRefUpper (Index row, Index col)

bool	coeffExistUpper (Index row, Index col)

void	setZero ()

Index	nonZeros () const

void	reserve (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize)

EIGEN_DONT_INLINE Scalar &	insert (Index row, Index col)

void	finalize ()

void	squeeze ()

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

void	resize (size_t rows, size_t cols)

void	resizeNonZeros (Index size)

	SkylineMatrix ()

	SkylineMatrix (size_t rows, size_t cols)

template<typename OtherDerived >
	SkylineMatrix (const SkylineMatrixBase< OtherDerived > &other)

	SkylineMatrix (const SkylineMatrix &other)

void	swap (SkylineMatrix &other)

SkylineMatrix &	operator= (const SkylineMatrix &other)

template<typename OtherDerived >
SkylineMatrix &	operator= (const SkylineMatrixBase< OtherDerived > &other)

	~SkylineMatrix ()

Scalar	sum () const

Public Member Functions inherited from Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
const SkylineMatrix< _Scalar, _Options > &	derived () const

SkylineMatrix< _Scalar, _Options > &	derived ()

SkylineMatrix< _Scalar, _Options > &	const_cast_derived () const

EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Index	nonZeros () const

Index	outerSize () const

Index	innerSize () const

bool	isRValue () const

SkylineMatrix< _Scalar, _Options > &	markAsRValue ()

	SkylineMatrixBase ()

SkylineMatrix< _Scalar, _Options > &	operator= (const SkylineMatrix< _Scalar, _Options > &other)

SkylineMatrix< _Scalar, _Options > &	operator= (const SkylineMatrixBase< OtherDerived > &other)

SkylineMatrix< _Scalar, _Options > &	operator= (const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &product)

void	assignGeneric (const OtherDerived &other)

const SkylineProductReturnType< SkylineMatrix< _Scalar, _Options >, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const

EIGEN_STRONG_INLINE const SkylineProductReturnType< SkylineMatrix< _Scalar, _Options >, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const

void	evalTo (MatrixBase< DenseDerived > &dst) const

Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () const

EIGEN_STRONG_INLINE const internal::eval< SkylineMatrix< _Scalar, _Options >, IsSkyline >::type	eval () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Public Attributes
Index *	m_colStartIndex

Index *	m_rowStartIndex

SkylineStorage< Scalar >	m_data

Protected Types
typedef SkylineMatrix< Scalar,(Flags &~RowMajorBit)\|(IsRowMajor ? RowMajorBit :0) >	TransposedSkylineMatrix

Protected Attributes
Index	m_outerSize

Index	m_innerSize

Protected Attributes inherited from Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
bool	m_isRValue

Friends
std::ostream &	operator<< (std::ostream &s, const SkylineMatrix &m)

Additional Inherited Members
Public Types inherited from Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
enum

typedef internal::traits< SkylineMatrix< _Scalar, _Options > >::Scalar	Scalar

typedef internal::traits< SkylineMatrix< _Scalar, _Options > >::StorageKind	StorageKind

typedef internal::index< StorageKind >::type	Index

typedef NumTraits< Scalar >::Real	RealScalar

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) >	SquareMatrixType

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices.

typedef internal::traits< Derived >::StorageKind	StorageKind

Detailed Description

template<typename _Scalar, int _Options>
class Eigen::SkylineMatrix< _Scalar, _Options >

The main skyline matrix class.

This class implements a skyline matrix using the very uncommon storage scheme.

Parameters

_Scalar	the scalar type, i.e. the type of the coefficients
_Options	Union of bit flags controlling the storage scheme. Currently the only possibility is RowMajor. The default is 0 which means column-major.

Member Typedef Documentation

◆ TransposedSkylineMatrix

template<typename _Scalar , int _Options>

typedef SkylineMatrix<Scalar, (Flags&~RowMajorBit) | (IsRowMajor ? RowMajorBit : 0) > Eigen::SkylineMatrix< _Scalar, _Options >::TransposedSkylineMatrix

protected

Constructor & Destructor Documentation

◆ SkylineMatrix() [1/4]

template<typename _Scalar , int _Options>

Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( )

inline

◆ SkylineMatrix() [2/4]

template<typename _Scalar , int _Options>

Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix	(	size_t	rows,
		size_t	cols
	)

inline

◆ SkylineMatrix() [3/4]

template<typename _Scalar , int _Options>

template<typename OtherDerived >

Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( const SkylineMatrixBase< OtherDerived > & other )

inline

◆ SkylineMatrix() [4/4]

template<typename _Scalar , int _Options>

Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( const SkylineMatrix< _Scalar, _Options > & other )

inline

◆ ~SkylineMatrix()

template<typename _Scalar , int _Options>

Eigen::SkylineMatrix< _Scalar, _Options >::~SkylineMatrix ( )

inline

Destructor

Member Function Documentation

◆ _diagPtr() [1/2]

template<typename _Scalar , int _Options>

Scalar * Eigen::SkylineMatrix< _Scalar, _Options >::_diagPtr ( )

inline

◆ _diagPtr() [2/2]

template<typename _Scalar , int _Options>

const Scalar * Eigen::SkylineMatrix< _Scalar, _Options >::_diagPtr ( ) const

inline

◆ _lowerProfilePtr() [1/2]

template<typename _Scalar , int _Options>

Index * Eigen::SkylineMatrix< _Scalar, _Options >::_lowerProfilePtr ( )

inline

◆ _lowerProfilePtr() [2/2]

template<typename _Scalar , int _Options>

const Index * Eigen::SkylineMatrix< _Scalar, _Options >::_lowerProfilePtr ( ) const

inline

◆ _lowerPtr() [1/2]

template<typename _Scalar , int _Options>

Scalar * Eigen::SkylineMatrix< _Scalar, _Options >::_lowerPtr ( )

inline

◆ _lowerPtr() [2/2]

template<typename _Scalar , int _Options>

const Scalar * Eigen::SkylineMatrix< _Scalar, _Options >::_lowerPtr ( ) const

inline

◆ _upperProfilePtr() [1/2]

template<typename _Scalar , int _Options>

Index * Eigen::SkylineMatrix< _Scalar, _Options >::_upperProfilePtr ( )

inline

◆ _upperProfilePtr() [2/2]

template<typename _Scalar , int _Options>

const Index * Eigen::SkylineMatrix< _Scalar, _Options >::_upperProfilePtr ( ) const

inline

◆ _upperPtr() [1/2]

template<typename _Scalar , int _Options>

Scalar * Eigen::SkylineMatrix< _Scalar, _Options >::_upperPtr ( )

inline

◆ _upperPtr() [2/2]

template<typename _Scalar , int _Options>

const Scalar * Eigen::SkylineMatrix< _Scalar, _Options >::_upperPtr ( ) const

inline

◆ coeff()

template<typename _Scalar , int _Options>

Scalar Eigen::SkylineMatrix< _Scalar, _Options >::coeff	(	Index	row,
		Index	col
	)		const

inline

◆ coeffDiag()

template<typename _Scalar , int _Options>

Scalar Eigen::SkylineMatrix< _Scalar, _Options >::coeffDiag ( Index idx ) const

inline

◆ coeffExistLower()

template<typename _Scalar , int _Options>

bool Eigen::SkylineMatrix< _Scalar, _Options >::coeffExistLower	(	Index	row,
		Index	col
	)

inline

◆ coeffExistUpper()

template<typename _Scalar , int _Options>

bool Eigen::SkylineMatrix< _Scalar, _Options >::coeffExistUpper	(	Index	row,
		Index	col
	)

inline

◆ coeffLower()

template<typename _Scalar , int _Options>

Scalar Eigen::SkylineMatrix< _Scalar, _Options >::coeffLower	(	Index	row,
		Index	col
	)		const

inline

◆ coeffRef()

template<typename _Scalar , int _Options>

Scalar & Eigen::SkylineMatrix< _Scalar, _Options >::coeffRef	(	Index	row,
		Index	col
	)

inline

◆ coeffRefDiag()

template<typename _Scalar , int _Options>

Scalar & Eigen::SkylineMatrix< _Scalar, _Options >::coeffRefDiag ( Index idx )

inline

◆ coeffRefLower()

template<typename _Scalar , int _Options>

Scalar & Eigen::SkylineMatrix< _Scalar, _Options >::coeffRefLower	(	Index	row,
		Index	col
	)

inline

◆ coeffRefUpper()

template<typename _Scalar , int _Options>

Scalar & Eigen::SkylineMatrix< _Scalar, _Options >::coeffRefUpper	(	Index	row,
		Index	col
	)

inline

◆ coeffUpper()

template<typename _Scalar , int _Options>

Scalar Eigen::SkylineMatrix< _Scalar, _Options >::coeffUpper	(	Index	row,
		Index	col
	)		const

inline

◆ cols()

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::cols ( ) const

inline

◆ finalize()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::finalize ( )

inline

Must be called after inserting a set of non zero entries.

◆ innerSize()

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::innerSize ( ) const

inline

◆ insert()

template<typename _Scalar , int _Options>

EIGEN_DONT_INLINE Scalar & Eigen::SkylineMatrix< _Scalar, _Options >::insert	(	Index	row,
		Index	col
	)

inline

Returns: a reference to a novel non zero coefficient with coordinates row x col.

Warning: This function can be extremely slow if the non zero coefficients are not inserted in a coherent order.

After an insertion session, you should call the finalize() function.

◆ lowerNonZeros() [1/2]

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::lowerNonZeros ( ) const

inline

◆ lowerNonZeros() [2/2]

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::lowerNonZeros ( Index j ) const

inline

◆ nonZeros()

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::nonZeros ( ) const

inline

Returns: the number of non zero coefficients

◆ operator=() [1/2]

template<typename _Scalar , int _Options>

SkylineMatrix & Eigen::SkylineMatrix< _Scalar, _Options >::operator= ( const SkylineMatrix< _Scalar, _Options > & other )

inline

◆ operator=() [2/2]

template<typename _Scalar , int _Options>

template<typename OtherDerived >

SkylineMatrix & Eigen::SkylineMatrix< _Scalar, _Options >::operator= ( const SkylineMatrixBase< OtherDerived > & other )

inline

◆ outerSize()

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::outerSize ( ) const

inline

◆ prune()

template<typename _Scalar , int _Options>

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

inline

◆ reserve()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::reserve	(	Index	reserveSize,
		Index	reserveUpperSize,
		Index	reserveLowerSize
	)

inline

Preallocates reserveSize non zeros

◆ resize()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::resize	(	size_t	rows,
		size_t	cols
	)

inline

Resizes the matrix to a rows x cols matrix and initializes it to zero

See also: resizeNonZeros(Index), reserve(), setZero()

◆ resizeNonZeros()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::resizeNonZeros ( Index size )

inline

◆ rows()

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::rows ( ) const

inline

◆ setZero()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::setZero ( )

inline

Removes all non zeros

◆ squeeze()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::squeeze ( )

inline

◆ sum()

template<typename _Scalar , int _Options>

Scalar Eigen::SkylineMatrix< _Scalar, _Options >::sum ( ) const

Overloaded for performance

◆ swap()

template<typename _Scalar , int _Options>

void Eigen::SkylineMatrix< _Scalar, _Options >::swap ( SkylineMatrix< _Scalar, _Options > & other )

inline

◆ upperNonZeros() [1/2]

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::upperNonZeros ( ) const

inline

◆ upperNonZeros() [2/2]

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::upperNonZeros ( Index j ) const

inline

Friends And Related Symbol Documentation

◆ operator<<

template<typename _Scalar , int _Options>

std::ostream & operator<<	(	std::ostream &	s,
		const SkylineMatrix< _Scalar, _Options > &	m
	)

friend

Member Data Documentation

◆ m_colStartIndex

template<typename _Scalar , int _Options>

Index* Eigen::SkylineMatrix< _Scalar, _Options >::m_colStartIndex

◆ m_data

template<typename _Scalar , int _Options>

SkylineStorage<Scalar> Eigen::SkylineMatrix< _Scalar, _Options >::m_data

◆ m_innerSize

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::m_innerSize

protected

◆ m_outerSize

template<typename _Scalar , int _Options>

Index Eigen::SkylineMatrix< _Scalar, _Options >::m_outerSize

protected

◆ m_rowStartIndex

template<typename _Scalar , int _Options>

Index* Eigen::SkylineMatrix< _Scalar, _Options >::m_rowStartIndex

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

core/util/algorithms/eigen-3.4.0/unsupported/Eigen/src/Skyline/SkylineMatrix.h

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TransposedSkylineMatrix

Constructor & Destructor Documentation

◆ SkylineMatrix() [1/4]

◆ SkylineMatrix() [2/4]

◆ SkylineMatrix() [3/4]

◆ SkylineMatrix() [4/4]

◆ ~SkylineMatrix()

Member Function Documentation

◆ _diagPtr() [1/2]

◆ _diagPtr() [2/2]

◆ _lowerProfilePtr() [1/2]

◆ _lowerProfilePtr() [2/2]

◆ _lowerPtr() [1/2]

◆ _lowerPtr() [2/2]

◆ _upperProfilePtr() [1/2]

◆ _upperProfilePtr() [2/2]

◆ _upperPtr() [1/2]

◆ _upperPtr() [2/2]

◆ coeff()

◆ coeffDiag()

◆ coeffExistLower()

◆ coeffExistUpper()

◆ coeffLower()

◆ coeffRef()

◆ coeffRefDiag()

◆ coeffRefLower()

◆ coeffRefUpper()

◆ coeffUpper()

◆ cols()

◆ finalize()

◆ innerSize()

◆ insert()

◆ lowerNonZeros() [1/2]

◆ lowerNonZeros() [2/2]

◆ nonZeros()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ outerSize()

◆ prune()

◆ reserve()

◆ resize()

◆ resizeNonZeros()

◆ rows()

◆ setZero()

◆ squeeze()

◆ sum()

◆ swap()

◆ upperNonZeros() [1/2]

◆ upperNonZeros() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_colStartIndex

◆ m_data

◆ m_innerSize

◆ m_outerSize

◆ m_rowStartIndex