Yoji KURODA / Eigen

Eigne Matrix Class Library

Dependents:   Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more

Embed: (wiki syntax)

« Back to documentation index

TridiagonalMatrix< Scalar, Size, Options > Class Template Reference
Public Member Functions

TridiagonalMatrix< Scalar, Size, Options > Class Template Reference
[Core module]

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

#include <BandMatrix.h>

Inherits BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >.

Public Member Functions

Index rows () const
Index cols () const
Index supers () const
Index subs () const
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
Derived & derived ()
const Derived & derived () const
Index size () const

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:
_ScalarNumeric type, i.e. float, double, int
SizeNumber of rows and cols, or Dynamic
_OptionsCan be 0 or SelfAdjoint
See also:
class BandMatrix

Definition at line 312 of file BandMatrix.h.

Member Function Documentation

Block<CoefficientsType,Dynamic,1> col ( Index  i ) [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 68 of file BandMatrix.h.

Index cols ( void   ) const [inherited]
Returns:
the number of rows

Reimplemented from EigenBase< Derived >.

Definition at line 217 of file BandMatrix.h.

Derived& derived (  ) [inherited]
Returns:
a reference to the derived object

Definition at line 34 of file EigenBase.h.

const Derived& derived (  ) const [inherited]
Returns:
a const reference to the derived object

Definition at line 36 of file EigenBase.h.

Block<CoefficientsType,1,Dynamic> diagonal ( Index  i ) [inherited]
Returns:
a vector expression of the i -th sub or super diagonal

Definition at line 121 of file BandMatrix.h.

const Block<const CoefficientsType,1,Dynamic> diagonal ( Index  i ) const [inherited]
Returns:
a vector expression of the i -th sub or super diagonal

Definition at line 128 of file BandMatrix.h.

const Block<const CoefficientsType,1,SizeAtCompileTime> diagonal (  ) const [inherited]
Returns:
a vector expression of the main diagonal (const version)

Definition at line 88 of file BandMatrix.h.

Block<CoefficientsType,1,SizeAtCompileTime> diagonal (  ) [inherited]
Returns:
a vector expression of the main diagonal

Definition at line 84 of file BandMatrix.h.

DiagonalIntReturnType<N>::Type diagonal (  ) [inherited]
Returns:
a vector expression of the N -th sub or super diagonal

Definition at line 109 of file BandMatrix.h.

const DiagonalIntReturnType<N>::Type diagonal (  ) const [inherited]
Returns:
a vector expression of the N -th sub or super diagonal

Definition at line 115 of file BandMatrix.h.

Index rows ( void   ) const [inherited]
Returns:
the number of columns

Reimplemented from EigenBase< Derived >.

Definition at line 214 of file BandMatrix.h.

Index size (  ) const [inherited]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented in PermutationBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

Definition at line 49 of file EigenBase.h.

Index subs (  ) const [inherited]
Returns:
the number of sub diagonals

Definition at line 223 of file BandMatrix.h.

Index supers (  ) const [inherited]
Returns:
the number of super diagonals

Definition at line 220 of file BandMatrix.h.

Generated on Tue Jul 12 2022 17:47:06 by  doxygen 1.7.2