Dynamic size Tridiagonal symmetric matrix type This class is in practice used in Lanczos decomposition. More...

#include <tridiagonal-matrix.hpp>

Public Types
enum	{ Options = _Options }

typedef Eigen::Matrix< Scalar, Eigen::Dynamic, 1, Options >	CoeffVectorType

typedef traits< Self >::PlainMatrixType	PlainMatrixType

typedef _Scalar	Scalar

Public Member Functions
template<typename MatrixDerived >
TridiagonalSymmetricMatrixApplyOnTheLeftReturnType< MatrixDerived, Self >	applyOnTheLeft (const Eigen::MatrixBase< MatrixDerived > &mat) const

template<typename MatrixDerived >
TridiagonalSymmetricMatrixApplyOnTheRightReturnType< Self, MatrixDerived >	applyOnTheRight (const Eigen::MatrixBase< MatrixDerived > &mat) const

EIGEN_CONSTEXPR Eigen::Index	cols () const EIGEN_NOEXCEPT

CoeffVectorType &	diagonal ()

const CoeffVectorType &	diagonal () const

template<typename ResultType >
void	evalTo (ResultType &result) const

TridiagonalSymmetricMatrixInverse< Self >	inverse () const

bool	isDiagonal (const Scalar prec=Eigen::NumTraits< Scalar >::dummy_precision()) const

bool	isIdentity (const Scalar prec=Eigen::NumTraits< Scalar >::dummy_precision()) const

bool	isZero (const Scalar prec=Eigen::NumTraits< Scalar >::dummy_precision()) const

PlainMatrixType	matrix () const

bool	operator!= (const TridiagonalSymmetricMatrixTpl &other) const

template<typename MatrixDerived >
TridiagonalSymmetricMatrixApplyOnTheRightReturnType< Self, MatrixDerived >	operator* (const Eigen::MatrixBase< MatrixDerived > &mat) const

bool	operator== (const TridiagonalSymmetricMatrixTpl &other) const

EIGEN_CONSTEXPR Eigen::Index	rows () const EIGEN_NOEXCEPT

template<typename VectorCoeffType >
void	setDiagonal (const Eigen::MatrixBase< VectorCoeffType > &diagonal_coefficients)

void	setIdentity ()

void	setRandom ()

void	setZero ()

CoeffVectorType &	subDiagonal ()

const CoeffVectorType &	subDiagonal () const

	TridiagonalSymmetricMatrixTpl (const Eigen::DenseIndex size)
	Default constructor from a given size. More...

Public Attributes
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef TridiagonalSymmetricMatrixTpl	Self

Protected Attributes
CoeffVectorType	m_diagonal

Eigen::DenseIndex	m_size

CoeffVectorType	m_sub_diagonal

Detailed Description

template<typename _Scalar, int _Options>
struct pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >

Dynamic size Tridiagonal symmetric matrix type This class is in practice used in Lanczos decomposition.

Definition at line 14 of file math/tridiagonal-matrix.hpp.

Member Typedef Documentation

◆ CoeffVectorType

template<typename _Scalar , int _Options>

typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1, Options> pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::CoeffVectorType

Definition at line 172 of file math/tridiagonal-matrix.hpp.

◆ PlainMatrixType

template<typename _Scalar , int _Options>

typedef traits<Self>::PlainMatrixType pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::PlainMatrixType

Definition at line 173 of file math/tridiagonal-matrix.hpp.

◆ Scalar

template<typename _Scalar , int _Options>

typedef _Scalar pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::Scalar

Definition at line 166 of file math/tridiagonal-matrix.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , int _Options>

anonymous enum

Enumerator
Options

Definition at line 167 of file math/tridiagonal-matrix.hpp.

Constructor & Destructor Documentation

◆ TridiagonalSymmetricMatrixTpl()

template<typename _Scalar , int _Options>

pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::TridiagonalSymmetricMatrixTpl ( const Eigen::DenseIndex size )

inlineexplicit

Default constructor from a given size.

Definition at line 176 of file math/tridiagonal-matrix.hpp.

Member Function Documentation

◆ applyOnTheLeft()

template<typename _Scalar , int _Options>

template<typename MatrixDerived >

