Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
Eigen::TriangularView< _MatrixType, _Mode > Class Template Reference
Dense matrix and array manipulation » Reference » Core_Module

Expression of a triangular part in a matrix. More...

#include <TriangularMatrix.h>

Inheritance diagram for Eigen::TriangularView< _MatrixType, _Mode >:
Inheritance graph
[legend]

Public Types

enum  { Mode = _Mode, Flags = internal::traits<TriangularView>::Flags, TransposeMode, IsVectorAtCompileTime = false }
 
typedef TriangularView< const typename MatrixType::AdjointReturnType, TransposeMode > AdjointReturnType
 
typedef TriangularViewImpl< _MatrixType, _Mode, typename internal::traits< _MatrixType >::StorageKind > Base
 
typedef TriangularView< const MatrixConjugateReturnType, Mode > ConjugateReturnType
 
typedef TriangularView< const typename MatrixType::ConstTransposeReturnType, TransposeMode > ConstTransposeReturnType
 
typedef _MatrixType MatrixType
 
typedef internal::traits< TriangularView >::MatrixTypeNestedCleaned NestedExpression
 
typedef internal::traits< TriangularView >::Scalar Scalar
 
typedef internal::traits< TriangularView >::StorageKind StorageKind
 
typedef TriangularView< typename MatrixType::TransposeReturnType, TransposeMode > TransposeReturnType
 

Public Member Functions

EIGEN_DEVICE_FUNC const AdjointReturnType adjoint () const
 
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC const ConjugateReturnType conjugate () const
 
EIGEN_DEVICE_FUNC Scalar determinant () const
 
EIGEN_DEVICE_FUNC const NestedExpression & nestedExpression () const
 
EIGEN_DEVICE_FUNC NestedExpression & nestedExpression ()
 
TriangularView & operator= (const TriangularView &other)
 
EIGEN_DEVICE_FUNC Index rows () const
 
EIGEN_DEVICE_FUNC SelfAdjointView< MatrixTypeNestedNonRef, Mode > selfadjointView ()
 
EIGEN_DEVICE_FUNC const SelfAdjointView< MatrixTypeNestedNonRef, Mode > selfadjointView () const
 
template<typename Other >
EIGEN_DEVICE_FUNC const Solve< TriangularView, Other > solve (const MatrixBase< Other > &other) const
 
EIGEN_DEVICE_FUNC TransposeReturnType transpose ()
 
EIGEN_DEVICE_FUNC const ConstTransposeReturnType transpose () const
 
EIGEN_DEVICE_FUNC TriangularView (MatrixType &matrix)
 

Protected Types

typedef internal::remove_all< typename MatrixType::ConjugateReturnType >::type MatrixConjugateReturnType
 
typedef internal::traits< TriangularView >::MatrixTypeNested MatrixTypeNested
 
typedef internal::traits< TriangularView >::MatrixTypeNestedNonRef MatrixTypeNestedNonRef
 

Protected Attributes

MatrixTypeNested m_matrix
 

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

Definition at line 186 of file TriangularMatrix.h.

Member Typedef Documentation

template<typename _MatrixType, unsigned int _Mode>
typedef TriangularView<const typename MatrixType::AdjointReturnType,TransposeMode> Eigen::TriangularView< _MatrixType, _Mode >::AdjointReturnType

Definition at line 245 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef TriangularViewImpl<_MatrixType, _Mode, typename internal::traits<_MatrixType>::StorageKind > Eigen::TriangularView< _MatrixType, _Mode >::Base

Definition at line 191 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef TriangularView<const MatrixConjugateReturnType,Mode> Eigen::TriangularView< _MatrixType, _Mode >::ConjugateReturnType

Definition at line 239 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef TriangularView<const typename MatrixType::ConstTransposeReturnType,TransposeMode> Eigen::TriangularView< _MatrixType, _Mode >::ConstTransposeReturnType

