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

The main skyline matrix class. More...

#include <SkylineMatrix.h>

Inheritance diagram for Eigen::SkylineMatrix< _Scalar, _Options >:
Inheritance graph
[legend]

Classes

class  InnerLowerIterator
 
class  InnerUpperIterator
 

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
 
ScalarcoeffRef (Index row, Index col)
 
ScalarcoeffRefDiag (Index idx)
 
ScalarcoeffRefLower (Index row, Index col)
 
ScalarcoeffRefUpper (Index row, Index col)
 
Scalar coeffUpper (Index row, Index col) const
 
Index cols () const
 
void finalize ()
 
Index innerSize () const
 
EIGEN_DONT_INLINE Scalarinsert (Index row, Index col)
 
Index lowerNonZeros () const
 
Index lowerNonZeros (Index j) const
 
Index nonZeros () const
 
SkylineMatrixoperator= (const SkylineMatrix &other)
 
template<typename OtherDerived >
SkylineMatrixoperator= (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 ()
 
 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 Member Functions inherited from Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >
void assignGeneric (const OtherDerived &other)
 
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
SkylineMatrix< _Scalar, _Options > & const_cast_derived () const
 
const SkylineMatrix< _Scalar, _Options > & derived () const
 
SkylineMatrix< _Scalar, _Options > & derived ()
 
EIGEN_STRONG_INLINE 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
 
EIGEN_STRONG_INLINE 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
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
 SkylineMatrixBase ()
 
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimetoDense () const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & const_derived () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
template<typename Dest >
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 

Public Attributes

Indexm_colStartIndex
 
SkylineStorage< Scalarm_data
 
Indexm_rowStartIndex
 

Protected Types

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

Protected Attributes

Index m_innerSize
 
Index m_outerSize
 
- 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::index< StorageKind >::type Index
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef internal::traits< SkylineMatrix< _Scalar, _Options > >::Scalar Scalar
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) > SquareMatrixType
 
typedef internal::traits< SkylineMatrix< _Scalar, _Options > >::StorageKind StorageKind
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
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
_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.

Definition at line 51 of file SkylineMatrix.h.

Member Typedef Documentation

◆ TransposedSkylineMatrix

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

Definition at line 62 of file SkylineMatrix.h.

Constructor & Destructor Documentation

◆ SkylineMatrix() [1/4]

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

Definition at line 630 of file SkylineMatrix.h.

◆ SkylineMatrix() [2/4]

template<typename _Scalar , int _Options>
Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( size_t  rows,
size_t  cols 
)
inline

Definition at line 635 of file SkylineMatrix.h.

◆ SkylineMatrix() [3/4]

template<typename _Scalar , int _Options>
template<typename OtherDerived >
Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( const SkylineMatrixBase< OtherDerived > &  other)
inline

Definition at line 641 of file SkylineMatrix.h.

◆ SkylineMatrix() [4/4]

template<typename _Scalar , int _Options>
Eigen::SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( const SkylineMatrix< _Scalar, _Options > &  other)
inline

Definition at line 646 of file SkylineMatrix.h.

◆ ~SkylineMatrix()

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

Destructor

Definition at line 725 of file SkylineMatrix.h.

Member Function Documentation

◆ _diagPtr() [1/2]

template<typename _Scalar , int _Options>
const Scalar* Eigen::SkylineMatrix< _Scalar, _Options >::_diagPtr ( ) const
inline

Definition at line 106 of file SkylineMatrix.h.

◆ _diagPtr() [2/2]

template<typename _Scalar , int _Options>
Scalar* Eigen::SkylineMatrix< _Scalar, _Options >::_diagPtr ( )
inline

Definition at line 110 of file SkylineMatrix.h.

◆ _lowerProfilePtr() [1/2]

template<typename _Scalar , int _Options>
const Index* Eigen::SkylineMatrix< _Scalar, _Options >::_lowerProfilePtr ( ) const
inline

Definition at line 138 of file SkylineMatrix.h.

◆ _lowerProfilePtr() [2/2]

template<typename _Scalar , int _Options>
Index* Eigen::SkylineMatrix< _Scalar, _Options >::_lowerProfilePtr ( )
inline

Definition at line 142 of file SkylineMatrix.h.

◆ _lowerPtr() [1/2]

template<typename _Scalar , int _Options>
const Scalar* Eigen::SkylineMatrix< _Scalar, _Options >::_lowerPtr ( ) const
inline

Definition at line 122 of file SkylineMatrix.h.

◆ _lowerPtr() [2/2]

template<typename _Scalar , int _Options>
Scalar* Eigen::SkylineMatrix< _Scalar, _Options >::_lowerPtr ( )
inline

Definition at line 126 of file SkylineMatrix.h.

◆ _upperProfilePtr() [1/2]

template<typename _Scalar , int _Options>
const Index* Eigen::SkylineMatrix< _Scalar, _Options >::_upperProfilePtr ( ) const
inline

Definition at line 130 of file SkylineMatrix.h.

◆ _upperProfilePtr() [2/2]

template<typename _Scalar , int _Options>
Index* Eigen::SkylineMatrix< _Scalar, _Options >::_upperProfilePtr ( )
inline

Definition at line 134 of file SkylineMatrix.h.

◆ _upperPtr() [1/2]

template<typename _Scalar , int _Options>
const Scalar* Eigen::SkylineMatrix< _Scalar, _Options >::_upperPtr ( ) const
inline

Definition at line 114 of file SkylineMatrix.h.

◆ _upperPtr() [2/2]

