Eigen  3.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::TriangularView< _MatrixType, _Mode > Class Template Reference

Detailed Description

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

Expression of a triangular part in a matrix.

Parameters
MatrixTypethe type of the object in which we are taking the triangular part
Modethe 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 >.

Public Member Functions

const AdjointReturnType adjoint () const
 
Index cols () const
 
const ConjugateReturnType conjugate () const
 
Scalar determinant () const
 
const NestedExpression & nestedExpression () const
 
NestedExpression & nestedExpression ()
 
Index rows () const
 
SelfAdjointView
< MatrixTypeNestedNonRef, Mode > 
selfadjointView ()
 
const SelfAdjointView
< MatrixTypeNestedNonRef, Mode > 
selfadjointView () const
 
TransposeReturnType transpose ()
 
const ConstTransposeReturnType transpose () const
 

Member Function Documentation

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

Returns
the number of columns.
See Also
rows(), ColsAtCompileTime
template<typename _MatrixType, unsigned int _Mode>
const ConjugateReturnType Eigen::TriangularView< _MatrixType, _Mode >::conjugate ( ) const
inline
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()
template<typename _MatrixType, unsigned int _Mode>
const NestedExpression& Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( ) const
inline
Returns
a const reference to the nested expression
template<typename _MatrixType, unsigned int _Mode>
NestedExpression& Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( )
inline
Returns
a reference to the nested expression
template<typename _MatrixType, unsigned int _Mode>
Index Eigen::TriangularView< _MatrixType, _Mode >::rows ( void  ) const
inline

Returns
the number of rows.
See Also
cols(), RowsAtCompileTime
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()
template<typename _MatrixType, unsigned int _Mode>
const SelfAdjointView<MatrixTypeNestedNonRef,Mode> Eigen::TriangularView< _MatrixType, _Mode >::selfadjointView ( ) const
inline

This is the const version of selfadjointView()

template<typename _MatrixType, unsigned int _Mode>
TransposeReturnType Eigen::TriangularView< _MatrixType, _Mode >::transpose ( )
inline
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: