Class to view a vector of integers as a permutation matrix.
More...
#include <PermutationMatrix.h>
Protected Attributes |
IndicesType::Nested | m_indices |
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
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 |
- Returns
- a reference to the derived object
- Returns
- a const reference to the derived object
void evalTo |
( |
Dest & |
dst | ) |
const |
|
inlineinherited |
- Returns
- a reference to the stored array representing the permutation.
const internal::remove_all<typename IndicesType::Nested>::type& 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
IndicesType::Nested m_indices |
|
protected |
The documentation for this class was generated from the following file: