Public Types | Public Member Functions | Protected Member Functions | Private Types | Friends | List of all members
Eigen::InverseImpl< PermutationType, PermutationStorage > Class Template Reference

#include <PermutationMatrix.h>

Inheritance diagram for Eigen::InverseImpl< PermutationType, PermutationStorage >:
Inheritance graph
[legend]

Public Types

enum  { RowsAtCompileTime = PermTraits::RowsAtCompileTime, ColsAtCompileTime = PermTraits::ColsAtCompileTime, MaxRowsAtCompileTime = PermTraits::MaxRowsAtCompileTime, MaxColsAtCompileTime = PermTraits::MaxColsAtCompileTime }
 
typedef PermutationType::DenseMatrixType DenseMatrixType
 
typedef Inverse< PermutationType > InverseType
 
- Public Types inherited from Eigen::EigenBase< Inverse< PermutationType > >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Inverse< PermutationType > >::StorageKind StorageKind
 

Public Member Functions

PlainPermutationType eval () const
 
template<typename DenseDerived >
void evalTo (MatrixBase< DenseDerived > &other) const
 
template<typename OtherDerived >
const Product< InverseType, OtherDerived, AliasFreeProductoperator* (const MatrixBase< OtherDerived > &matrix) const
 
DenseMatrixType toDenseMatrix () const
 
- Public Member Functions inherited from Eigen::EigenBase< Inverse< PermutationType > >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Inverse< PermutationType > & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Inverse< PermutationType > & const_derived () const
 
EIGEN_DEVICE_FUNC Inverse< PermutationType > & derived ()
 
EIGEN_DEVICE_FUNC const Inverse< PermutationType > & derived () const
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 

Protected Member Functions

 InverseImpl ()
 

Private Types

typedef internal::traits< PermutationType > PermTraits
 
typedef PermutationType::PlainPermutationType PlainPermutationType
 

Friends

template<typename OtherDerived >
const Product< OtherDerived, InverseType, AliasFreeProductoperator* (const MatrixBase< OtherDerived > &matrix, const InverseType &trPerm)
 

Detailed Description

template<typename PermutationType>
class Eigen::InverseImpl< PermutationType, PermutationStorage >

Definition at line 536 of file PermutationMatrix.h.

Member Typedef Documentation

◆ DenseMatrixType

template<typename PermutationType >
typedef PermutationType::DenseMatrixType Eigen::InverseImpl< PermutationType, PermutationStorage >::DenseMatrixType

Definition at line 548 of file PermutationMatrix.h.

◆ InverseType

template<typename PermutationType >
typedef Inverse<PermutationType> Eigen::InverseImpl< PermutationType, PermutationStorage >::InverseType

Definition at line 544 of file PermutationMatrix.h.

◆ PermTraits

template<typename PermutationType >
typedef internal::traits<PermutationType> Eigen::InverseImpl< PermutationType, PermutationStorage >::PermTraits
private

Definition at line 540 of file PermutationMatrix.h.

◆ PlainPermutationType

template<typename PermutationType >
typedef PermutationType::PlainPermutationType Eigen::InverseImpl< PermutationType, PermutationStorage >::PlainPermutationType
private

Definition at line 539 of file PermutationMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename PermutationType >
anonymous enum
Enumerator
RowsAtCompileTime 
ColsAtCompileTime 
MaxRowsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 549 of file PermutationMatrix.h.

Constructor & Destructor Documentation

◆ InverseImpl()

template<typename PermutationType >
Eigen::InverseImpl< PermutationType, PermutationStorage >::InverseImpl ( )
inlineprotected

Definition at line 542 of file PermutationMatrix.h.

Member Function Documentation

◆ eval()

template<typename PermutationType >
PlainPermutationType Eigen::InverseImpl< PermutationType, PermutationStorage >::eval ( ) const
inline
Returns
the equivalent permutation matrix

Definition at line 568 of file PermutationMatrix.h.

◆ evalTo()

template<typename PermutationType >
template<typename DenseDerived >
void Eigen::InverseImpl< PermutationType, PermutationStorage >::evalTo ( MatrixBase< DenseDerived > &  other) const
inline

Definition at line 559 of file PermutationMatrix.h.

◆ operator*()

template<typename PermutationType >
template<typename OtherDerived >
const Product<InverseType, OtherDerived, AliasFreeProduct> Eigen::InverseImpl< PermutationType, PermutationStorage >::operator* ( const MatrixBase< OtherDerived > &  matrix) const
inline
Returns
the matrix with the inverse permutation applied to the rows.

Definition at line 585 of file PermutationMatrix.h.

◆ toDenseMatrix()

template<typename PermutationType >
DenseMatrixType Eigen::InverseImpl< PermutationType, PermutationStorage >::toDenseMatrix ( ) const
inline

Definition at line 570 of file PermutationMatrix.h.

Friends And Related Function Documentation

◆ operator*

template<typename PermutationType >
template<typename OtherDerived >
const Product<OtherDerived, InverseType, AliasFreeProduct> operator* ( const MatrixBase< OtherDerived > &  matrix,
const InverseType trPerm 
)
friend
Returns
the matrix with the inverse permutation applied to the columns.

Definition at line 576 of file PermutationMatrix.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:48