Represents a sequence of transpositions (row/column interchange) More...
#include <Transpositions.h>
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 | |
| const IndicesType & | indices () const |
| IndicesType & | indices () |
| template<typename OtherDerived > | |
| Transpositions & | operator= (const TranspositionsBase< OtherDerived > &other) |
| Transpositions & | operator= (const Transpositions &other) |
| Transpositions () | |
| template<typename OtherDerived > | |
| Transpositions (const TranspositionsBase< OtherDerived > &other) | |
| Transpositions (const Transpositions &other) | |
| template<typename Other > | |
| Transpositions (const MatrixBase< Other > &indices) | |
| 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 |
| const IndicesType & | indices () const |
| IndicesType & | indices () |
| Transpose< TranspositionsBase > | inverse () const |
| const StorageIndex & | operator() (Index i) const |
| StorageIndex & | operator() (Index i) |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > & | operator= (const TranspositionsBase< OtherDerived > &other) |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > & | operator= (const TranspositionsBase &other) |
| const StorageIndex & | operator[] (Index i) const |
| StorageIndex & | operator[] (Index i) |
| 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}]$](form_33.png)
. It is internally stored as a vector of integers indices. Each transposition 
applied on the left of a matrix ( 
) interchanges the rows i and indices[i] of the matrix M. A transposition applied on the right (e.g., 
) 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 158 of file Transpositions.h.
Member Typedef Documentation
◆ Base
| typedef TranspositionsBase<Transpositions> Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Base |
Definition at line 163 of file Transpositions.h.
◆ IndicesType
| typedef Traits::IndicesType Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::IndicesType |
Definition at line 164 of file Transpositions.h.
◆ StorageIndex
| typedef IndicesType::Scalar Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::StorageIndex |
Definition at line 165 of file Transpositions.h.
◆ Traits
|
private |
Definition at line 160 of file Transpositions.h.
Constructor & Destructor Documentation
◆ Transpositions() [1/5]
|
inline |
Definition at line 167 of file Transpositions.h.
◆ Transpositions() [2/5]
|
inline |
Copy constructor.
Definition at line 171 of file Transpositions.h.
◆ Transpositions() [3/5]
|
inline |
Standard copy constructor. Defined only to prevent a default copy constructor from hiding the other templated constructor
Definition at line 177 of file Transpositions.h.
◆ Transpositions() [4/5]
|
inlineexplicit |
Generic constructor from expression of the transposition indices.
Definition at line 182 of file Transpositions.h.
◆ Transpositions() [5/5]
|
inline |
Constructs an uninitialized permutation matrix of given size.
Definition at line 205 of file Transpositions.h.
Member Function Documentation
◆ indices() [1/2]
|
inline |
const version of indices().
Definition at line 209 of file Transpositions.h.
◆ indices() [2/2]
|
inline |
- Returns
- a reference to the stored array representing the transpositions.
Definition at line 211 of file Transpositions.h.
◆ operator=() [1/2]
|
inline |
Copies the other transpositions into *this
Definition at line 187 of file Transpositions.h.
◆ operator=() [2/2]
|
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 196 of file Transpositions.h.
Member Data Documentation
◆ m_indices
|
protected |
Definition at line 215 of file Transpositions.h.
The documentation for this class was generated from the following file: