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

Expression of a triangular part in a matrix.

Contents

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.

Public functions

auto adjoint() const -> const AdjointReturnType
auto cols() const -> Index
auto conjugate() const -> const ConjugateReturnType
template<bool Cond>
auto conjugateIf() const -> internal::conditional<Cond, ConjugateReturnType, ConstTriangularView>::type
auto determinant() const -> Scalar
auto nestedExpression() const -> const NestedExpression&
auto nestedExpression() -> NestedExpression&
auto rows() const -> Index
auto selfadjointView() -> SelfAdjointView<MatrixTypeNestedNonRef, Mode>
auto selfadjointView() const -> const SelfAdjointView<MatrixTypeNestedNonRef, Mode>
auto transpose() -> TransposeReturnType
auto transpose() const -> const ConstTransposeReturnType

Function documentation

template<typename _MatrixType, unsigned int _Mode>
const AdjointReturnType Eigen::TriangularView<_MatrixType, _Mode>::adjoint() const

template<typename _MatrixType, unsigned int _Mode>
Index Eigen::TriangularView<_MatrixType, _Mode>::cols() const

Returns the number of columns.

template<typename _MatrixType, unsigned int _Mode>
const ConjugateReturnType Eigen::TriangularView<_MatrixType, _Mode>::conjugate() const

template<typename _MatrixType, unsigned int _Mode> template<bool Cond>
internal::conditional<Cond, ConjugateReturnType, ConstTriangularView>::type Eigen::TriangularView<_MatrixType, _Mode>::conjugateIf() const

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

template<typename _MatrixType, unsigned int _Mode>
Scalar Eigen::TriangularView<_MatrixType, _Mode>::determinant() const

Returns the determinant of the triangular matrix

template<typename _MatrixType, unsigned int _Mode>
const NestedExpression& Eigen::TriangularView<_MatrixType, _Mode>::nestedExpression() const

Returns a const reference to the nested expression

template<typename _MatrixType, unsigned int _Mode>
NestedExpression& Eigen::TriangularView<_MatrixType, _Mode>::nestedExpression()

Returns a reference to the nested expression

template<typename _MatrixType, unsigned int _Mode>
Index Eigen::TriangularView<_MatrixType, _Mode>::rows() const

Returns the number of rows.

template<typename _MatrixType, unsigned int _Mode>
SelfAdjointView<MatrixTypeNestedNonRef, Mode> Eigen::TriangularView<_MatrixType, _Mode>::selfadjointView()

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

template<typename _MatrixType, unsigned int _Mode>
const SelfAdjointView<MatrixTypeNestedNonRef, Mode> Eigen::TriangularView<_MatrixType, _Mode>::selfadjointView() const

This is the const version of selfadjointView()

template<typename _MatrixType, unsigned int _Mode>
TransposeReturnType Eigen::TriangularView<_MatrixType, _Mode>::transpose()

template<typename _MatrixType, unsigned int _Mode>
const ConstTransposeReturnType Eigen::TriangularView<_MatrixType, _Mode>::transpose() const