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 Traits::IndicesType	IndicesType
typedef Traits::StorageIndex	StorageIndex
typedef Matrix< StorageIndex, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType
typedef PermutationMatrix< IndicesType::SizeAtCompileTime, IndicesType::MaxSizeAtCompileTime, StorageIndex >	PlainPermutationType
typedef PlainPermutationType	PlainObject
typedef Inverse< PermutationWrapper< IndicesType_ > >	InverseReturnType
typedef void	Scalar
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
	PermutationWrapper (const IndicesType &indices)
const internal::remove_all_t< typename IndicesType::Nested > &	indices () const
Public Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< IndicesType_ > >
PermutationWrapper< IndicesType_ > &	operator= (const PermutationBase< OtherDerived > &other)
PermutationWrapper< IndicesType_ > &	operator= (const TranspositionsBase< OtherDerived > &tr)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC Index	size () const
void	evalTo (MatrixBase< DenseDerived > &other) const
DenseMatrixType	toDenseMatrix () const
const IndicesType &	indices () const
IndicesType &	indices ()
void	resize (Index newSize)
void	setIdentity ()
void	setIdentity (Index newSize)
PermutationWrapper< IndicesType_ > &	applyTranspositionOnTheLeft (Index i, Index j)
PermutationWrapper< IndicesType_ > &	applyTranspositionOnTheRight (Index i, Index j)
InverseReturnType	inverse () const
InverseReturnType	transpose () const
PlainPermutationType	operator* (const PermutationBase< Other > &other) const
PlainPermutationType	operator* (const InverseImpl< Other, PermutationStorage > &other) const
Index	determinant () const
constexpr EIGEN_DEVICE_FUNC PermutationWrapper< IndicesType_ > &	derived ()
constexpr EIGEN_DEVICE_FUNC const PermutationWrapper< IndicesType_ > &	derived () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()
constexpr EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< Derived, Device >	device (Device &device)
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const Derived, Device >	device (Device &device) 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	assignTranspose (const PermutationBase< OtherDerived > &other)
void	assignProduct (const Lhs &lhs, const Rhs &rhs)

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

Member Typedef Documentation

Base

template<typename IndicesType_ >

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

private

IndicesType

template<typename IndicesType_ >

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

Traits

template<typename IndicesType_ >

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

private

Constructor & Destructor Documentation

PermutationWrapper()

template<typename IndicesType_ >

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

inline

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

{ return m_indices; }

References Eigen::PermutationWrapper< IndicesType_ >::m_indices.

Member Data Documentation

m_indices

template<typename IndicesType_ >

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

protected

Referenced by Eigen::PermutationWrapper< IndicesType_ >::indices().

---

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

• PermutationMatrix.h