WPILibC++ 2023.4.3
Eigen::Transpose< MatrixType > Class Template Reference

Expression of the transpose of a matrix. More...

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

Inheritance diagram for Eigen::Transpose< MatrixType >:
Eigen::TransposeImpl< MatrixType, internal::traits< MatrixType >::StorageKind >

Public Types

typedef internal::ref_selector< MatrixType >::non_const_type MatrixTypeNested
 
typedef TransposeImpl< MatrixType, typenameinternal::traits< MatrixType >::StorageKind >::Base Base
 
typedef internal::remove_all< MatrixType >::type NestedExpression
 
- Public Types inherited from Eigen::TransposeImpl< MatrixType, internal::traits< MatrixType >::StorageKind >
typedef internal::generic_xpr_base< Transpose< MatrixType > >::type Base
 

Public Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Transpose (MatrixType &matrix)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const internal::remove_all< MatrixTypeNested >::typenestedExpression () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::remove_reference< MatrixTypeNested >::typenestedExpression ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void resize (Index nrows, Index ncols)
 

Protected Attributes

internal::ref_selector< MatrixType >::non_const_type m_matrix
 

Detailed Description

template<typename MatrixType>
class Eigen::Transpose< MatrixType >

Expression of the transpose of a matrix.

Template Parameters
MatrixTypethe type of the object of which we are taking the transpose

This class represents an expression of the transpose of a matrix. It is the return type of MatrixBase::transpose() and MatrixBase::adjoint() and most of the time this is the only way it is used.

See also
MatrixBase::transpose(), MatrixBase::adjoint()

Member Typedef Documentation

◆ Base

template<typename MatrixType >
typedef TransposeImpl<MatrixType,typenameinternal::traits<MatrixType>::StorageKind>::Base Eigen::Transpose< MatrixType >::Base

◆ MatrixTypeNested

template<typename MatrixType >
typedef internal::ref_selector<MatrixType>::non_const_type Eigen::Transpose< MatrixType >::MatrixTypeNested

◆ NestedExpression

template<typename MatrixType >
typedef internal::remove_all<MatrixType>::type Eigen::Transpose< MatrixType >::NestedExpression

Constructor & Destructor Documentation

◆ Transpose()

template<typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Transpose< MatrixType >::Transpose ( MatrixType &  matrix)
inlineexplicit

Member Function Documentation

◆ cols()

template<typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Transpose< MatrixType >::cols ( void  ) const
inline

◆ nestedExpression() [1/2]

template<typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::remove_reference< MatrixTypeNested >::type & Eigen::Transpose< MatrixType >::nestedExpression ( )
inline
Returns
the nested expression

◆ nestedExpression() [2/2]

template<typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const internal::remove_all< MatrixTypeNested >::type & Eigen::Transpose< MatrixType >::nestedExpression ( ) const
inline
Returns
the nested expression

◆ resize()

template<typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::Transpose< MatrixType >::resize ( Index  nrows,
Index  ncols 
)
inline

◆ rows()

template<typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Transpose< MatrixType >::rows ( void  ) const
inline

Member Data Documentation

◆ m_matrix

template<typename MatrixType >
internal::ref_selector<MatrixType>::non_const_type Eigen::Transpose< MatrixType >::m_matrix
protected

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