Eigen::internal::TridiagonalMatrix Class Reference

---

Detailed Description

Represents a tridiagonal matrix with a compact banded storage.

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

Inheritance diagram for Eigen::internal::TridiagonalMatrix:

List of all members.

Public Types
typedef internal::traits < BandMatrix >::Scalar	Scalar
typedef internal::traits < BandMatrix > ::CoefficientsType	CoefficientsType
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
Index	rows () const
Index	cols () const
Index	supers () const
Index	subs () const
const CoefficientsType &	coeffs () const
CoefficientsType &	coeffs ()
Protected Attributes
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
Private Types
typedef BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >	Base
typedef Base::Index	Index

---

Member Typedef Documentation

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

Definition at line 329 of file Core.

typedef internal::traits<BandMatrix>::CoefficientsType Eigen::internal::BandMatrix::CoefficientsType [inherited]

Definition at line 220 of file Core.

typedef Base::Index Eigen::internal::TridiagonalMatrix::Index [private]

Reimplemented from Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >.

Definition at line 330 of file Core.

typedef internal::traits<BandMatrix>::Scalar Eigen::internal::BandMatrix::Scalar [inherited]

Definition at line 218 of file Core.

---

Constructor & Destructor Documentation

Eigen::internal::TridiagonalMatrix::TridiagonalMatrix

(

Index

size = Size

)

[inline]

Definition at line 332 of file Core.

---

Member Function Documentation

const CoefficientsType& Eigen::internal::BandMatrix::coeffs

(

)

const [inline, inherited]

Returns:

an expression of the underlying coefficient matrix

Definition at line 240 of file Core.

CoefficientsType& Eigen::internal::BandMatrix::coeffs

(

)

[inline, inherited]

Returns:

an expression of the underlying coefficient matrix

Definition at line 241 of file Core.

Index Eigen::internal::BandMatrix::cols

(

void

)

const [inline, inherited]

Returns:

the number of rows

Definition at line 232 of file Core.

Index Eigen::internal::BandMatrix::rows

(

void

)

const [inline, inherited]

Returns:

the number of columns

Definition at line 229 of file Core.

Base::template DiagonalIntReturnType<-1>::Type Eigen::internal::TridiagonalMatrix::sub

(

)

[inline]

Definition at line 338 of file Core.

const Base::template DiagonalIntReturnType<-1>::Type Eigen::internal::TridiagonalMatrix::sub

(

)

const [inline]

Definition at line 340 of file Core.

Index Eigen::internal::BandMatrix::subs

(

)

const [inline, inherited]

Returns:

the number of sub diagonals

Definition at line 238 of file Core.

Base::template DiagonalIntReturnType<1>::Type Eigen::internal::TridiagonalMatrix::super

(

)

[inline]

Definition at line 334 of file Core.

const Base::template DiagonalIntReturnType<1>::Type Eigen::internal::TridiagonalMatrix::super

(

)

const [inline]

Definition at line 336 of file Core.

Index Eigen::internal::BandMatrix::supers

(

)

const [inline, inherited]

Returns:

the number of super diagonals

Definition at line 235 of file Core.

---

Member Data Documentation

CoefficientsType Eigen::internal::BandMatrix::m_coeffs [protected, inherited]

Definition at line 245 of file Core.

internal::variable_if_dynamic<Index, Rows> Eigen::internal::BandMatrix::m_rows [protected, inherited]

Definition at line 246 of file Core.

internal::variable_if_dynamic<Index, Subs> Eigen::internal::BandMatrix::m_subs [protected, inherited]

Definition at line 248 of file Core.

internal::variable_if_dynamic<Index, Supers> Eigen::internal::BandMatrix::m_supers [protected, inherited]

Definition at line 247 of file Core.