#include <PermutationMatrix.h>
Public Member Functions |
void | addTo (Dest &dst) const |
void | applyThisOnTheLeft (Dest &dst) const |
void | applyThisOnTheRight (Dest &dst) const |
Map< PermutationMatrix
< SizeAtCompileTime,
MaxSizeAtCompileTime,
IndexType >, _PacketAccess > & | applyTranspositionOnTheLeft (Index i, Index j) |
Map< PermutationMatrix
< SizeAtCompileTime,
MaxSizeAtCompileTime,
IndexType >, _PacketAccess > & | applyTranspositionOnTheRight (Index i, Index j) |
Index | cols () const |
Map< PermutationMatrix
< SizeAtCompileTime,
MaxSizeAtCompileTime,
IndexType >, _PacketAccess > & | const_cast_derived () const |
const Map< PermutationMatrix
< SizeAtCompileTime,
MaxSizeAtCompileTime,
IndexType >, _PacketAccess > & | const_derived () const |
Map< PermutationMatrix
< SizeAtCompileTime,
MaxSizeAtCompileTime,
IndexType >, _PacketAccess > & | derived () |
const Map< PermutationMatrix
< SizeAtCompileTime,
MaxSizeAtCompileTime,
IndexType >, _PacketAccess > & | derived () const |
void | evalTo (Dest &dst) const |
const IndicesType & | indices () const |
IndicesType & | indices () |
Transpose< PermutationBase > | inverse () const |
| Map (const Index *indices) |
| Map (const Index *indices, Index size) |
PlainPermutationType | operator* (const PermutationBase< Other > &other) const |
PlainPermutationType | operator* (const Transpose< PermutationBase< Other > > &other) const |
template<typename Other > |
Map & | operator= (const PermutationBase< Other > &other) |
template<typename Other > |
Map & | operator= (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 |
Member Typedef Documentation
Constructor & Destructor Documentation
Member Function Documentation
void addTo |
( |
Dest & |
dst | ) |
const |
|
inlineinherited |
void applyThisOnTheLeft |
( |
Dest & |
dst | ) |
const |
|
inlineinherited |
void applyThisOnTheRight |
( |
Dest & |
dst | ) |
const |
|
inlineinherited |
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)
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)
Index cols |
( |
void |
| ) |
const |
|
inlineinherited |
Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & const_cast_derived |
( |
| ) |
const |
|
inlineinherited |
const Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & const_derived |
( |
| ) |
const |
|
inlineinherited |
Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & derived |
( |
| ) |
|
|
inlineinherited |
- Returns
- a reference to the derived object
const Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > & derived |
( |
| ) |
const |
|
inlineinherited |
- Returns
- a const reference to the derived object
void evalTo |
( |
Dest & |
dst | ) |
const |
|
inlineinherited |
const IndicesType& indices |
( |
| ) |
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 |
|
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).
- 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).
void resize |
( |
Index |
size | ) |
|
|
inlineinherited |
Index rows |
( |
void |
| ) |
const |
|
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.
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.
- 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
The documentation for this class was generated from the following file: