Base class for triangular part in a matrix. More...

#include <TriangularMatrix.h>

Inheritance diagram for Eigen::TriangularBase< Derived >:

Public Types
enum	{ Mode = internal::traits<Derived>::Mode, RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime, MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime, SizeAtCompileTime, MaxSizeAtCompileTime }

typedef internal::traits< Derived >::FullMatrixType	DenseMatrixType

typedef DenseMatrixType	DenseType

typedef Derived const &	Nested

typedef internal::traits< Derived >::Scalar	Scalar

typedef internal::traits< Derived >::StorageIndex	StorageIndex

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
EIGEN_DEVICE_FUNC Scalar	coeff (Index row, Index col) const

EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index row, Index col)

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

template<typename Other >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	copyCoeff (Index row, Index col, Other &other)

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

template<typename DenseDerived >
EIGEN_DEVICE_FUNC void	evalTo (MatrixBase< DenseDerived > &other) const

template<typename DenseDerived >
EIGEN_DEVICE_FUNC void	evalToLazy (MatrixBase< DenseDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Scalar &	operator() (Index row, Index col)

EIGEN_DEVICE_FUNC Scalar	operator() (Index row, Index col) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC void	resize (Index rows, Index cols)

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC DenseMatrixType	toDenseMatrix () const

EIGEN_DEVICE_FUNC	TriangularBase ()

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

const EIGEN_DEVICE_FUNC Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

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

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

Protected Member Functions
void	check_coordinates (Index row, Index col) const

void	check_coordinates_internal (Index, Index) const

Detailed Description

template<typename Derived>
class Eigen::TriangularBase< Derived >

Base class for triangular part in a matrix.

Definition at line 27 of file TriangularMatrix.h.

Member Typedef Documentation

◆ DenseMatrixType

template<typename Derived >

typedef internal::traits<Derived>::FullMatrixType Eigen::TriangularBase< Derived >::DenseMatrixType

Definition at line 51 of file TriangularMatrix.h.

◆ DenseType

template<typename Derived >

typedef DenseMatrixType Eigen::TriangularBase< Derived >::DenseType

Definition at line 52 of file TriangularMatrix.h.

◆ Nested

template<typename Derived >

typedef Derived const& Eigen::TriangularBase< Derived >::Nested

Definition at line 53 of file TriangularMatrix.h.

◆ Scalar

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::TriangularBase< Derived >::Scalar

Definition at line 48 of file TriangularMatrix.h.

◆ StorageIndex

template<typename Derived >

typedef internal::traits<Derived>::StorageIndex Eigen::TriangularBase< Derived >::StorageIndex

Definition at line 50 of file TriangularMatrix.h.

◆ StorageKind

template<typename Derived >

typedef internal::traits<Derived>::StorageKind Eigen::TriangularBase< Derived >::StorageKind

Definition at line 49 of file TriangularMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived >

anonymous enum

Enumerator
Mode
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
SizeAtCompileTime	This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to Dynamic if this is not known at compile-time. See also RowsAtCompileTime, ColsAtCompileTime
MaxSizeAtCompileTime

Definition at line 31 of file TriangularMatrix.h.

Constructor & Destructor Documentation

◆ TriangularBase()

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::TriangularBase< Derived >::TriangularBase ( )

inline

Definition at line 56 of file TriangularMatrix.h.

Member Function Documentation

◆ check_coordinates()

template<typename Derived >

void Eigen::TriangularBase< Derived >::check_coordinates	(	Index	row,
		Index	col
	)		const

inlineprotected

Definition at line 127 of file TriangularMatrix.h.

◆ check_coordinates_internal()

template<typename Derived >

void Eigen::TriangularBase< Derived >::check_coordinates_internal	(	Index	,
		Index
	)		const

inlineprotected

Definition at line 146 of file TriangularMatrix.h.

◆ coeff()

template<typename Derived >

EIGEN_DEVICE_FUNC Scalar Eigen::TriangularBase< Derived >::coeff	(	Index	row,
		Index	col
	)		const

inline

Definition at line 77 of file TriangularMatrix.h.

◆ coeffRef()

template<typename Derived >

EIGEN_DEVICE_FUNC Scalar& Eigen::TriangularBase< Derived >::coeffRef	(	Index	row,
		Index	col
	)

inline

Definition at line 79 of file TriangularMatrix.h.

◆ cols()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::TriangularBase< Derived >::cols ( ) const

inline

Definition at line 61 of file TriangularMatrix.h.

◆ copyCoeff()

template<typename Derived >

template<typename Other >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::TriangularBase< Derived >::copyCoeff	(	Index	row,
		Index	col,
		Other &	other
	)

inline

See also: MatrixBase::copyCoeff(row,col)

Definition at line 85 of file TriangularMatrix.h.

◆ derived() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC Derived& Eigen::TriangularBase< Derived >::derived ( )

inline

Definition at line 107 of file TriangularMatrix.h.

◆ derived() [2/2]

template<typename Derived >

const EIGEN_DEVICE_FUNC Derived& Eigen::TriangularBase< Derived >::derived ( ) const

inline

Definition at line 105 of file TriangularMatrix.h.

◆ evalTo()

template<typename Derived >

template<typename DenseDerived >

EIGEN_DEVICE_FUNC void Eigen::TriangularBase< Derived >::evalTo ( MatrixBase< DenseDerived > & other ) const

Assigns a triangular or selfadjoint matrix to a dense matrix. If the matrix is triangular, the opposite part is set to zero.

Definition at line 616 of file TriangularMatrix.h.

◆ evalToLazy()

template<typename Derived >

template<typename DenseDerived >

EIGEN_DEVICE_FUNC void Eigen::TriangularBase< Derived >::evalToLazy ( MatrixBase< DenseDerived > & other ) const

Assigns a triangular or selfadjoint matrix to a dense matrix. If the matrix is triangular, the opposite part is set to zero.

Definition at line 951 of file TriangularMatrix.h.

◆ innerStride()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::TriangularBase< Derived >::innerStride ( ) const

inline

Definition at line 65 of file TriangularMatrix.h.

◆ operator()() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC Scalar& Eigen::TriangularBase< Derived >::operator()	(	Index	row,
		Index	col
	)

inline

Definition at line 97 of file TriangularMatrix.h.

◆ operator()() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC Scalar Eigen::TriangularBase< Derived >::operator()	(	Index	row,
		Index	col
	)		const

inline

Definition at line 91 of file TriangularMatrix.h.

◆ outerStride()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::TriangularBase< Derived >::outerStride ( ) const

inline

Definition at line 63 of file TriangularMatrix.h.

◆ resize()

template<typename Derived >

EIGEN_DEVICE_FUNC void Eigen::TriangularBase< Derived >::resize	(	Index	rows,
		Index	cols
	)

inline

Definition at line 69 of file TriangularMatrix.h.

◆ rows()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::TriangularBase< Derived >::rows ( ) const

inline

Definition at line 59 of file TriangularMatrix.h.

◆ toDenseMatrix()

template<typename Derived >

EIGEN_DEVICE_FUNC DenseMatrixType Eigen::TriangularBase< Derived >::toDenseMatrix ( ) const

inline

Definition at line 118 of file TriangularMatrix.h.

The documentation for this class was generated from the following file:

TriangularMatrix.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<typename Derived> class Eigen::TriangularBase< Derived >

Member Typedef Documentation

◆ DenseMatrixType

◆ DenseType

◆ Nested

◆ Scalar

◆ StorageIndex

◆ StorageKind

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TriangularBase()

Member Function Documentation

◆ check_coordinates()

◆ check_coordinates_internal()

◆ coeff()

◆ coeffRef()

◆ cols()

◆ copyCoeff()

◆ derived() [1/2]

◆ derived() [2/2]

◆ evalTo()

◆ evalToLazy()

◆ innerStride()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ outerStride()

◆ resize()

◆ rows()

◆ toDenseMatrix()

template<typename Derived>
class Eigen::TriangularBase< Derived >