Eigen::PermutationWrapper< IndicesType_ > Class Template Reference

Class to view a vector of integers as a permutation matrix. More...

Inheritance diagram for Eigen::PermutationWrapper< IndicesType_ >:

Public Member Functions
const internal::remove_all_t< typename IndicesType::Nested > &	indices () const
	PermutationWrapper (const IndicesType &indices)
Public Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< IndicesType_ > >
PermutationWrapper< IndicesType_ > &	applyTranspositionOnTheLeft (Index i, Index j)
PermutationWrapper< IndicesType_ > &	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
PermutationWrapper< IndicesType_ > &	operator= (const PermutationBase< OtherDerived > &other)
PermutationWrapper< IndicesType_ > &	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::Nested	m_indices

Private Types
typedef PermutationBase< PermutationWrapper >	Base
typedef internal::traits< PermutationWrapper >	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<typename IndicesType_>
class Eigen::PermutationWrapper< IndicesType_ >

Class to view a vector of integers as a permutation matrix.

Template Parameters

IndicesType_

the type of the vector of integer (can be any compatible expression)

This class allows to view any vector expression of integers as a permutation matrix.

See also

class PermutationBase, class PermutationMatrix

Definition at line 488 of file PermutationMatrix.h.

Member Typedef Documentation

Base

template<typename IndicesType_ >

typedef PermutationBase<PermutationWrapper> Eigen::PermutationWrapper< IndicesType_ >::Base

private

Definition at line 490 of file PermutationMatrix.h.

Traits

template<typename IndicesType_ >

typedef internal::traits<PermutationWrapper> Eigen::PermutationWrapper< IndicesType_ >::Traits

private

Definition at line 491 of file PermutationMatrix.h.

Constructor & Destructor Documentation

PermutationWrapper()

template<typename IndicesType_ >

Eigen::PermutationWrapper< IndicesType_ >::PermutationWrapper ( const IndicesType &  indices )

inline

Definition at line 498 of file PermutationMatrix.h.

      : m_indices(indices)
    {}

Member Function Documentation

indices()

template<typename IndicesType_ >

const internal::remove_all_t<typename IndicesType::Nested>& Eigen::PermutationWrapper< IndicesType_ >::indices ( ) const

inline

const version of indices().

Definition at line 504 of file PermutationMatrix.h.

{ return m_indices; }

Member Data Documentation

m_indices

template<typename IndicesType_ >

IndicesType::Nested Eigen::PermutationWrapper< IndicesType_ >::m_indices

protected

Definition at line 508 of file PermutationMatrix.h.

---

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

• PermutationMatrix.h