Public Member Functions | Friends
PermutationBase< Derived > Class Template Reference

Base class for permutations. More...

+ Inheritance diagram for PermutationBase< Derived >:

List of all members.

Public Member Functions

Derived & applyTranspositionOnTheLeft (Index i, Index j)
Derived & applyTranspositionOnTheRight (Index i, Index j)
Index cols () const
const IndicesType & indices () const
IndicesType & indices ()
Transpose< PermutationBaseinverse () const
template<typename Other >
PlainPermutationType operator* (const PermutationBase< Other > &other) const
template<typename Other >
PlainPermutationType operator* (const Transpose< PermutationBase< Other > > &other) const
template<typename OtherDerived >
Derived & operator= (const PermutationBase< OtherDerived > &other)
template<typename OtherDerived >
Derived & operator= (const TranspositionsBase< OtherDerived > &tr)
void resize (Index size)
Index rows () const
void setIdentity ()
void setIdentity (Index size)
Index size () const
DenseMatrixType toDenseMatrix () const
Transpose< PermutationBasetranspose () const
- Public Member Functions inherited from EigenBase< Derived >
Derived & derived ()
const Derived & derived () const

Friends

template<typename Other >
PlainPermutationType operator* (const Transpose< PermutationBase< Other > > &other, const PermutationBase &perm)

Detailed Description

template<typename Derived>
class Eigen::PermutationBase< Derived >

Base class for permutations.

Parameters:
Derivedthe derived class

This class is the base class for all expressions representing a permutation matrix, internally stored as a vector of integers. The convention followed here is that if $ \sigma $ is a permutation, the corresponding permutation matrix $ P_\sigma $ is such that if $ (e_1,\ldots,e_p) $ is the canonical basis, we have:

\[ P_\sigma(e_i) = e_{\sigma(i)}. \]

This convention ensures that for any two permutations $ \sigma, \tau $, we have:

\[ P_{\sigma\circ\tau} = P_\sigma P_\tau. \]

Permutation matrices are square and invertible.

Notice that in addition to the member functions and operators listed here, there also are non-member operator* to multiply any kind of permutation object with any kind of matrix expression (MatrixBase) on either side.

See also:
class PermutationMatrix, class PermutationWrapper

Member Function Documentation

Derived& applyTranspositionOnTheLeft ( Index  i,
Index  j 
)
inline

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)
Derived& applyTranspositionOnTheRight ( Index  i,
Index  j 
)
inline

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
inline
Returns:
the number of columns

Reimplemented from EigenBase< Derived >.

const IndicesType& indices ( ) const
inline
IndicesType& indices ( )
inline
Transpose<PermutationBase> inverse ( ) const
inline
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
inline
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
inline
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).
Derived& operator= ( const PermutationBase< OtherDerived > &  other)
inline

Copies the other permutation into *this

Derived& operator= ( const TranspositionsBase< OtherDerived > &  tr)
inline

Assignment from the Transpositions tr

void resize ( Index  size)
inline

Resizes to given size.

Index rows ( void  ) const
inline
Returns:
the number of rows

Reimplemented from EigenBase< Derived >.

void setIdentity ( )
inline

Sets *this to be the identity permutation matrix

void setIdentity ( Index  size)
inline

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

Index size ( ) const
inline
Returns:
the size of a side of the respective square matrix, i.e., the number of indices

Reimplemented from EigenBase< Derived >.

DenseMatrixType toDenseMatrix ( ) const
inline
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
inline
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).

Friends And Related Function Documentation

PlainPermutationType operator* ( const Transpose< PermutationBase< Other > > &  other,
const PermutationBase< Derived > &  perm 
)
friend
Returns:
the product of an inverse permutation with another 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).

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