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
const AdjointReturnType	adjoint () const
constexpr Index	cols () const noexcept
const ConjugateReturnType	conjugate () const
template<bool Cond>
std::conditional_t< Cond, ConjugateReturnType, ConstTriangularView >	conjugateIf () const
Scalar	determinant () const
NestedExpression &	nestedExpression ()
const NestedExpression &	nestedExpression () const
constexpr Index	rows () const noexcept
SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView ()
const SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView () const
const ConstTransposeReturnType	transpose () const
template<class Dummy = int>
TransposeReturnType	transpose (std::enable_if_t< Eigen::internal::is_lvalue< MatrixType >::value, Dummy * >=nullptr)

Member Function Documentation

adjoint()

template<typename MatrixType_, unsigned int Mode_>

const AdjointReturnType Eigen::TriangularView< MatrixType_, Mode_ >::adjoint ( ) const

inline

See also

MatrixBase::adjoint() const

cols()

template<typename MatrixType_, unsigned int Mode_>

Index Eigen::TriangularView< MatrixType_, Mode_ >::cols ( ) const

inlineconstexprnoexcept

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

conjugate()

template<typename MatrixType_, unsigned int Mode_>

const ConjugateReturnType Eigen::TriangularView< MatrixType_, Mode_ >::conjugate ( ) const

inline

See also

MatrixBase::conjugate() const

conjugateIf()

template<typename MatrixType_, unsigned int Mode_>

template<bool Cond>

std::conditional_t< Cond, ConjugateReturnType, ConstTriangularView > Eigen::TriangularView< MatrixType_, Mode_ >::conjugateIf ( ) const

inline

Returns

an expression of the complex conjugate of *this if Cond==true, returns *this otherwise.

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

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

inline

Returns

a reference to the nested expression

nestedExpression() [2/2]

template<typename MatrixType_, unsigned int Mode_>

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

inline

Returns

a const reference to the nested expression

rows()

template<typename MatrixType_, unsigned int Mode_>

Index Eigen::TriangularView< MatrixType_, Mode_ >::rows ( ) const

inlineconstexprnoexcept

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

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

transpose() [1/2]

template<typename MatrixType_, unsigned int Mode_>

const ConstTransposeReturnType Eigen::TriangularView< MatrixType_, Mode_ >::transpose ( ) const

inline

See also

MatrixBase::transpose() const

transpose() [2/2]

template<typename MatrixType_, unsigned int Mode_>

template<class Dummy = int>

TransposeReturnType Eigen::TriangularView< MatrixType_, Mode_ >::transpose ( std::enable_if_t< Eigen::internal::is_lvalue< MatrixType >::value, Dummy * > = nullptr )

inline

See also

MatrixBase::transpose()

---

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

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