Eigen::TriangularView< _MatrixType, _Mode > Class Template Reference

Expression of a triangular part in a matrix. More...

#include <TriangularMatrix.h>

Inheritance diagram for Eigen::TriangularView< _MatrixType, _Mode >:

Public Types
enum	{ Mode = _Mode, Flags = internal::traits<TriangularView>::Flags, TransposeMode, IsVectorAtCompileTime = false }
typedef TriangularViewImpl< _MatrixType, _Mode, typename internal::traits< _MatrixType >::StorageKind >	Base
typedef internal::traits< TriangularView >::Scalar	Scalar
typedef _MatrixType	MatrixType
typedef internal::traits< TriangularView >::StorageKind	StorageKind
typedef internal::traits< TriangularView >::MatrixTypeNestedCleaned	NestedExpression
typedef TriangularView< const MatrixConjugateReturnType, Mode >	ConjugateReturnType
typedef TriangularView< const typename MatrixType::AdjointReturnType, TransposeMode >	AdjointReturnType
typedef TriangularView< typename MatrixType::TransposeReturnType, TransposeMode >	TransposeReturnType
typedef TriangularView< const typename MatrixType::ConstTransposeReturnType, TransposeMode >	ConstTransposeReturnType

Public Member Functions
EIGEN_DEVICE_FUNC	TriangularView (MatrixType &matrix)
TriangularView &	operator= (const TriangularView &other)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC const NestedExpression &	nestedExpression () const
EIGEN_DEVICE_FUNC NestedExpression &	nestedExpression ()
EIGEN_DEVICE_FUNC const ConjugateReturnType	conjugate () const
EIGEN_DEVICE_FUNC const AdjointReturnType	adjoint () const
EIGEN_DEVICE_FUNC TransposeReturnType	transpose ()
EIGEN_DEVICE_FUNC const ConstTransposeReturnType	transpose () const
template<typename Other >
EIGEN_DEVICE_FUNC const Solve< TriangularView, Other >	solve (const MatrixBase< Other > &other) const
EIGEN_DEVICE_FUNC SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView ()
EIGEN_DEVICE_FUNC const SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView () const
	This is the const version of selfadjointView()
EIGEN_DEVICE_FUNC Scalar	determinant () const

Protected Types
typedef internal::traits< TriangularView >::MatrixTypeNested	MatrixTypeNested
typedef internal::traits< TriangularView >::MatrixTypeNestedNonRef	MatrixTypeNestedNonRef
typedef internal::remove_all< typename MatrixType::ConjugateReturnType >::type	MatrixConjugateReturnType

Protected Attributes
MatrixTypeNested	m_matrix

Detailed Description

template<typename _MatrixType, unsigned int _Mode>
class Eigen::TriangularView< _MatrixType, _Mode >

Expression of a triangular part in a matrix.

Parameters

MatrixType	the type of the object in which we are taking the triangular part
Mode	the kind of triangular matrix expression to construct. Can be Upper, Lower, UnitUpper, UnitLower, StrictlyUpper, or StrictlyLower. This is in fact a bit field; it must have either Upper or Lower, and additionally it may have UnitDiag or ZeroDiag or neither.

This class represents a triangular part of a matrix, not necessarily square. Strictly speaking, for rectangular matrices one should speak of "trapezoid" parts. This class is the return type of MatrixBase::triangularView() and SparseMatrixBase::triangularView(), and most of the time this is the only way it is used.

See also

MatrixBase::triangularView()

Member Function Documentation

adjoint()

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC const AdjointReturnType Eigen::TriangularView< _MatrixType, _Mode >::adjoint ( ) const

inline

See also

MatrixBase::adjoint() const

cols()

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC Index Eigen::TriangularView< _MatrixType, _Mode >::cols ( void  ) const

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

conjugate()

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC const ConjugateReturnType Eigen::TriangularView< _MatrixType, _Mode >::conjugate ( ) const

inline

See also

MatrixBase::conjugate() const

determinant()

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC Scalar Eigen::TriangularView< _MatrixType, _Mode >::determinant ( ) const

inline

Returns

the determinant of the triangular matrix

See also

MatrixBase::determinant()

nestedExpression() [1/2]

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC const NestedExpression& Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( ) const

inline

Returns

a const reference to the nested expression

nestedExpression() [2/2]

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC NestedExpression& Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( )

inline

Returns

a reference to the nested expression

rows()

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC Index Eigen::TriangularView< _MatrixType, _Mode >::rows ( void  ) const

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

selfadjointView()

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC SelfAdjointView<MatrixTypeNestedNonRef,Mode> Eigen::TriangularView< _MatrixType, _Mode >::selfadjointView ( )

inline

Returns

a selfadjoint view of the referenced triangular part which must be either Upper or Lower.

This is a shortcut for

this->nestedExpression().selfadjointView<(*this)::Mode>() 

See also

MatrixBase::selfadjointView()

transpose() [1/2]

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC TransposeReturnType Eigen::TriangularView< _MatrixType, _Mode >::transpose ( )

inline

See also

MatrixBase::transpose()

transpose() [2/2]

template<typename _MatrixType, unsigned int _Mode>

EIGEN_DEVICE_FUNC const ConstTransposeReturnType Eigen::TriangularView< _MatrixType, _Mode >::transpose ( ) const

inline

See also

MatrixBase::transpose() const

---

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

• third-party-libs/eigen3/Eigen/src/Core/TriangularMatrix.h