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 CoefficientsType &	coeffs () const

CoefficientsType &	coeffs ()

Public Member Functions inherited from Eigen::internal::BandMatrixBase< Derived >
Index	supers () const

Index	subs () const

const CoefficientsType &	coeffs () const

CoefficientsType &	coeffs ()

Block< CoefficientsType, Dynamic, 1 >	col (Index i)

Block< CoefficientsType, 1, SizeAtCompileTime >	diagonal ()

const Block< const CoefficientsType, 1, SizeAtCompileTime >	diagonal () const

template<int N>
DiagonalIntReturnType< N >::Type	diagonal ()

template<int N>
const DiagonalIntReturnType< N >::Type	diagonal () const

Block< CoefficientsType, 1, Dynamic >	diagonal (Index i)

const Block< const CoefficientsType, 1, Dynamic >	diagonal (Index i) const

template<typename Dest >
void	evalTo (Dest &dst) const

DenseMatrixType	toDenseMatrix () const

EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	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< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()

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

Private Types
typedef BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options\|RowMajor >	Base

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, ColsAtCompileTime >	DenseMatrixType

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 , 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, Supers >	m_supers

internal::variable_if_dynamic< Index, Subs >	m_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

Scalar	Numeric type, i.e. float, double, int
Size	Number of rows and cols, or Dynamic
Options	Can be 0 or SelfAdjoint

See also: class BandMatrix