W3cubDocs

/Eigen3

Eigen::TriangularView

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

Inherits Eigen::TriangularViewImpl< _MatrixType, _Mode, internal::traits< _MatrixType >::StorageKind >.

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

adjoint()

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

cols()

template<typename _MatrixType , unsigned int _Mode>
EIGEN_CONSTEXPR 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>
const ConjugateReturnType Eigen::TriangularView< _MatrixType, _Mode >::conjugate ( void ) const
inline
See also
MatrixBase::conjugate() const

conjugateIf()

template<typename _MatrixType , unsigned int _Mode>
template<bool Cond>
internal::conditional<Cond,ConjugateReturnType,ConstTriangularView>::type 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>
EIGEN_CONSTEXPR Index Eigen::TriangularView< _MatrixType, _Mode >::rows ( void ) 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

transpose() [2/2]

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

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

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1TriangularView.html