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.

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
Index	cols () const
const ConjugateReturnType	conjugate () const
Scalar	determinant () const
NestedExpression &	nestedExpression ()
const NestedExpression &	nestedExpression () const
Index	rows () const
SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView ()
const SelfAdjointView< MatrixTypeNestedNonRef, Mode >	selfadjointView () const
TransposeReturnType	transpose ()
const ConstTransposeReturnType	transpose () const

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

inline

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

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

inline

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>

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

inline

See also

MatrixBase::transpose()

transpose() [2/2]

template<typename _MatrixType, unsigned int _Mode>

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:

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