SkylineMatrix< _Scalar, _Options > Class Template Reference

The main skyline matrix class. More...

List of all members.

Public Member Functions
const Scalar *	_diagPtr () const
Scalar *	_diagPtr ()
const Index *	_lowerProfilePtr () const
Index *	_lowerProfilePtr ()
const Scalar *	_lowerPtr () const
Scalar *	_lowerPtr ()
const Index *	_upperProfilePtr () const
Index *	_upperProfilePtr ()
const Scalar *	_upperPtr () const
Scalar *	_upperPtr ()
Scalar	coeff (Index row, Index col) const
Scalar	coeffDiag (Index idx) const
bool	coeffExistLower (Index row, Index col)
bool	coeffExistUpper (Index row, Index col)
Scalar	coeffLower (Index row, Index col) const
Scalar &	coeffRef (Index row, Index col)
Scalar &	coeffRefDiag (Index idx)
Scalar &	coeffRefLower (Index row, Index col)
Scalar &	coeffRefUpper (Index row, Index col)
Scalar	coeffUpper (Index row, Index col) const
Index	cols () const
void	finalize ()
Index	innerSize () const
EIGEN_DONT_INLINE Scalar &	insert (Index row, Index col)
Index	lowerNonZeros () const
Index	lowerNonZeros (Index j) const
Index	nonZeros () const
SkylineMatrix &	operator= (const SkylineMatrix &other)
template<typename OtherDerived >
SkylineMatrix &	operator= (const SkylineMatrixBase< OtherDerived > &other)
Index	outerSize () const
void	prune (Scalar reference, RealScalar epsilon=dummy_precision< RealScalar >())
void	reserve (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize)
void	resize (size_t rows, size_t cols)
void	resizeNonZeros (Index size)
Index	rows () const
void	setZero ()
	SkylineMatrix (size_t rows, size_t cols)
template<typename OtherDerived >
	SkylineMatrix (const SkylineMatrixBase< OtherDerived > &other)
	SkylineMatrix (const SkylineMatrix &other)
void	squeeze ()
Scalar	sum () const
void	swap (SkylineMatrix &other)
Index	upperNonZeros () const
Index	upperNonZeros (Index j) const
	~SkylineMatrix ()
Public Attributes
Index *	m_colStartIndex
SkylineStorage< Scalar >	m_data
Index *	m_rowStartIndex
Protected Types
typedef SkylineMatrix< Scalar,(Flags &~RowMajorBit)|(IsRowMajor?RowMajorBit:0) >	TransposedSkylineMatrix
Protected Attributes
Index	m_innerSize
Index	m_outerSize
Friends
std::ostream &	operator<< (std::ostream &s, const SkylineMatrix &m)

---

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.

---

Constructor & Destructor Documentation

~SkylineMatrix

(

)

[inline]

Destructor

---

Member Function Documentation

Index cols

(

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

void finalize

(

)

[inline]

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

Index innerSize

(

)

const [inline]

Returns:

the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

EIGEN_DONT_INLINE Scalar& 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.

Index nonZeros

(

)

const [inline]

Returns:

the number of non zero coefficients

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Index outerSize

(

)

const [inline]

Returns:

the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

void reserve	(	Index	reserveSize,
		Index	reserveUpperSize,
		Index	reserveLowerSize
	)		[inline]

Preallocates reserveSize non zeros

void 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()

Index rows

(

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

void setZero

(

)

[inline]

Removes all non zeros

Scalar sum

(

)

const

Overloaded for performance

---

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