Permutation matrix. More...

#include <PermutationMatrix.h>

Inheritance diagram for PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >:

Public Types
typedef internal::traits < PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::Index	Index
typedef internal::traits < PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::StorageKind	StorageKind

Public Member Functions
void	addTo (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	applyTranspositionOnTheLeft (Index i, Index j)
PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	applyTranspositionOnTheRight (Index i, Index j)
Index	cols () const
PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	const_cast_derived () const
const PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	const_derived () const
PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	derived ()
const PermutationMatrix < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	derived () const
void	evalTo (Dest &dst) const
const IndicesType &	indices () const
IndicesType &	indices ()
Transpose< PermutationBase >	inverse () const
PlainPermutationType	operator* (const PermutationBase< Other > &other) const
PlainPermutationType	operator* (const Transpose< PermutationBase< Other > > &other) const
template<typename Other >
PermutationMatrix &	operator= (const PermutationBase< Other > &other)
template<typename Other >
PermutationMatrix &	operator= (const TranspositionsBase< Other > &tr)
	PermutationMatrix ()
	PermutationMatrix (int size)
template<typename OtherDerived >
	PermutationMatrix (const PermutationBase< OtherDerived > &other)
template<typename Other >
	PermutationMatrix (const MatrixBase< Other > &indices)
template<typename Other >
	PermutationMatrix (const TranspositionsBase< Other > &tr)
void	resize (Index size)
Index	rows () const
void	setIdentity ()
void	setIdentity (Index size)
Index	size () const
void	subTo (Dest &dst) const
DenseMatrixType	toDenseMatrix () const
Transpose< PermutationBase >	transpose () const

Protected Attributes
IndicesType	m_indices

Detailed Description

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

Permutation matrix.

Parameters:

SizeAtCompileTime	the number of rows/cols, or Dynamic
MaxSizeAtCompileTime	the maximum number of rows/cols, or Dynamic. This optional parameter defaults to SizeAtCompileTime. Most of the time, you should not have to specify it.
IndexType	the interger type of the indices

This class represents a permutation matrix, internally stored as a vector of integers.

See also:: class PermutationBase, class PermutationWrapper, class DiagonalMatrix

Member Typedef Documentation

typedef internal::traits<PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::Index Index

inherited

typedef internal::traits<PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::StorageKind StorageKind

inherited

Constructor & Destructor Documentation

PermutationMatrix ( )

inline

PermutationMatrix ( int size )

inline

Constructs an uninitialized permutation matrix of given size.

PermutationMatrix ( const PermutationBase< OtherDerived > & other )

inline

Copy constructor.

PermutationMatrix ( const MatrixBase< Other > & indices )

inlineexplicit

Generic constructor from expression of the indices. The indices array has the meaning that the permutations sends each integer i to indices[i].

Warning:: It is your responsibility to check that the indices array that you passes actually describes a permutation, i.e., each value between 0 and n-1 occurs exactly once, where n is the array's size.

PermutationMatrix ( const TranspositionsBase< Other > & tr )

inlineexplicit

Convert the Transpositions tr to a permutation matrix

Member Function Documentation

void addTo ( Dest & dst ) const

inlineinherited

void applyThisOnTheLeft ( Dest & dst ) const

inlineinherited

void applyThisOnTheRight ( Dest & dst ) const

inlineinherited

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & applyTranspositionOnTheLeft	(	Index	i,
		Index	j
	)

inlineinherited

Multiplies *this by the transposition $(ij)$ 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)

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & applyTranspositionOnTheRight	(	Index	i,
		Index	j
	)

inlineinherited

Multiplies *this by the transposition $(ij)$ 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)

Index cols ( void ) const

inlineinherited

Returns:: the number of columns

Reimplemented from EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & const_cast_derived ( ) const

inlineinherited

const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & const_derived ( ) const

inlineinherited

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & derived ( )

inlineinherited

Returns:: a reference to the derived object

const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & derived ( ) const

inlineinherited

Returns:: a const reference to the derived object

void evalTo ( Dest & dst ) const

inlineinherited

const IndicesType& indices ( ) const

inline

const version of indices().

Reimplemented from PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

Referenced by SparseSymmetricPermutationProduct< MatrixType, UpLo >::evalTo(), and Eigen::internal::minimum_degree_ordering().

IndicesType& indices ( )

inline

Returns:: a reference to the stored array representing the permutation.

Reimplemented from PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

Transpose<PermutationBase> inverse ( ) const

inlineinherited

Returns:: the inverse permutation matrix.

Note:: This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization).

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

inlineinherited

Returns:: the product permutation matrix.

Note:: This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization).

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

inlineinherited

Returns:: the product of a permutation with another inverse permutation.

Note:: This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization).

PermutationMatrix& operator= ( const PermutationBase< Other > & other )

inline

Copies the other permutation into *this

PermutationMatrix& operator= ( const TranspositionsBase< Other > & tr )

inline

Assignment from the Transpositions tr

void resize ( Index size )

inlineinherited

Resizes to given size.

Index rows ( void ) const

inlineinherited

Returns:: the number of rows

Reimplemented from EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

void setIdentity ( )

inlineinherited

Sets *this to be the identity permutation matrix

void setIdentity ( Index size )

inlineinherited

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

Index size ( ) const

inlineinherited

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

Reimplemented from EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

void subTo ( Dest & dst ) const

inlineinherited

DenseMatrixType toDenseMatrix ( ) const

inlineinherited

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.

Transpose<PermutationBase> transpose ( ) const

inlineinherited

Returns:: the tranpose permutation matrix.

Note:: This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization).

Member Data Documentation

IndicesType m_indices

protected

Referenced by PermutationMatrix< RowsAtCompileTime, MaxRowsAtCompileTime >::indices(), and PermutationMatrix< RowsAtCompileTime, MaxRowsAtCompileTime >::operator=().

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

PermutationMatrix.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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