W3cubDocs
/Eigen3Eigen::PermutationMatrix
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
class Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >
Permutation matrix.
- Template 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. _StorageIndex the integer 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
| IndicesType & | indices () |
| const IndicesType & | indices () const |
| template<typename Other > | |
| PermutationMatrix & | operator= (const PermutationBase< Other > &other) |
| template<typename Other > | |
| PermutationMatrix & | operator= (const TranspositionsBase< Other > &tr) |
| template<typename Other > | |
| PermutationMatrix (const MatrixBase< Other > &indices) | |
| template<typename OtherDerived > | |
| PermutationMatrix (const PermutationBase< OtherDerived > &other) | |
| template<typename Other > | |
| PermutationMatrix (const TranspositionsBase< Other > &tr) | |
| PermutationMatrix (Index size) | |
 Public Member Functions inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
| |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > & | applyTranspositionOnTheLeft (Index i, Index j) |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > & | applyTranspositionOnTheRight (Index i, Index j) |
| Index | cols () const |
| Index | determinant () const |
| IndicesType & | indices () |
| const IndicesType & | indices () const |
| InverseReturnType | inverse () const |
| PlainPermutationType | operator* (const InverseImpl< Other, PermutationStorage > &other) const |
| PlainPermutationType | operator* (const PermutationBase< Other > &other) const |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > & | operator= (const PermutationBase< OtherDerived > &other) |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > & | operator= (const TranspositionsBase< OtherDerived > &tr) |
| void | resize (Index newSize) |
| Index | rows () const |
| void | setIdentity () |
| void | setIdentity (Index newSize) |
| Index | size () const |
| DenseMatrixType | toDenseMatrix () const |
| InverseReturnType | transpose () const |
|
Public Member Functions inherited from Eigen::EigenBase< Derived >
| |
| EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
| Derived & | derived () |
| const Derived & | derived () const |
| EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
| EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
|
Public Types inherited from Eigen::EigenBase< Derived >
| |
| typedef Eigen::Index | Index |
| The interface type of indices. More... |
|
PermutationMatrix() [1/4]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
| inlineexplicit |
Constructs an uninitialized permutation matrix of given size.
PermutationMatrix() [2/4]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
template<typename OtherDerived >
| inline |
Copy constructor.
PermutationMatrix() [3/4]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
template<typename Other >
| 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() [4/4]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
template<typename Other >
| inlineexplicit |
Convert the Transpositions tr to a permutation matrix
indices() [1/2]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
| inline |
- Returns
- a reference to the stored array representing the permutation.
indices() [2/2]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
| inline |
const version of indices().
operator=() [1/2]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
template<typename Other >
| inline |
Copies the other permutation into *this
operator=() [2/2]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >
template<typename Other >
| inline |
Assignment from the Transpositions tr
The documentation for this class was generated from the following file:
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1PermutationMatrix.html