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.

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
	PermutationWrapper (const IndicesType &indices)

const internal::remove_all< typenameIndicesType::Nested >::type &	indices () const
	const version of indices().

Public Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >
PermutationWrapper< _IndicesType > &	operator= (const PermutationBase< OtherDerived > &other)
	Copies the other permutation into *this.

PermutationWrapper< _IndicesType > &	operator= (const TranspositionsBase< OtherDerived > &tr)
	Assignment from the Transpositions tr.

PermutationWrapper< _IndicesType > &	operator= (const PermutationBase &other)
	This is a special case of the templated operator=.

Index	rows () const

Index	cols () const

Index	size () const

void	evalTo (MatrixBase< DenseDerived > &other) const

DenseMatrixType	toDenseMatrix () const

const IndicesType &	indices () const
	const version of indices().

IndicesType &	indices ()

void	resize (Index newSize)
	Resizes to given size.

void	setIdentity ()
	Sets *this to be the identity permutation matrix.

void	setIdentity (Index newSize)
	Sets *this to be the identity permutation matrix of given size.

PermutationWrapper< _IndicesType > &	applyTranspositionOnTheLeft (Index i, Index j)
	Multiplies *this by the transposition on the left.

PermutationWrapper< _IndicesType > &	applyTranspositionOnTheRight (Index i, Index j)
	Multiplies *this by the transposition on the right.

InverseReturnType	inverse () const

InverseReturnType	transpose () const

PlainPermutationType	operator* (const PermutationBase< Other > &other) const

PlainPermutationType	operator* (const InverseImpl< Other, PermutationStorage > &other) const

Index	determinant () const

EIGEN_DEVICE_FUNC PermutationWrapper< _IndicesType > &	derived ()

EIGEN_DEVICE_FUNC const PermutationWrapper< _IndicesType > &	derived () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()

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 Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC Index	size () const

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

Protected Attributes
IndicesType::Nested	m_indices

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.

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

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

External/Eigen/src/Core/PermutationMatrix.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description