Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > Class Template Reference

---

Detailed Description

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType, int _PacketAccess>
class Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >

Definition at line 409 of file Core.

Inheritance diagram for Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >:

List of all members.

Public Types
typedef internal::traits< Map < PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::StorageKind	StorageKind
typedef internal::traits< Map < PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::Index	Index
Public Member Functions
	Map (const Index *indices)
	Map (const Index *indices, Index size)
template<typename Other >
Map &	operator= (const PermutationBase< Other > &other)
	Copies the other permutation into *this.
template<typename Other >
Map &	operator= (const TranspositionsBase< Other > &tr)
	Assignment from the Transpositions tr.
const IndicesType &	indices () const
	const version of indices().
IndicesType &	indices ()
Index	rows () const
Index	cols () const
Index	size () const
DenseMatrixType	toDenseMatrix () const
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.
Map< PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > &	applyTranspositionOnTheLeft (Index i, Index j)
	Multiplies *this by the transposition on the left.
Map< PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > &	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
Map< PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > &	derived ()
const Map< PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > &	derived () const
Map< PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > &	const_cast_derived () const
const Map< PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > &	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
IndicesType	m_indices
Private Types
typedef PermutationBase< Map >	Base
typedef internal::traits< Map >	Traits
Friends
PlainPermutationType	operator* (const Transpose< PermutationBase< Other > > &other, const PermutationBase &perm)

---

Member Typedef Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

typedef PermutationBase<Map> Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::Base [private]

Reimplemented from Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 412 of file Core.

typedef internal::traits<Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::Index Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::Index [inherited]

Definition at line 46 of file Core.

typedef internal::traits<Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::StorageKind Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::StorageKind [inherited]

Definition at line 45 of file Core.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

typedef internal::traits<Map> Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::Traits [private]

Reimplemented from Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 413 of file Core.

---

Constructor & Destructor Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::Map

(

const Index *

indices

)

[inline]

Definition at line 421 of file Core.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::Map	(	const Index *	indices,
		Index	size
	)		[inline]

Definition at line 425 of file Core.

---

Member Function Documentation

void Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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.

Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::cols

(

void

)

const [inline, inherited]

Returns:

the number of columns

Reimplemented from Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 123 of file Core.

Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

const Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

void Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 67 of file Core.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

IndicesType& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::indices

(

)

[inline]

Returns:

a reference to the stored array representing the permutation.

Reimplemented from Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 453 of file Core.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

const IndicesType& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::indices

(

)

const [inline]

const version of indices().

Reimplemented from Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 451 of file Core.

Transpose<PermutationBase> Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::inverse

(

)

const [inline, inherited]

Returns:

the inverse permutation matrix.

Note:

Definition at line 213 of file Core.

PlainPermutationType Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::operator*

(

const PermutationBase< Other > &

other

)

const [inline, inherited]

Returns:

the product permutation matrix.

Note:

Definition at line 247 of file Core.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

template<typename Other >

Map& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::operator=

(

const TranspositionsBase< Other > &

tr

)

[inline]

Assignment from the Transpositions tr.

Definition at line 436 of file Core.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

template<typename Other >

Map& Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::operator=

(

const PermutationBase< Other > &

other

)

[inline]

Copies the other permutation into *this.

Definition at line 431 of file Core.

void Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::resize

(

Index

size

)

[inline, inherited]

Resizes to given size.

Definition at line 154 of file Core.

Index Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::rows

(

void

)

const [inline, inherited]

Returns:

the number of rows

Reimplemented from Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 120 of file Core.

void Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::setIdentity

(

)

[inline, inherited]

Sets *this to be the identity permutation matrix.

Definition at line 160 of file Core.

void Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >.

Definition at line 126 of file Core.

void Eigen::EigenBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

DenseMatrixType Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >::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< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > > &	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<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType , int _PacketAccess>

IndicesType Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >::m_indices [protected]

Definition at line 457 of file Core.