All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
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
_Scalarthe scalar type, i.e. the type of the coefficients
_OptionsUnion of bit flags controlling the storage scheme. Currently the only possibility is RowMajor. The default is 0 which means column-major.
+ Inheritance diagram for SkylineMatrix< _Scalar, _Options >:

Public Member Functions

Index cols () const
const internal::eval
< SkylineMatrix< _Scalar,
_Options >, IsSkyline >::type 
eval () const
void finalize ()
Index innerSize () const
EIGEN_DONT_INLINE Scalar & insert (Index row, Index col)
Index nonZeros () const
Index outerSize () const
void reserve (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize)
void resize (size_t rows, size_t cols)
Index rows () const
void setZero ()
Index size () const
Scalar sum () const
 ~SkylineMatrix ()

Constructor & Destructor Documentation

~SkylineMatrix ( )
inline

Destructor

Member Function Documentation

Index cols ( ) const
inline
const internal::eval<SkylineMatrix< _Scalar, _Options > , IsSkyline>::type eval ( ) const
inlineinherited
Returns
the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

void finalize ( )
inline

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

References SkylineMatrix< _Scalar, _Options >::cols(), and SkylineMatrix< _Scalar, _Options >::rows().

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 > >.

Referenced by SkylineMatrix< _Scalar, _Options >::insert().

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.

References SkylineMatrix< _Scalar, _Options >::cols(), SkylineMatrix< _Scalar, _Options >::innerSize(), SkylineMatrix< _Scalar, _Options >::outerSize(), and SkylineMatrix< _Scalar, _Options >::rows().

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 > >.

Referenced by SkylineMatrix< _Scalar, _Options >::insert().

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

References SkylineMatrix< _Scalar, _Options >::rows().

void setZero ( )
inline

Removes all non zeros

Index size ( ) const
inlineinherited
Returns
the number of coefficients, which is rows()*cols().
See Also
rows(), cols(), SizeAtCompileTime.

References SkylineMatrixBase< Derived >::cols(), and SkylineMatrixBase< Derived >::rows().

Scalar sum ( ) const

Overloaded for performance


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