Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > Class Template Reference

Represents a rectangular matrix with a banded storage. More...

#include <BandMatrix.h>

Inheritance diagram for Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >:
Inheritance graph
[legend]

Public Types

typedef internal::traits< BandMatrix >::CoefficientsType CoefficientsType
 
typedef internal::traits< BandMatrix >::Scalar Scalar
 
typedef internal::traits< BandMatrix >::StorageIndex StorageIndex
 
- Public Types inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
enum  
 
typedef EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > > Base
 
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::CoefficientsType CoefficientsType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::Scalar Scalar
 
typedef DenseMatrixType::StorageIndex StorageIndex
 
- Public Types inherited from Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::StorageKind StorageKind
 

Public Member Functions

 BandMatrix (Index rows=Rows, Index cols=Cols, Index supers=Supers, Index subs=Subs)
 
const CoefficientsTypecoeffs () const
 
CoefficientsTypecoeffs ()
 
EIGEN_CONSTEXPR Index cols () const
 
EIGEN_CONSTEXPR Index rows () const
 
EIGEN_CONSTEXPR Index subs () const
 
EIGEN_CONSTEXPR Index supers () const
 
- Public Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
const CoefficientsTypecoeffs () const
 
CoefficientsTypecoeffs ()
 
Block< CoefficientsType, Dynamic, 1 > col (Index i)
 
Block< CoefficientsType, 1, SizeAtCompileTimediagonal ()
 
const Block< const CoefficientsType, 1, SizeAtCompileTimediagonal () const
 
DiagonalIntReturnType< N >::Type diagonal ()
 
const DiagonalIntReturnType< N >::Type diagonal () const
 
Block< CoefficientsType, 1, Dynamic > diagonal (Index i)
 
const Block< const CoefficientsType, 1, Dynamic > diagonal (Index i) const
 
void evalTo (Dest &dst) const
 
Index subs () const
 
Index supers () const
 
DenseMatrixType toDenseMatrix () const
 
- Public Member Functions inherited from Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & const_derived () const
 
EIGEN_DEVICE_FUNC BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & derived ()
 
EIGEN_DEVICE_FUNC const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & derived () const
 
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
 
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 

Protected Attributes

CoefficientsType m_coeffs
 
internal::variable_if_dynamic< Index, Rows > m_rows
 
internal::variable_if_dynamic< Index, Subsm_subs
 
internal::variable_if_dynamic< Index, Supersm_supers
 

Additional Inherited Members

- Protected Types inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
enum  
 
- Protected Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
Index diagonalLength (Index i) const
 

Detailed Description

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
class Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >

Represents a rectangular matrix with a banded storage.

Template Parameters
_ScalarNumeric type, i.e. float, double, int
_RowsNumber of rows, or Dynamic
_ColsNumber of columns, or Dynamic
_SupersNumber of super diagonal
_SubsNumber of sub diagonal
_OptionsA combination of either RowMajor or ColMajor, and of SelfAdjoint The former controls storage order, and defaults to column-major. The latter controls whether the matrix represents a selfadjoint matrix in which case either Supers of Subs have to be null.
See also
class TridiagonalMatrix

Definition at line 199 of file BandMatrix.h.

Member Typedef Documentation

◆ CoefficientsType

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::CoefficientsType Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::CoefficientsType

Definition at line 205 of file BandMatrix.h.

◆ Scalar

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::Scalar Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::Scalar

Definition at line 203 of file BandMatrix.h.

◆ StorageIndex

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::StorageIndex Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::StorageIndex

Definition at line 204 of file BandMatrix.h.

Constructor & Destructor Documentation

◆ BandMatrix()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::BandMatrix ( Index  rows = Rows,
Index  cols = Cols,
Index  supers = Supers,
Index  subs = Subs 
)
inlineexplicit

Definition at line 207 of file BandMatrix.h.

Member Function Documentation

◆ coeffs() [1/2]

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
const CoefficientsType& Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs ( ) const
inline

Definition at line 225 of file BandMatrix.h.

◆ coeffs() [2/2]

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
CoefficientsType& Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs ( )
inline

Definition at line 226 of file BandMatrix.h.

◆ cols()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::cols ( ) const
inline
Returns
the number of rows

Definition at line 217 of file BandMatrix.h.

◆ rows()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::rows ( ) const
inline
Returns
the number of columns

Definition at line 214 of file BandMatrix.h.

◆ subs()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::subs ( ) const
inline
Returns
the number of sub diagonals

Definition at line 223 of file BandMatrix.h.

◆ supers()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
EIGEN_CONSTEXPR Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::supers ( ) const
inline
Returns
the number of super diagonals

Definition at line 220 of file BandMatrix.h.

Member Data Documentation

◆ m_coeffs

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
CoefficientsType Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_coeffs
protected

Definition at line 230 of file BandMatrix.h.

◆ m_rows

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::variable_if_dynamic<Index, Rows> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_rows
protected

Definition at line 231 of file BandMatrix.h.

◆ m_subs

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::variable_if_dynamic<Index, Subs> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_subs
protected

Definition at line 233 of file BandMatrix.h.

◆ m_supers

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::variable_if_dynamic<Index, Supers> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_supers
protected

Definition at line 232 of file BandMatrix.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:44:24