Permutation matrix. More...
#include <PermutationMatrix.h>
Inheritance diagram for Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >:
Public Types | |
| typedef Traits::IndicesType | IndicesType |
 Public Types inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > > | |
| enum | |
| typedef Traits::IndicesType | IndicesType |
| typedef Traits::Scalar | Scalar |
| typedef Traits::Index | Index |
| typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime > | DenseMatrixType |
| typedef PermutationMatrix< IndicesType::SizeAtCompileTime, IndicesType::MaxSizeAtCompileTime, Index > | PlainPermutationType |
| Public Types inherited from Eigen::EigenBase< Derived > | |
| typedef internal::traits< Derived >::StorageKind | StorageKind |
| typedef internal::traits< Derived >::Index | Index |
Public Member Functions | |
| PermutationMatrix (int size) | |
| Constructs an uninitialized permutation matrix of given size. | |
| template<typename OtherDerived > | |
| PermutationMatrix (const PermutationBase< OtherDerived > &other) | |
| Copy constructor. More... | |
| PermutationMatrix (const PermutationMatrix &other) | |
| Standard copy constructor. More... | |
| template<typename Other > | |
| PermutationMatrix (const MatrixBase< Other > &a_indices) | |
| Generic constructor from expression of the indices. More... | |
| template<typename Other > | |
| PermutationMatrix (const TranspositionsBase< Other > &tr) | |
| Convert the Transpositions tr to a permutation matrix. | |
| template<typename Other > | |
| PermutationMatrix & | operator= (const PermutationBase< Other > &other) |
| Copies the other permutation into *this. | |
| template<typename Other > | |
| PermutationMatrix & | operator= (const TranspositionsBase< Other > &tr) |
| Assignment from the Transpositions tr. | |
| PermutationMatrix & | operator= (const PermutationMatrix &other) |
| This is a special case of the templated operator=. More... | |
| const IndicesType & | indices () const |
| const version of indices(). More... | |
| IndicesType & | indices () |
| template<typename Other > | |
| PermutationMatrix (const Transpose< PermutationBase< Other > > &other) | |
| template<typename Lhs , typename Rhs > | |
| PermutationMatrix (internal::PermPermProduct_t, const Lhs &lhs, const Rhs &rhs) | |
| Public Member Functions inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > > | |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | operator= (const PermutationBase< OtherDerived > &other) |
| Copies the other permutation into *this. | |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | operator= (const TranspositionsBase< OtherDerived > &tr) |
| Assignment from the Transpositions tr. | |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | operator= (const PermutationBase &other) |
| This is a special case of the templated operator=. More... | |
| Index | rows () const |
| Index | cols () const |
| Index | size () const |
| void | evalTo (MatrixBase< DenseDerived > &other) const |
| DenseMatrixType | toDenseMatrix () const |
| const IndicesType & | indices () const |
| const version of indices(). More... | |
| IndicesType & | indices () |
| void | resize (Index newSize) |
| Resizes to given size. | |
| void | setIdentity () |
| Sets *this to be the identity permutation matrix. | |
| void | setIdentity (Index newSize) |
| Sets *this to be the identity permutation matrix of given size. | |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | applyTranspositionOnTheLeft (Index i, Index j) |
| Multiplies *this by the transposition \((ij)\) on the left. More... | |
| PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | applyTranspositionOnTheRight (Index i, Index j) |
| Multiplies *this by the transposition \((ij)\) on the right. More... | |
| Transpose< PermutationBase > | inverse () const |
| Transpose< PermutationBase > | transpose () const |
| PlainPermutationType | operator* (const PermutationBase< Other > &other) const |
| PlainPermutationType | operator* (const Transpose< PermutationBase< Other > > &other) const |
| Index | determinant () const |
| Public Member Functions inherited from Eigen::EigenBase< Derived > | |
| Derived & | derived () |
| const Derived & | derived () const |
| Derived & | const_cast_derived () const |
| const Derived & | const_derived () const |
| Index | rows () const |
| Index | cols () const |
| Index | size () const |
| template<typename Dest > | |
| void | evalTo (Dest &dst) const |
| template<typename Dest > | |
| void | addTo (Dest &dst) const |
| template<typename Dest > | |
| void | subTo (Dest &dst) const |
| template<typename Dest > | |
| void | applyThisOnTheRight (Dest &dst) const |
| template<typename Dest > | |
| void | applyThisOnTheLeft (Dest &dst) const |
Protected Attributes | |
| IndicesType | m_indices |
Additional Inherited Members | |
| Protected Member Functions inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > > | |
| void | assignTranspose (const PermutationBase< OtherDerived > &other) |
| void | assignProduct (const Lhs &lhs, const Rhs &rhs) |
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
Constructor & Destructor Documentation
§ PermutationMatrix() [1/3]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename OtherDerived >
|
inline |
Copy constructor.
§ PermutationMatrix() [2/3]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
|
inline |
Standard copy constructor.
Defined only to prevent a default copy constructor from hiding the other templated constructor
§ PermutationMatrix() [3/3]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
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.
Member Function Documentation
§ indices() [1/2]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
|
inline |
const version of indices().
§ indices() [2/2]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
|
inline |
- Returns
- a reference to the stored array representing the permutation.
§ operator=()
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
|
inline |
This is a special case of the templated operator=.
Its purpose is to prevent a default operator= from hiding the templated operator=.
The documentation for this class was generated from the following file:
- vendor/eigen/Eigen/src/Core/PermutationMatrix.h