Definition at line 261 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef internal::remove_all<typename MatrixType::ConjugateReturnType>::type Eigen::TriangularView< _MatrixType, _Mode >::MatrixConjugateReturnType
protected

Definition at line 199 of file TriangularMatrix.h.

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

Definition at line 193 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef internal::traits<TriangularView>::MatrixTypeNested Eigen::TriangularView< _MatrixType, _Mode >::MatrixTypeNested
protected

Definition at line 196 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef internal::traits<TriangularView>::MatrixTypeNestedNonRef Eigen::TriangularView< _MatrixType, _Mode >::MatrixTypeNestedNonRef
protected

Definition at line 197 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef internal::traits<TriangularView>::MatrixTypeNestedCleaned Eigen::TriangularView< _MatrixType, _Mode >::NestedExpression

Definition at line 204 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef internal::traits<TriangularView>::Scalar Eigen::TriangularView< _MatrixType, _Mode >::Scalar

Definition at line 192 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef internal::traits<TriangularView>::StorageKind Eigen::TriangularView< _MatrixType, _Mode >::StorageKind

Definition at line 203 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
typedef TriangularView<typename MatrixType::TransposeReturnType,TransposeMode> Eigen::TriangularView< _MatrixType, _Mode >::TransposeReturnType

Definition at line 251 of file TriangularMatrix.h.

Member Enumeration Documentation

template<typename _MatrixType, unsigned int _Mode>
anonymous enum
Enumerator
Mode 
Flags 
TransposeMode 
IsVectorAtCompileTime 

Definition at line 206 of file TriangularMatrix.h.

Constructor & Destructor Documentation

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC Eigen::TriangularView< _MatrixType, _Mode >::TriangularView ( MatrixType &  matrix)
inlineexplicit

Definition at line 217 of file TriangularMatrix.h.

Member Function Documentation

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

Definition at line 248 of file TriangularMatrix.h.

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

Returns
the number of columns.
See also
rows(), ColsAtCompileTime

Definition at line 229 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC const ConjugateReturnType Eigen::TriangularView< _MatrixType, _Mode >::conjugate ( ) const
inline
See also
MatrixBase::conjugate() const

Definition at line 242 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC Scalar Eigen::TriangularView< _MatrixType, _Mode >::determinant ( ) const
inline
Returns
the determinant of the triangular matrix
See also
MatrixBase::determinant()

Definition at line 309 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC const NestedExpression& Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( ) const
inline
Returns
a const reference to the nested expression

Definition at line 233 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC NestedExpression& Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( )
inline
Returns
a reference to the nested expression

Definition at line 237 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
TriangularView& Eigen::TriangularView< _MatrixType, _Mode >::operator= ( const TriangularView< _MatrixType, _Mode > &  other)
inline

Definition at line 221 of file TriangularMatrix.h.

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

Returns
the number of rows.
See also
cols(), RowsAtCompileTime

Definition at line 226 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC 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()

Definition at line 291 of file TriangularMatrix.h.

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

This is the const version of selfadjointView()

Definition at line 299 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
template<typename Other >
EIGEN_DEVICE_FUNC const Solve<TriangularView, Other> Eigen::TriangularView< _MatrixType, _Mode >::solve ( const MatrixBase< Other > &  other) const
inline

Definition at line 272 of file TriangularMatrix.h.

template<typename _MatrixType, unsigned int _Mode>
EIGEN_DEVICE_FUNC TransposeReturnType Eigen::TriangularView< _MatrixType, _Mode >::transpose ( )
inline
See also
MatrixBase::transpose()

Definition at line 254 of file TriangularMatrix.h.

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

Definition at line 264 of file TriangularMatrix.h.

Member Data Documentation

template<typename _MatrixType, unsigned int _Mode>
MatrixTypeNested Eigen::TriangularView< _MatrixType, _Mode >::m_matrix
protected

Definition at line 321 of file TriangularMatrix.h.

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

gtsam
Author(s):
autogenerated on Sat May 8 2021 02:55:41