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

---

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.

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

Definition at line 327 of file Core.

Inheritance diagram for Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >:

List of all members.

Public Types
typedef internal::traits < BandMatrix >::Scalar	Scalar
typedef internal::traits < BandMatrix > ::CoefficientsType	CoefficientsType
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 Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef internal::traits < Derived >::StorageKind	StorageKind
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 ()
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
Derived &	derived ()
const Derived &	derived () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Index	size () const
template<typename Dest >
void	addTo (Dest &dst) const
template<typename Dest >
void	subTo (Dest &dst) const
template<typename Dest >
void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
void	applyThisOnTheLeft (Dest &dst) const
Protected Types
enum	{ DataRowsAtCompileTime, SizeAtCompileTime = EIGEN_SIZE_MIN_PREFER_DYNAMIC(RowsAtCompileTime,ColsAtCompileTime) }
Protected Member Functions
Index	diagonalLength (Index i) const
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

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]

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 329 of file Core.

typedef internal::traits<BandMatrix>::CoefficientsType Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::CoefficientsType [inherited]

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 220 of file Core.

template<typename Derived>

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::internal::BandMatrixBase< Derived >::DenseMatrixType [inherited]

Definition at line 49 of file Core.

template<typename Scalar , int Size, int Options>

typedef Base::Index Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::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 , Rows, Cols, Supers, Subs, Options >::Scalar [inherited]

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 218 of file Core.

template<typename Derived>

typedef internal::traits<Derived>::StorageKind Eigen::EigenBase< Derived >::StorageKind [inherited]

Reimplemented in Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >, Eigen::DenseCoeffsBase< Derived, WriteAccessors >, Eigen::TriangularBase< Derived >, Eigen::TriangularView< _MatrixType, _Mode >, Eigen::SparseMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::TriangularBase< TriangularView< _MatrixType, _Mode > >, Eigen::TriangularBase< SelfAdjointView< MatrixType, UpLo > >, Eigen::SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, Eigen::SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, Eigen::SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, Eigen::SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >, Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >, and Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 45 of file Core.

---

Member Enumeration Documentation

template<typename Derived>

anonymous enum [inherited]

Enumerator:

Flags
CoeffReadCost
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
Supers
Subs
Options

Definition at line 37 of file Core.

template<typename Derived>

anonymous enum [protected, inherited]

Enumerator:

DataRowsAtCompileTime
SizeAtCompileTime

Definition at line 55 of file Core.

---

Constructor & Destructor Documentation

template<typename Scalar , int Size, int Options>

Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::TridiagonalMatrix

(

Index

size = Size

)

[inline]

Definition at line 332 of file Core.

---

Member Function Documentation

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Reimplemented in Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >.

Definition at line 99 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Reimplemented in Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >.

Definition at line 91 of file Core.

CoefficientsType& Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::coeffs

(

)

[inline, inherited]

Returns:

an expression of the underlying coefficient matrix

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 241 of file Core.

const CoefficientsType& Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::coeffs

(

)

const [inline, inherited]

Returns:

an expression of the underlying coefficient matrix

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 240 of file Core.

template<typename Derived>

Block<CoefficientsType,Dynamic,1> Eigen::internal::BandMatrixBase< Derived >::col

(

Index

i

)

[inline, inherited]

Returns:

a vector expression of the i -th column, only the meaningful part is returned.

Warning:

the internal storage must be column major.

Definition at line 83 of file Core.

Index Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::cols

(

void

)

const [inline, inherited]

Returns:

the number of rows

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 232 of file Core.

template<typename Derived>

Derived& Eigen::EigenBase< Derived >::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

template<typename Derived>

const Derived& Eigen::EigenBase< Derived >::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

template<typename Derived>

Derived& Eigen::EigenBase< Derived >::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

Referenced by mrpt::math::loadVector().

template<typename Derived>

const Derived& Eigen::EigenBase< Derived >::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

template<typename Derived>