TridiagonalSymmetricMatrixApplyOnTheLeftReturnType<MatrixDerived, Self> pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::applyOnTheLeft ( const Eigen::MatrixBase< MatrixDerived > & mat ) const

inline

Definition at line 296 of file math/tridiagonal-matrix.hpp.

◆ applyOnTheRight()

template<typename _Scalar , int _Options>

template<typename MatrixDerived >

TridiagonalSymmetricMatrixApplyOnTheRightReturnType<Self, MatrixDerived> pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::applyOnTheRight ( const Eigen::MatrixBase< MatrixDerived > & mat ) const

inline

Definition at line 288 of file math/tridiagonal-matrix.hpp.

◆ cols()

template<typename _Scalar , int _Options>

EIGEN_CONSTEXPR Eigen::Index pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::cols ( ) const

inline

Definition at line 267 of file math/tridiagonal-matrix.hpp.

◆ diagonal() [1/2]

template<typename _Scalar , int _Options>

CoeffVectorType& pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::diagonal ( )

inline

Definition at line 201 of file math/tridiagonal-matrix.hpp.

◆ diagonal() [2/2]

template<typename _Scalar , int _Options>

const CoeffVectorType& pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::diagonal ( ) const

inline

Definition at line 205 of file math/tridiagonal-matrix.hpp.

◆ evalTo()

template<typename _Scalar , int _Options>

template<typename ResultType >

void pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::evalTo ( ResultType & result ) const

inline

Definition at line 278 of file math/tridiagonal-matrix.hpp.

◆ inverse()

template<typename _Scalar , int _Options>

TridiagonalSymmetricMatrixInverse<Self> pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::inverse ( ) const

inline

Definition at line 196 of file math/tridiagonal-matrix.hpp.

◆ isDiagonal()

template<typename _Scalar , int _Options>

bool pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::isDiagonal ( const Scalar prec = Eigen::NumTraits<Scalar>::dummy_precision() ) const

inline

Definition at line 246 of file math/tridiagonal-matrix.hpp.

◆ isIdentity()

template<typename _Scalar , int _Options>

bool pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::isIdentity ( const Scalar prec = Eigen::NumTraits<Scalar>::dummy_precision() ) const

inline

Definition at line 224 of file math/tridiagonal-matrix.hpp.

◆ isZero()

template<typename _Scalar , int _Options>

bool pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::isZero ( const Scalar prec = Eigen::NumTraits<Scalar>::dummy_precision() ) const

inline

Definition at line 235 of file math/tridiagonal-matrix.hpp.

◆ matrix()

template<typename _Scalar , int _Options>

PlainMatrixType pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::matrix ( ) const

inline

Definition at line 272 of file math/tridiagonal-matrix.hpp.

◆ operator!=()

template<typename _Scalar , int _Options>

bool pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::operator!= ( const TridiagonalSymmetricMatrixTpl< _Scalar, _Options > & other ) const

inline

Definition at line 191 of file math/tridiagonal-matrix.hpp.

◆ operator*()

template<typename _Scalar , int _Options>

template<typename MatrixDerived >

TridiagonalSymmetricMatrixApplyOnTheRightReturnType<Self, MatrixDerived> pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::operator* ( const Eigen::MatrixBase< MatrixDerived > & mat ) const

inline

Definition at line 304 of file math/tridiagonal-matrix.hpp.

◆ operator==()

template<typename _Scalar , int _Options>

bool pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::operator== ( const TridiagonalSymmetricMatrixTpl< _Scalar, _Options > & other ) const

inline

Definition at line 184 of file math/tridiagonal-matrix.hpp.

◆ rows()

template<typename _Scalar , int _Options>

EIGEN_CONSTEXPR Eigen::Index pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::rows ( ) const

inline

Definition at line 263 of file math/tridiagonal-matrix.hpp.

◆ setDiagonal()

template<typename _Scalar , int _Options>

template<typename VectorCoeffType >

void pinocchio::TridiagonalSymmetricMatrixTpl< _Scalar, _Options >::setDiagonal ( const Eigen::MatrixBase< VectorCoeffType > & diagonal_coefficients )

inline

Definition at line 252 of file math/tridiagonal-matrix.hpp.