Public Member Functions | Private Types | List of all members
Eigen::internal::TridiagonalMatrix< Scalar, Size, Options > Class Template Reference

Represents a tridiagonal matrix with a compact banded storage. More...

#include <BandMatrix.h>

Inheritance diagram for Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >:
Inheritance graph
[legend]

Public Member Functions

Base::template DiagonalIntReturnType<-1 >::Type sub ()
 
const Base::template DiagonalIntReturnType<-1 >::Type sub () const
 
Base::template DiagonalIntReturnType< 1 >::Type super ()
 
const Base::template DiagonalIntReturnType< 1 >::Type super () const
 
 TridiagonalMatrix (Index size=Size)
 
- Public Member Functions inherited from Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >
 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< Derived >
const CoefficientsTypecoeffs () const
 
CoefficientsTypecoeffs ()
 
Block< CoefficientsType, Dynamic, 1 > col (Index i)
 
Block< CoefficientsType, 1, SizeAtCompileTimediagonal ()
 
const Block< const CoefficientsType, 1, SizeAtCompileTimediagonal () const
 
template<int N>
DiagonalIntReturnType< N >::Type diagonal ()
 
template<int N>
const DiagonalIntReturnType< N >::Type diagonal () const
 
Block< CoefficientsType, 1, Dynamicdiagonal (Index i)
 
const Block< const CoefficientsType, 1, Dynamicdiagonal (Index i) const
 
template<typename Dest >
void evalTo (Dest &dst) const
 
Index subs () const
 
Index supers () const
 
DenseMatrixType toDenseMatrix () 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
 

Private Types

typedef BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajorBase
 
typedef Base::StorageIndex StorageIndex
 

Additional Inherited Members

- Public Types inherited from Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >
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< Derived >
enum  {
  Flags = internal::traits<Derived>::Flags, CoeffReadCost = internal::traits<Derived>::CoeffReadCost, RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
  MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime, MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime, Supers = internal::traits<Derived>::Supers, Subs = internal::traits<Derived>::Subs,
  Options = internal::traits<Derived>::Options
}
 
typedef EigenBase< Derived > Base
 
typedef internal::traits< Derived >::CoefficientsType CoefficientsType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef DenseMatrixType::StorageIndex StorageIndex
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
- Protected Types inherited from Eigen::internal::BandMatrixBase< Derived >
enum  { DataRowsAtCompileTime, SizeAtCompileTime = EIGEN_SIZE_MIN_PREFER_DYNAMIC(RowsAtCompileTime,ColsAtCompileTime) }
 
- Protected Member Functions inherited from Eigen::internal::BandMatrixBase< Derived >
Index diagonalLength (Index i) const
 
- Protected Attributes inherited from Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >
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
 

Detailed Description

template<typename Scalar, int Size, int Options>
class Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >

Represents a tridiagonal matrix with a compact banded storage.

Template Parameters
ScalarNumeric type, i.e. float, double, int
SizeNumber of rows and cols, or Dynamic
OptionsCan be 0 or SelfAdjoint
See also
class BandMatrix

Definition at line 312 of file BandMatrix.h.

Member Typedef Documentation

◆ Base

template<typename Scalar , int Size, int Options>
typedef BandMatrix<Scalar,Size,Size,Options&SelfAdjoint?0:1,1,Options|RowMajor> Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::Base
private

Definition at line 314 of file BandMatrix.h.

◆ StorageIndex

template<typename Scalar , int Size, int Options>
typedef Base::StorageIndex Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::StorageIndex
private

Definition at line 315 of file BandMatrix.h.

Constructor & Destructor Documentation

◆ TridiagonalMatrix()

template<typename Scalar , int Size, int Options>
Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::TridiagonalMatrix ( Index  size = Size)
inlineexplicit

Definition at line 317 of file BandMatrix.h.

Member Function Documentation

◆ sub() [1/2]

template<typename Scalar , int Size, int Options>
Base::template DiagonalIntReturnType<-1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::sub ( )
inline

Definition at line 323 of file BandMatrix.h.

◆ sub() [2/2]

template<typename Scalar , int Size, int Options>
const Base::template DiagonalIntReturnType<-1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::sub ( ) const
inline

Definition at line 325 of file BandMatrix.h.

◆ super() [1/2]

template<typename Scalar , int Size, int Options>
Base::template DiagonalIntReturnType<1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::super ( )
inline

Definition at line 319 of file BandMatrix.h.

◆ super() [2/2]

template<typename Scalar , int Size, int Options>
const Base::template DiagonalIntReturnType<1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::super ( ) const
inline

Definition at line 321 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:46:03