Public Member Functions | Protected Attributes | Private Types | List of all members
Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ > Class Template Reference
+ Inheritance diagram for Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >:

Public Member Functions

IndicesType & indices ()
 
const IndicesType & indices () const
 
 Map (const StorageIndex *indicesPtr)
 
 Map (const StorageIndex *indicesPtr, Index size)
 
template<typename Other >
Map & operator= (const PermutationBase< Other > &other)
 
template<typename Other >
Map & operator= (const TranspositionsBase< Other > &tr)
 
- Public Member Functions inherited from Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ > >
Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ > & applyTranspositionOnTheLeft (Index i, Index j)
 
Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ > & applyTranspositionOnTheRight (Index i, Index j)
 
Index cols () const
 
Index determinant () const
 
IndicesType & indices ()
 
const IndicesType & indices () const
 
InverseReturnType inverse () const
 
PlainPermutationType operator* (const InverseImpl< Other, PermutationStorage > &other) const
 
PlainPermutationType operator* (const PermutationBase< Other > &other) const
 
Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ > & operator= (const PermutationBase< OtherDerived > &other)
 
Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ > & operator= (const TranspositionsBase< OtherDerived > &tr)
 
void resize (Index newSize)
 
Index rows () const
 
void setIdentity ()
 
void setIdentity (Index newSize)
 
Index size () const
 
DenseMatrixType toDenseMatrix () const
 
InverseReturnType transpose () const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
void addTo (Dest &dst) const
 
template<typename Dest >
void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
void applyThisOnTheRight (Dest &dst) const
 
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
Derived & const_cast_derived () const
 
const Derived & const_derived () const
 
Derived & derived ()
 
const Derived & derived () const
 
template<typename Dest >
void evalTo (Dest &dst) const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
template<typename Dest >
void subTo (Dest &dst) const
 

Protected Attributes

IndicesType m_indices
 

Private Types

typedef PermutationBase< Map > Base
 
typedef internal::traits< Map > Traits
 

Additional Inherited Members

- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Detailed Description

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_, int PacketAccess_>
class Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >

Definition at line 406 of file PermutationMatrix.h.

Member Typedef Documentation

◆ Base

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
typedef PermutationBase<Map> Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::Base
private

Definition at line 409 of file PermutationMatrix.h.

◆ Traits

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
typedef internal::traits<Map> Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::Traits
private

Definition at line 410 of file PermutationMatrix.h.

Constructor & Destructor Documentation

◆ Map() [1/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::Map ( const StorageIndex *  indicesPtr)
inline

Definition at line 418 of file PermutationMatrix.h.

419  : m_indices(indicesPtr)
420  {}

◆ Map() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::Map ( const StorageIndex *  indicesPtr,
Index  size 
)
inline

Definition at line 422 of file PermutationMatrix.h.

423  : m_indices(indicesPtr,size)
424  {}

Member Function Documentation

◆ indices() [1/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
IndicesType& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::indices ( )
inline
Returns
a reference to the stored array representing the permutation.

Definition at line 450 of file PermutationMatrix.h.

450 { return m_indices; }

◆ indices() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
const IndicesType& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::indices ( ) const
inline

const version of indices().

Definition at line 448 of file PermutationMatrix.h.

448 { return m_indices; }

◆ operator=() [1/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
template<typename Other >
Map& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::operator= ( const PermutationBase< Other > &  other)
inline

Copies the other permutation into *this

Definition at line 428 of file PermutationMatrix.h.

429  { return Base::operator=(other.derived()); }

◆ operator=() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
template<typename Other >
Map& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::operator= ( const TranspositionsBase< Other > &  tr)
inline

Assignment from the Transpositions tr

Definition at line 433 of file PermutationMatrix.h.

434  { return Base::operator=(tr.derived()); }

Member Data Documentation

◆ m_indices

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_ , int PacketAccess_>
IndicesType Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >, PacketAccess_ >::m_indices
protected

Definition at line 454 of file PermutationMatrix.h.

The documentation for this class was generated from the following file:
Generated on Tue Jul 18 2023 15:28:26 for Eigen by Doxygen 1.9.1 and the doxyYoda theme. This is an unofficial themed variant maintained by Rohit Goswami, based on the official documentation.