Eigen::Transpose< MatrixType > Class Template Reference

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

+ Inheritance diagram for Eigen::Transpose< MatrixType >:

Public Types

typedef TransposeImpl< MatrixType, typename internal::traits< MatrixType >::StorageKind >::Base Base
 
typedef internal::ref_selector< MatrixType >::non_const_type MatrixTypeNested
 
typedef internal::remove_all_t< MatrixTypeNestedExpression
 

Public Member Functions

EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
std::remove_reference_t< MatrixTypeNested > & nestedExpression ()
 
const internal::remove_all_t< MatrixTypeNested > & nestedExpression () const
 
void resize (Index nrows, Index ncols)
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
 Transpose (MatrixType &matrix)
 

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

Definition at line 54 of file Transpose.h.

Member Typedef Documentation

◆ Base

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

Definition at line 61 of file Transpose.h.

◆ MatrixTypeNested

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

Definition at line 59 of file Transpose.h.

◆ NestedExpression

template<typename MatrixType >
typedef internal::remove_all_t<MatrixType> Eigen::Transpose< MatrixType >::NestedExpression

Definition at line 63 of file Transpose.h.

Constructor & Destructor Documentation

◆ Transpose()

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

Definition at line 66 of file Transpose.h.

66 : m_matrix(matrix) {}
internal::ref_selector< MatrixType >::non_const_type m_matrix
Definition: Transpose.h:92

Member Function Documentation

◆ cols()

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

Definition at line 73 of file Transpose.h.

73 { return m_matrix.rows(); }

◆ nestedExpression() [1/2]

template<typename MatrixType >
std::remove_reference_t<MatrixTypeNested>& Eigen::Transpose< MatrixType >::nestedExpression ( )
inline
Returns
the nested expression

Definition at line 83 of file Transpose.h.

83 { return m_matrix; }

◆ nestedExpression() [2/2]

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

Definition at line 78 of file Transpose.h.

78 { return m_matrix; }

◆ resize()

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

Definition at line 87 of file Transpose.h.

87  {
88  m_matrix.resize(ncols,nrows);
89  }

◆ rows()

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

Definition at line 71 of file Transpose.h.

71 { return m_matrix.cols(); }

Member Data Documentation

◆ m_matrix

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

Definition at line 92 of file Transpose.h.


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