Permutation matrix. More...
#include <PermutationMatrix.h>
Public Types | |
| typedef Traits::IndicesType | IndicesType |
Public Member Functions | |
| const IndicesType & | indices () const |
| IndicesType & | indices () |
| template<typename Other > | |
| PermutationMatrix & | operator= (const PermutationBase< Other > &other) |
| template<typename Other > | |
| PermutationMatrix & | operator= (const TranspositionsBase< Other > &tr) |
| PermutationMatrix & | operator= (const PermutationMatrix &other) |
| PermutationMatrix () | |
| PermutationMatrix (int size) | |
| template<typename OtherDerived > | |
| PermutationMatrix (const PermutationBase< OtherDerived > &other) | |
| PermutationMatrix (const PermutationMatrix &other) | |
| template<typename Other > | |
| PermutationMatrix (const MatrixBase< Other > &a_indices) | |
| template<typename Other > | |
| PermutationMatrix (const TranspositionsBase< Other > &tr) | |
| template<typename Other > | |
| PermutationMatrix (const Transpose< PermutationBase< Other > > &other) | |
| template<typename Lhs , typename Rhs > | |
| PermutationMatrix (internal::PermPermProduct_t, const Lhs &lhs, const Rhs &rhs) | |
Protected Attributes | |
| IndicesType | m_indices |
Private Types | |
| typedef PermutationBase < PermutationMatrix > | Base |
| typedef internal::traits < PermutationMatrix > | Traits |
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
Definition at line 312 of file PermutationMatrix.h.
Member Typedef Documentation
typedef PermutationBase<PermutationMatrix> Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::Base [private] |
Reimplemented from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 314 of file PermutationMatrix.h.
| typedef Traits::IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::IndicesType |
Reimplemented from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 319 of file PermutationMatrix.h.
typedef internal::traits<PermutationMatrix> Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::Traits [private] |
Reimplemented from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 315 of file PermutationMatrix.h.
Constructor & Destructor Documentation
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | ) | [inline] |
Definition at line 322 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | int | size | ) | [inline] |
Constructs an uninitialized permutation matrix of given size.
Definition at line 327 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | const PermutationBase< OtherDerived > & | other | ) | [inline] |
Copy constructor.
Definition at line 332 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | other | ) | [inline] |
Standard copy constructor. Defined only to prevent a default copy constructor from hiding the other templated constructor
Definition at line 338 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | const MatrixBase< Other > & | a_indices | ) | [inline, explicit] |
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.
Definition at line 349 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | const TranspositionsBase< Other > & | tr | ) | [inline, explicit] |
Convert the Transpositions tr to a permutation matrix
Definition at line 354 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | const Transpose< PermutationBase< Other > > & | other | ) | [inline] |
Definition at line 396 of file PermutationMatrix.h.
| Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix | ( | internal::PermPermProduct_t | , |
| const Lhs & | lhs, | ||
| const Rhs & | rhs | ||
| ) | [inline] |
Definition at line 402 of file PermutationMatrix.h.
Member Function Documentation
| const IndicesType& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::indices | ( | ) | const [inline] |
const version of indices().
Reimplemented from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 387 of file PermutationMatrix.h.
| IndicesType& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::indices | ( | ) | [inline] |
- Returns:
- a reference to the stored array representing the permutation.
Reimplemented from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 389 of file PermutationMatrix.h.
| PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= | ( | const PermutationBase< Other > & | other | ) | [inline] |
Copies the other permutation into *this
Definition at line 362 of file PermutationMatrix.h.
| PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= | ( | const TranspositionsBase< Other > & | tr | ) | [inline] |
Assignment from the Transpositions tr
Definition at line 370 of file PermutationMatrix.h.
| PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= | ( | const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | other | ) | [inline] |
This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.
Definition at line 379 of file PermutationMatrix.h.
Member Data Documentation
IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::m_indices [protected] |
Definition at line 411 of file PermutationMatrix.h.
The documentation for this class was generated from the following file: