Represents a sequence of transpositions (row/column interchange) More...
Inheritance diagram for Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >:
Public Types | |
| typedef TranspositionsBase< Transpositions > | Base |
| typedef Traits::IndicesType | IndicesType |
| typedef IndicesType::Scalar | StorageIndex |
| Public Types inherited from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ > > | |
| typedef Eigen::Index | Index |
| typedef Traits::IndicesType | IndicesType |
| typedef IndicesType::Scalar | StorageIndex |
Public Member Functions | |
| IndicesType & | indices () |
| const IndicesType & | indices () const |
| template<typename OtherDerived > | |
| Transpositions & | operator= (const TranspositionsBase< OtherDerived > &other) |
| Transpositions () | |
| template<typename Other > | |
| Transpositions (const MatrixBase< Other > &indices) | |
| template<typename OtherDerived > | |
| Transpositions (const TranspositionsBase< OtherDerived > &other) | |
| Transpositions (Index size) | |
| Public Member Functions inherited from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ > > | |
| const StorageIndex & | coeff (Index i) const |
| StorageIndex & | coeffRef (Index i) |
| Index | cols () const |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ > & | derived () |
| const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ > & | derived () const |
| IndicesType & | indices () |
| const IndicesType & | indices () const |
| Transpose< TranspositionsBase > | inverse () const |
| StorageIndex & | operator() (Index i) |
| const StorageIndex & | operator() (Index i) const |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ > & | operator= (const TranspositionsBase< OtherDerived > &other) |
| StorageIndex & | operator[] (Index i) |
| const StorageIndex & | operator[] (Index i) const |
| void | resize (Index newSize) |
| Index | rows () const |
| void | setIdentity () |
| Index | size () const |
| Transpose< TranspositionsBase > | transpose () const |
Protected Attributes | |
| IndicesType | m_indices |
Private Types | |
| typedef internal::traits< Transpositions > | Traits |
Detailed Description
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex_>
class Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >
Represents a sequence of transpositions (row/column interchange)
- Template Parameters
-
SizeAtCompileTime the number of transpositions, or Dynamic MaxSizeAtCompileTime the maximum number of transpositions, or Dynamic. This optional parameter defaults to SizeAtCompileTime. Most of the time, you should not have to specify it.
This class represents a permutation transformation as a sequence of n transpositions \([T_{n-1} \ldots T_{i} \ldots T_{0}]\). It is internally stored as a vector of integers indices. Each transposition \( T_{i} \) applied on the left of a matrix ( \( T_{i} M\)) interchanges the rows i and indices[i] of the matrix M. A transposition applied on the right (e.g., \( M T_{i}\)) yields a column interchange.
Compared to the class PermutationMatrix, such a sequence of transpositions is what is computed during a decomposition with pivoting, and it is faster when applying the permutation in-place.
To apply a sequence of transpositions to a matrix, simply use the operator * as in the following example:
In this example, we detect that the matrix appears on both side, and so the transpositions are applied in-place without any temporary or extra copy.
- See also
- class PermutationMatrix
Definition at line 157 of file Transpositions.h.
Member Typedef Documentation
◆ Base
| typedef TranspositionsBase<Transpositions> Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >::Base |
Definition at line 162 of file Transpositions.h.
◆ IndicesType
| typedef Traits::IndicesType Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >::IndicesType |
Definition at line 163 of file Transpositions.h.
◆ StorageIndex
| typedef IndicesType::Scalar Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex_ >::StorageIndex |
Definition at line 164 of file Transpositions.h.
◆ Traits
|
private |
Definition at line 159 of file Transpositions.h.
Constructor & Destructor Documentation
◆ Transpositions() [1/4]
|
inline |
Definition at line 166 of file Transpositions.h.
◆ Transpositions() [2/4]
|
inline |
◆ Transpositions() [3/4]
|
inlineexplicit |
Generic constructor from expression of the transposition indices.
Definition at line 175 of file Transpositions.h.
◆ Transpositions() [4/4]
|
inline |
Constructs an uninitialized permutation matrix of given size.
Definition at line 187 of file Transpositions.h.
Member Function Documentation
◆ indices() [1/2]
|
inline |
- Returns
- a reference to the stored array representing the transpositions.
Definition at line 195 of file Transpositions.h.
◆ indices() [2/2]
|
inline |
◆ operator=()
|
inline |
Copies the other transpositions into *this
Definition at line 180 of file Transpositions.h.
Member Data Documentation
◆ m_indices
|
protected |
Definition at line 199 of file Transpositions.h.
The documentation for this class was generated from the following file: