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 >:

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< Derived >
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
 
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
 
DenseMatrixType toDenseMatrix () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
constexpr EIGEN_DEVICE_FUNC Derived & derived ()
 
constexpr EIGEN_DEVICE_FUNC const Derived & derived () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr EIGEN_DEVICE_FUNC Derived & derived ()
 
constexpr EIGEN_DEVICE_FUNC const Derived & derived () const
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & 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
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< Derived, Device > device (Device &device)
 
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const Derived, Device > device (Device &device) 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 >::Scalar Scalar
 
typedef internal::traits< BandMatrix >::StorageIndex StorageIndex
 
typedef internal::traits< BandMatrix >::CoefficientsType CoefficientsType
 
- 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 internal::traits< Derived >::Scalar Scalar
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef DenseMatrixType::StorageIndex StorageIndex
 
typedef internal::traits< Derived >::CoefficientsType CoefficientsType
 
typedef EigenBase< Derived > Base
 
- 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 = ((Supers != Dynamic) && (Subs != Dynamic)) ? 1 + Supers + Subs : Dynamic , SizeAtCompileTime = min_size_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, 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

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

◆ StorageIndex

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

Constructor & Destructor Documentation

◆ TridiagonalMatrix()

template<typename Scalar , int Size, int Options>
Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::TridiagonalMatrix ( Index  size = Size)
inlineexplicit
301 : Base(size, size, Options & SelfAdjoint ? 0 : 1, 1) {}
@ Options
Definition: BandMatrix.h:32
BandMatrix< Scalar, Size, Size, Options &SelfAdjoint ? 0 :1, 1, Options|RowMajor > Base
Definition: BandMatrix.h:297
@ SelfAdjoint
Definition: Constants.h:227
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size() const EIGEN_NOEXCEPT
Definition: EigenBase.h:64

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
307 { return Base::template diagonal<-1>(); }
Block< CoefficientsType, 1, SizeAtCompileTime > diagonal()
Definition: BandMatrix.h:79

References Eigen::internal::BandMatrixBase< Derived >::diagonal().

◆ 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
308  {
309  return Base::template diagonal<-1>();
310  }

References Eigen::internal::BandMatrixBase< Derived >::diagonal().

◆ super() [1/2]

template<typename Scalar , int Size, int Options>
Base::template DiagonalIntReturnType<1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::super ( )
inline
303 { return Base::template diagonal<1>(); }

◆ 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
304  {
305  return Base::template diagonal<1>();
306  }

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