Block<CoefficientsType,1,Dynamic> Eigen::internal::BandMatrixBase< Derived >::diagonal

(

Index

i

)

[inline, inherited]

Returns:

a vector expression of the i -th sub or super diagonal

Definition at line 136 of file Core.

template<typename Derived>

const Block<const CoefficientsType,1,Dynamic> Eigen::internal::BandMatrixBase< Derived >::diagonal

(

Index

i

)

const [inline, inherited]

Returns:

a vector expression of the i -th sub or super diagonal

Definition at line 143 of file Core.

template<typename Derived>

const Block<const CoefficientsType,1,SizeAtCompileTime> Eigen::internal::BandMatrixBase< Derived >::diagonal

(

)

const [inline, inherited]

Returns:

a vector expression of the main diagonal (const version)

Definition at line 103 of file Core.

template<typename Derived>

Block<CoefficientsType,1,SizeAtCompileTime> Eigen::internal::BandMatrixBase< Derived >::diagonal

(

)

[inline, inherited]

Returns:

a vector expression of the main diagonal

Definition at line 99 of file Core.

template<typename Derived>

template<int N>

DiagonalIntReturnType<N>::Type Eigen::internal::BandMatrixBase< Derived >::diagonal

(

)

[inline, inherited]

Returns:

a vector expression of the N -th sub or super diagonal

Definition at line 124 of file Core.

template<typename Derived>

template<int N>

const DiagonalIntReturnType<N>::Type Eigen::internal::BandMatrixBase< Derived >::diagonal

(

)

const [inline, inherited]

Returns:

a vector expression of the N -th sub or super diagonal

Definition at line 130 of file Core.

template<typename Derived>

Index Eigen::internal::BandMatrixBase< Derived >::diagonalLength

(

Index

i

)

const [inline, protected, inherited]

Definition at line 169 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::internal::BandMatrixBase< Derived >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 149 of file Core.

Index Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::rows

(

void

)

const [inline, inherited]

Returns:

the number of columns

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 229 of file Core.

template<typename Derived>

Index Eigen::EigenBase< Derived >::size

(

)

const [inline, inherited]

Returns:

the number of coefficients, which is rows()*cols().

See also:

rows(), cols(), SizeAtCompileTime.

Reimplemented in Eigen::PermutationBase< Derived >, Eigen::SparseMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::PermutationBase< PermutationWrapper< _IndicesType > >, Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, Eigen::SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, Eigen::SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, Eigen::SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, Eigen::SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >, Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >, and Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 64 of file Core.

template<typename Scalar , int Size, int Options>

Base::template DiagonalIntReturnType<-1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::sub

(

)

[inline]

Definition at line 338 of file Core.

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 340 of file Core.

Index Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::subs

(

)

const [inline, inherited]

Returns:

the number of sub diagonals

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 238 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

template<typename Scalar , int Size, int Options>

Base::template DiagonalIntReturnType<1>::Type Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::super

(

)

[inline]

Definition at line 334 of file Core.

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 336 of file Core.

Index Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::supers

(

)

const [inline, inherited]

Returns:

the number of super diagonals

Reimplemented from Eigen::internal::BandMatrixBase< Derived >.

Definition at line 235 of file Core.

template<typename Derived>

DenseMatrixType Eigen::internal::BandMatrixBase< Derived >::toDenseMatrix

(

)

const [inline, inherited]

Definition at line 160 of file Core.

---

Member Data Documentation

CoefficientsType Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::m_coeffs [protected, inherited]

Definition at line 245 of file Core.

internal::variable_if_dynamic<Index, Rows> Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::m_rows [protected, inherited]

Definition at line 246 of file Core.

internal::variable_if_dynamic<Index, Subs> Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::m_subs [protected, inherited]

Definition at line 248 of file Core.

internal::variable_if_dynamic<Index, Supers> Eigen::internal::BandMatrix< Scalar , Rows, Cols, Supers, Subs, Options >::m_supers [protected, inherited]

Definition at line 247 of file Core.