template<typename _Scalar , int _Options>
Scalar* Eigen::SkylineMatrix< _Scalar, _Options >::_upperPtr ( )
inline

Definition at line 118 of file SkylineMatrix.h.

◆ coeff()

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

Definition at line 146 of file SkylineMatrix.h.

◆ coeffDiag()

template<typename _Scalar , int _Options>
Scalar Eigen::SkylineMatrix< _Scalar, _Options >::coeffDiag ( Index  idx) const
inline

Definition at line 234 of file SkylineMatrix.h.

◆ coeffExistLower()

template<typename _Scalar , int _Options>
bool Eigen::SkylineMatrix< _Scalar, _Options >::coeffExistLower ( Index  row,
Index  col 
)
inline

Definition at line 312 of file SkylineMatrix.h.

◆ coeffExistUpper()

template<typename _Scalar , int _Options>
bool Eigen::SkylineMatrix< _Scalar, _Options >::coeffExistUpper ( Index  row,
Index  col 
)
inline

Definition at line 348 of file SkylineMatrix.h.

◆ coeffLower()

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

Definition at line 240 of file SkylineMatrix.h.

◆ coeffRef()

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

Definition at line 195 of file SkylineMatrix.h.

◆ coeffRefDiag()

template<typename _Scalar , int _Options>
Scalar& Eigen::SkylineMatrix< _Scalar, _Options >::coeffRefDiag ( Index  idx)
inline

Definition at line 287 of file SkylineMatrix.h.

◆ coeffRefLower()

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

Definition at line 293 of file SkylineMatrix.h.

◆ coeffRefUpper()

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

Definition at line 329 of file SkylineMatrix.h.

◆ coeffUpper()

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

Definition at line 264 of file SkylineMatrix.h.

◆ cols()

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::cols ( void  ) const
inline

Definition at line 78 of file SkylineMatrix.h.

◆ finalize()

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

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

Definition at line 534 of file SkylineMatrix.h.

◆ innerSize()

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::innerSize ( ) const
inline

Definition at line 82 of file SkylineMatrix.h.

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

Definition at line 400 of file SkylineMatrix.h.

◆ lowerNonZeros() [1/2]

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::lowerNonZeros ( ) const
inline

Definition at line 94 of file SkylineMatrix.h.

◆ lowerNonZeros() [2/2]

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::lowerNonZeros ( Index  j) const
inline

Definition at line 102 of file SkylineMatrix.h.

◆ nonZeros()

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

Definition at line 383 of file SkylineMatrix.h.

◆ operator=() [1/2]

template<typename _Scalar , int _Options>
SkylineMatrix& Eigen::SkylineMatrix< _Scalar, _Options >::operator= ( const SkylineMatrix< _Scalar, _Options > &  other)
inline

Definition at line 660 of file SkylineMatrix.h.

◆ operator=() [2/2]

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

Definition at line 674 of file SkylineMatrix.h.

◆ outerSize()

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::outerSize ( ) const
inline

Definition at line 86 of file SkylineMatrix.h.

◆ prune()

template<typename _Scalar , int _Options>
void Eigen::SkylineMatrix< _Scalar, _Options >::prune ( Scalar  reference,
RealScalar  epsilon = dummy_precision<RealScalar > () 
)
inline

Definition at line 582 of file SkylineMatrix.h.

◆ reserve()

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

Preallocates reserveSize non zeros

Definition at line 388 of file SkylineMatrix.h.

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

Definition at line 589 of file SkylineMatrix.h.

◆ resizeNonZeros()

template<typename _Scalar , int _Options>
void Eigen::SkylineMatrix< _Scalar, _Options >::resizeNonZeros ( Index  size)
inline

Definition at line 626 of file SkylineMatrix.h.

◆ rows()

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::rows ( void  ) const
inline

Definition at line 74 of file SkylineMatrix.h.

◆ setZero()

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

Removes all non zeros

Definition at line 376 of file SkylineMatrix.h.

◆ squeeze()

template<typename _Scalar , int _Options>
void Eigen::SkylineMatrix< _Scalar, _Options >::squeeze ( )
inline

Definition at line 577 of file SkylineMatrix.h.

◆ 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

Definition at line 651 of file SkylineMatrix.h.

◆ upperNonZeros() [1/2]

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::upperNonZeros ( ) const
inline

Definition at line 90 of file SkylineMatrix.h.

◆ upperNonZeros() [2/2]

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::upperNonZeros ( Index  j) const
inline

Definition at line 98 of file SkylineMatrix.h.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 685 of file SkylineMatrix.h.

Member Data Documentation

◆ m_colStartIndex

template<typename _Scalar , int _Options>
Index* Eigen::SkylineMatrix< _Scalar, _Options >::m_colStartIndex

Definition at line 68 of file SkylineMatrix.h.

◆ m_data

template<typename _Scalar , int _Options>
SkylineStorage<Scalar> Eigen::SkylineMatrix< _Scalar, _Options >::m_data

Definition at line 70 of file SkylineMatrix.h.

◆ m_innerSize

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::m_innerSize
protected

Definition at line 65 of file SkylineMatrix.h.

◆ m_outerSize

template<typename _Scalar , int _Options>
Index Eigen::SkylineMatrix< _Scalar, _Options >::m_outerSize
protected

Definition at line 64 of file SkylineMatrix.h.

◆ m_rowStartIndex

template<typename _Scalar , int _Options>
Index* Eigen::SkylineMatrix< _Scalar, _Options >::m_rowStartIndex

Definition at line 69 of file SkylineMatrix.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:43:13