Eigen::TriangularView< MatrixType_, Mode_ > Class Template Reference

#include <Eigen/src/Core/TriangularMatrix.h>

Detailed Description

template<typename MatrixType_, unsigned int Mode_>
class Eigen::TriangularView< MatrixType_, Mode_ >

Expression of a triangular part in a matrix.

Template 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()

Public Member Functions
Scalar	determinant () const
constexpr const NestedExpression &	nestedExpression () const noexcept
constexpr NestedExpression &	nestedExpression () noexcept
SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView ()
const SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView () const

Member Function Documentation

determinant()

template<typename MatrixType_, unsigned int Mode_>

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_>

const NestedExpression & Eigen::TriangularView< MatrixType_, Mode_ >::nestedExpression ( ) const

inlineconstexprnoexcept

Returns

a const reference to the nested expression

nestedExpression() [2/2]

template<typename MatrixType_, unsigned int Mode_>

NestedExpression & Eigen::TriangularView< MatrixType_, Mode_ >::nestedExpression ( )

inlineconstexprnoexcept

Returns

a reference to the nested expression

selfadjointView() [1/2]

template<typename MatrixType_, unsigned int Mode_>

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()

selfadjointView() [2/2]

template<typename MatrixType_, unsigned int Mode_>

const SelfAdjointView< MatrixTypeNestedNonRef, Mode > Eigen::TriangularView< MatrixType_, Mode_ >::selfadjointView ( ) const

inline

This is the const version of selfadjointView()

---

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

• /builds/libeigen/eigen/Eigen/src/Core/TriangularMatrix.h