WPILibC++ 2023.4.3
Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
Eigen::TriangularView< _MatrixType, _Mode > Class Template Reference
Core module

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/TriangularMatrix.h>

Inheritance diagram for Eigen::TriangularView< _MatrixType, _Mode >:
Eigen::TriangularViewImpl< _MatrixType, _Mode, internal::traits< _MatrixType >::StorageKind >

Public Types

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

Public Member Functions

EIGEN_DEVICE_FUNC TriangularView (MatrixType &matrix)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC const NestedExpression & nestedExpression () const
 
EIGEN_DEVICE_FUNC NestedExpression & nestedExpression ()
 
EIGEN_DEVICE_FUNC const ConjugateReturnType conjugate () const
 
template<bool Cond>
EIGEN_DEVICE_FUNC internal::conditional< Cond, ConjugateReturnType, ConstTriangularView >::type conjugateIf () const
 
EIGEN_DEVICE_FUNC const AdjointReturnType adjoint () const
 
EIGEN_DEVICE_FUNC TransposeReturnType transpose ()
 
EIGEN_DEVICE_FUNC const ConstTransposeReturnType transpose () const
 
template<typename Other >
EIGEN_DEVICE_FUNC const Solve< TriangularView, Other > solve (const MatrixBase< Other > &other) const
 
EIGEN_DEVICE_FUNC SelfAdjointView< MatrixTypeNestedNonRef, Mode > selfadjointView ()
 
EIGEN_DEVICE_FUNC const SelfAdjointView< MatrixTypeNestedNonRef, Mode > selfadjointView () const
 This is the const version of selfadjointView() More...
 
EIGEN_DEVICE_FUNC Scalar determinant () const
 

Protected Types

typedef internal::traits< TriangularView >::MatrixTypeNested MatrixTypeNested
 
typedef internal::traits< TriangularView >::MatrixTypeNestedNonRef MatrixTypeNestedNonRef
 
typedef internal::remove_all< typenameMatrixType::ConjugateReturnType >::type MatrixConjugateReturnType
 
typedef TriangularView< typename internal::add_const< MatrixType >::type, _Mode > ConstTriangularView
 

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

Member Typedef Documentation

◆ AdjointReturnType

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

◆ Base

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

◆ ConjugateReturnType

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

◆ ConstTransposeReturnType

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

◆ ConstTriangularView

template<typename _MatrixType , unsigned int _Mode>
typedef TriangularView<typename internal::add_const<MatrixType>::type, _Mode> Eigen::TriangularView< _MatrixType, _Mode >::ConstTriangularView
protected

◆ MatrixConjugateReturnType

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

◆ MatrixType

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

◆ MatrixTypeNested

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

◆ MatrixTypeNestedNonRef

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

◆ NestedExpression

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

◆ Scalar

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

◆ StorageKind

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

◆ TransposeReturnType

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

Member Enumeration Documentation

◆ anonymous enum

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

Constructor & Destructor Documentation

◆ TriangularView()

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

Member Function Documentation

◆ adjoint()

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

◆ cols()

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

◆ conjugateIf()

template<typename _MatrixType , unsigned int _Mode>
template<bool Cond>
EIGEN_DEVICE_FUNC 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>
EIGEN_DEVICE_FUNC 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>
EIGEN_DEVICE_FUNC NestedExpression & Eigen::TriangularView< _MatrixType, _Mode >::nestedExpression ( )
inline
Returns
a reference to the nested expression

◆ nestedExpression() [2/2]

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

◆ rows()

template<typename _MatrixType , unsigned int _Mode>
EIGEN_DEVICE_FUNC 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>
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>()
Eigen::TriangularView::nestedExpression
EIGEN_DEVICE_FUNC const NestedExpression & nestedExpression() const
Definition: TriangularMatrix.h:233
Eigen::TriangularView::Mode
@ Mode
Definition: TriangularMatrix.h:209
See also
MatrixBase::selfadjointView()

◆ selfadjointView() [2/2]

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

◆ solve()

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

◆ transpose() [1/2]

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

◆ transpose() [2/2]

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

Member Data Documentation

◆ m_matrix

template<typename _MatrixType , unsigned int _Mode>
MatrixTypeNested Eigen::TriangularView< _MatrixType, _Mode >::m_matrix
protected
The documentation for this class was generated from the following files: