Public Member Functions | Public Attributes | Protected Types | Protected Attributes | List of all members
SkylineMatrix< _Scalar, _Options > Class Template Reference

The main skyline matrix class. More...

#include <SkylineMatrix.h>

Public Member Functions

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 () const
 
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 (const SkylineMatrix &other)
 
template<typename OtherDerived>
 SkylineMatrix (const SkylineMatrixBase< OtherDerived > &other)
 
 SkylineMatrix (size_t rows, size_t cols)
 
void squeeze ()
 
Scalar sum () const
 
void swap (SkylineMatrix &other)
 
Index upperNonZeros () const
 
Index upperNonZeros (Index j) const
 
 ~SkylineMatrix ()
 
- Public Member Functions inherited from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
void assignGeneric (const OtherDerived &other)
 
Index cols () const
 
const internal::eval< SkylineMatrix< _Scalar, _Options >, IsSkyline >::type eval () const
 
void evalTo (MatrixBase< DenseDerived > &dst) const
 
Index innerSize () const
 
bool isRValue () const
 
SkylineMatrix< _Scalar, _Options > & markAsRValue ()
 
Index nonZeros () const
 
const SkylineProductReturnType< SkylineMatrix< _Scalar, _Options >, OtherDerived >::Type operator* (const MatrixBase< OtherDerived > &other) const
 
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)
 
Index outerSize () const
 
Index rows () const
 
Index size () const
 
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime > toDense () const
 
- Public Member Functions inherited from EigenBase< SkylineMatrix< _Scalar, _Options > >
Index cols () const
 
Derived & derived ()
 
const Derived & derived () const
 
Index rows () const
 
Index size () const
 

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
 
- Protected Attributes inherited from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
bool m_isRValue
 

Additional Inherited Members

- Public Types inherited from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
enum  
 
typedef internal::index< StorageKind >::type Index
 
typedef internal::traits< SkylineMatrix< _Scalar, _Options > >::Scalar Scalar
 
typedef internal::traits< SkylineMatrix< _Scalar, _Options > >::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
_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.

Constructor & Destructor Documentation

◆ ~SkylineMatrix()

template<typename _Scalar, int _Options>
~SkylineMatrix ( )
inline

Destructor

Member Function Documentation

◆ finalize()

template<typename _Scalar, int _Options>
void finalize ( )
inline

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

◆ insert()

template<typename _Scalar, int _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.

◆ nonZeros()

template<typename _Scalar, int _Options>
Index nonZeros ( ) const
inline
Returns
the number of non zero coefficients

◆ reserve()

template<typename _Scalar, int _Options>
void reserve ( Index reserveSize,
Index reserveUpperSize,
Index reserveLowerSize )
inline

Preallocates reserveSize non zeros

◆ resize()

template<typename _Scalar, int _Options>
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()

◆ setZero()

template<typename _Scalar, int _Options>
void setZero ( )
inline

Removes all non zeros

◆ sum()

template<typename _Scalar, int _Options>
Scalar sum ( ) const

Overloaded for performance

The documentation for this class was generated from the following file:
Generated by doxygen 1.13.2