Eigen::SkylineMatrix< Scalar_, Options_ > Class Template Reference

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.

Inheritance diagram for Eigen::SkylineMatrix< Scalar_, Options_ >:

Public Member Functions
void	finalize ()
EIGEN_DONT_INLINE Scalar &	insert (Index row, Index col)
Index	nonZeros () const
void	reserve (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize)
void	resize (size_t rows, size_t cols)
void	setZero ()
Scalar	sum () const
	~SkylineMatrix ()
Public Member Functions inherited from Eigen::SkylineMatrixBase< SkylineMatrix< Scalar_, Options_ > >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
const internal::eval< SkylineMatrix< Scalar_, Options_ >, IsSkyline >::type	eval () const
Index	innerSize () const
Index	nonZeros () const
Index	outerSize () const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Additional Inherited Members

Constructor & Destructor Documentation

~SkylineMatrix()

template<typename Scalar_ , int Options_>

Eigen::SkylineMatrix< Scalar_, Options_ >::~SkylineMatrix ( )

inline

Destructor

Member Function Documentation

finalize()

template<typename Scalar_ , int Options_>

void Eigen::SkylineMatrix< Scalar_, Options_ >::finalize ( )

inline

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

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.

nonZeros()

template<typename Scalar_ , int Options_>

Index Eigen::SkylineMatrix< Scalar_, Options_ >::nonZeros ( ) const

inline

Returns

the number of non zero coefficients

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

setZero()

template<typename Scalar_ , int Options_>

void Eigen::SkylineMatrix< Scalar_, Options_ >::setZero ( )

inline

Removes all non zeros

sum()

template<typename Scalar_ , int Options_>

Scalar Eigen::SkylineMatrix< Scalar_, Options_ >::sum

(

)

const

Overloaded for performance

---

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

• SkylineMatrix.h