WPILibC++ 2023.4.3
Eigen::internal::TridiagonalMatrix< Scalar, Size, Options > Class Template Reference

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/BandMatrix.h>

Inheritance diagram for Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >:
Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor > Eigen::internal::BandMatrixBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > > Eigen::EigenBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >

Public Member Functions

 TridiagonalMatrix (Index size=Size)
 
Base::template DiagonalIntReturnType< 1 >::Type super ()
 
const Base::template DiagonalIntReturnType< 1 >::Type super () const
 
Base::template DiagonalIntReturnType<-1 >::Type sub ()
 
const Base::template DiagonalIntReturnType<-1 >::Type sub () const
 
- 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)
 
EIGEN_CONSTEXPR Index rows () const
 
EIGEN_CONSTEXPR Index cols () const
 
EIGEN_CONSTEXPR Index supers () const
 
EIGEN_CONSTEXPR Index subs () const
 
const CoefficientsTypecoeffs () const
 
CoefficientsTypecoeffs ()
 
- Public Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >
Index supers () const
 
Index subs () const
 
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
 
DenseMatrixType toDenseMatrix () 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 EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
- Public Member Functions inherited from Eigen::EigenBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >
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 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 EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 

Additional Inherited Members

- Public Types inherited from Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >
typedef internal::traits< BandMatrix >::Scalar Scalar
 
typedef internal::traits< BandMatrix >::StorageIndex StorageIndex
 
typedef internal::traits< BandMatrix >::CoefficientsType CoefficientsType
 
- Public Types inherited from Eigen::internal::BandMatrixBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >
enum  
 
typedef internal::traits< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >::Scalar Scalar
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef DenseMatrixType::StorageIndex StorageIndex
 
typedef internal::traits< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >::CoefficientsType CoefficientsType
 
typedef EigenBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > > Base
 
- 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
 
- 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
 
- 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, Supersm_supers
 
internal::variable_if_dynamic< Index, Subsm_subs
 

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

Constructor & Destructor Documentation

◆ TridiagonalMatrix()

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

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

◆ 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

◆ super() [1/2]

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

◆ 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

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