Eigen::PermutationWrapper< _IndicesType > Class Template Reference

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

#include <PermutationMatrix.h>

Inheritance diagram for Eigen::PermutationWrapper< _IndicesType >:

Public Types
typedef Traits::IndicesType	IndicesType
Public Types inherited from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >
enum
typedef Matrix< StorageIndex, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType
typedef Traits::IndicesType	IndicesType
typedef Inverse< PermutationWrapper< _IndicesType > >	InverseReturnType
typedef PlainPermutationType	PlainObject
typedef PermutationMatrix< IndicesType::SizeAtCompileTime, IndicesType::MaxSizeAtCompileTime, StorageIndex >	PlainPermutationType
typedef void	Scalar
typedef Traits::StorageIndex	StorageIndex
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
const internal::remove_all< typename IndicesType::Nested >::type &	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)
EIGEN_DEVICE_FUNC Index	cols () const
Index	determinant () const
void	evalTo (MatrixBase< DenseDerived > &other) const
const IndicesType &	indices () const
IndicesType &	indices ()
InverseReturnType	inverse () const
PlainPermutationType	operator* (const PermutationBase< Other > &other) const
PlainPermutationType	operator* (const InverseImpl< Other, PermutationStorage > &other) const
PermutationWrapper< _IndicesType > &	operator= (const PermutationBase< OtherDerived > &other)
PermutationWrapper< _IndicesType > &	operator= (const TranspositionsBase< OtherDerived > &tr)
void	resize (Index newSize)
EIGEN_DEVICE_FUNC Index	rows () const
void	setIdentity ()
void	setIdentity (Index newSize)
EIGEN_DEVICE_FUNC Index	size () const
DenseMatrixType	toDenseMatrix () const
InverseReturnType	transpose () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	const_derived () const
EIGEN_DEVICE_FUNC Derived &	derived ()
EIGEN_DEVICE_FUNC const Derived &	derived () const
template<typename Dest >
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
template<typename Dest >
EIGEN_DEVICE_FUNC 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
Protected Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >
void	assignProduct (const Lhs &lhs, const Rhs &rhs)
void	assignTranspose (const PermutationBase< OtherDerived > &other)

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 486 of file PermutationMatrix.h.

Member Typedef Documentation

Base

template<typename _IndicesType>

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

private

Definition at line 488 of file PermutationMatrix.h.

IndicesType

template<typename _IndicesType>

typedef Traits::IndicesType Eigen::PermutationWrapper< _IndicesType >::IndicesType

Definition at line 493 of file PermutationMatrix.h.

Traits

template<typename _IndicesType>

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

private

Definition at line 489 of file PermutationMatrix.h.

Constructor & Destructor Documentation

PermutationWrapper()

template<typename _IndicesType>

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

inline

Definition at line 496 of file PermutationMatrix.h.

Member Function Documentation

indices()

template<typename _IndicesType>

const internal::remove_all<typename IndicesType::Nested>::type& Eigen::PermutationWrapper< _IndicesType >::indices ( ) const

inline

const version of indices().

Definition at line 502 of file PermutationMatrix.h.

Member Data Documentation

m_indices

template<typename _IndicesType>

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

protected

Definition at line 506 of file PermutationMatrix.h.

---

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

• PermutationMatrix.h