Eigen::PermutationWrapper< _IndicesType > Class Template Reference

---

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

Definition at line 495 of file Core.

Inheritance diagram for Eigen::PermutationWrapper< _IndicesType >:

List of all members.

Public Types
typedef internal::traits < PermutationWrapper < _IndicesType > >::StorageKind	StorageKind
typedef internal::traits < PermutationWrapper < _IndicesType > >::Index	Index
Public Member Functions
	PermutationWrapper (const IndicesType &indices)
const internal::remove_all < typename IndicesType::Nested > ::type &	indices () const
	const version of indices().
Index	rows () const
Index	cols () const
Index	size () const
DenseMatrixType	toDenseMatrix () const
IndicesType &	indices ()
void	resize (Index size)
	Resizes to given size.
void	setIdentity ()
	Sets *this to be the identity permutation matrix.
void	setIdentity (Index size)
	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.
Transpose< PermutationBase >	inverse () const
Transpose< PermutationBase >	transpose () const
PlainPermutationType	operator* (const PermutationBase< Other > &other) const
PlainPermutationType	operator* (const Transpose< PermutationBase< Other > > &other) const
PermutationWrapper < _IndicesType > &	derived ()
const PermutationWrapper < _IndicesType > &	derived () const
PermutationWrapper < _IndicesType > &	const_cast_derived () const
const PermutationWrapper < _IndicesType > &	const_derived () const
void	evalTo (Dest &dst) const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
Protected Attributes
const IndicesType::Nested	m_indices
Private Types
typedef PermutationBase < PermutationWrapper >	Base
typedef internal::traits < PermutationWrapper >	Traits
Friends
PlainPermutationType	operator* (const Transpose< PermutationBase< Other > > &other, const PermutationBase &perm)

---

Member Typedef Documentation

template<typename _IndicesType >

typedef PermutationBase<PermutationWrapper> Eigen::PermutationWrapper< _IndicesType >::Base [private]

Reimplemented from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >.

Definition at line 497 of file Core.

typedef internal::traits<PermutationWrapper< _IndicesType > >::Index Eigen::EigenBase< PermutationWrapper< _IndicesType > >::Index [inherited]

Definition at line 46 of file Core.

typedef internal::traits<PermutationWrapper< _IndicesType > >::StorageKind Eigen::EigenBase< PermutationWrapper< _IndicesType > >::StorageKind [inherited]

Definition at line 45 of file Core.

template<typename _IndicesType >

typedef internal::traits<PermutationWrapper> Eigen::PermutationWrapper< _IndicesType >::Traits [private]

Reimplemented from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >.

Definition at line 498 of file Core.

---

Constructor & Destructor Documentation

template<typename _IndicesType >

Eigen::PermutationWrapper< _IndicesType >::PermutationWrapper

(

const IndicesType &

indices

)

[inline]

Definition at line 505 of file Core.

---

Member Function Documentation

void Eigen::EigenBase< PermutationWrapper< _IndicesType > >::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase< PermutationWrapper< _IndicesType > >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase< PermutationWrapper< _IndicesType > >::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

PermutationWrapper< _IndicesType > & Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::applyTranspositionOnTheLeft	(	Index	i,
		Index	j
	)		[inline, inherited]

Multiplies *this by the transposition on the left.

Returns:

a reference to *this.

Warning:

This is much slower than applyTranspositionOnTheRight(int,int): this has linear complexity and requires a lot of branching.

See also:

applyTranspositionOnTheRight(int,int)

Definition at line 183 of file Core.

PermutationWrapper< _IndicesType > & Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::applyTranspositionOnTheRight	(	Index	i,
		Index	j
	)		[inline, inherited]

Multiplies *this by the transposition on the right.

Returns:

a reference to *this.

This is a fast operation, it only consists in swapping two indices.

See also:

applyTranspositionOnTheLeft(int,int)

Definition at line 202 of file Core.

Index Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::cols

(

void

)

const [inline, inherited]

Returns:

the number of columns

Reimplemented from Eigen::EigenBase< PermutationWrapper< _IndicesType > >.

Definition at line 123 of file Core.

PermutationWrapper< _IndicesType > & Eigen::EigenBase< PermutationWrapper< _IndicesType > >::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const PermutationWrapper< _IndicesType > & Eigen::EigenBase< PermutationWrapper< _IndicesType > >::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

const PermutationWrapper< _IndicesType > & Eigen::EigenBase< PermutationWrapper< _IndicesType > >::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

PermutationWrapper< _IndicesType > & Eigen::EigenBase< PermutationWrapper< _IndicesType > >::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

void Eigen::EigenBase< PermutationWrapper< _IndicesType > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 67 of file Core.

template<typename _IndicesType >

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

(

)

const [inline]

const version of indices().

Reimplemented from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >.

Definition at line 511 of file Core.

IndicesType& Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::indices

(

)

[inline, inherited]

Returns:

a reference to the stored array representing the permutation.

Definition at line 150 of file Core.

Transpose<PermutationBase> Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::inverse

(

)

const [inline, inherited]

Returns:

the inverse permutation matrix.

Note:

Definition at line 213 of file Core.

PlainPermutationType Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::operator*

(

const Transpose< PermutationBase< Other > > &

other

)

const [inline, inherited]

Returns:

the product of a permutation with another inverse permutation.

Note:

Definition at line 255 of file Core.

PlainPermutationType Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::operator*

(

const PermutationBase< Other > &

other

)

const [inline, inherited]

Returns:

the product permutation matrix.

Note:

Definition at line 247 of file Core.

void Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::resize

(

Index

size

)

[inline, inherited]

Resizes to given size.

Definition at line 154 of file Core.

Index Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::rows

(

void

)

const [inline, inherited]

Returns:

the number of rows

Reimplemented from Eigen::EigenBase< PermutationWrapper< _IndicesType > >.

Definition at line 120 of file Core.

void Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::setIdentity

(

)

[inline, inherited]

Sets *this to be the identity permutation matrix.

Definition at line 160 of file Core.

void Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::setIdentity

(

Index

size

)

[inline, inherited]

Sets *this to be the identity permutation matrix of given size.

Definition at line 168 of file Core.

Index Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::size

(

)

const [inline, inherited]

Returns:

the size of a side of the respective square matrix, i.e., the number of indices

Reimplemented from Eigen::EigenBase< PermutationWrapper< _IndicesType > >.

Definition at line 126 of file Core.

void Eigen::EigenBase< PermutationWrapper< _IndicesType > >::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

DenseMatrixType Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::toDenseMatrix

(

)

const [inline, inherited]

Returns:

a Matrix object initialized from this permutation matrix. Notice that it is inefficient to return this Matrix object by value. For efficiency, favor using the Matrix constructor taking EigenBase objects.

Definition at line 142 of file Core.

Transpose<PermutationBase> Eigen::PermutationBase< PermutationWrapper< _IndicesType > >::transpose

(

)

const [inline, inherited]

Returns:

the tranpose permutation matrix.

Note:

Definition at line 219 of file Core.

---

Friends And Related Function Documentation

PlainPermutationType operator*	(	const Transpose< PermutationBase< Other > > &	other,
		const PermutationBase< PermutationWrapper< _IndicesType > > &	perm
	)		[friend, inherited]

Returns:

the product of an inverse permutation with another permutation.

Note:

Definition at line 263 of file Core.

---

Member Data Documentation

template<typename _IndicesType >

const IndicesType::Nested Eigen::PermutationWrapper< _IndicesType >::m_indices [protected]

Definition at line 515 of file Core.