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 | Index |
 Public Types inherited from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > > | |
| typedef Traits::IndicesType | IndicesType |
| typedef IndicesType::Scalar | Index |
Public Member Functions | |
| template<typename OtherDerived > | |
| Transpositions (const TranspositionsBase< OtherDerived > &other) | |
| Copy constructor. More... | |
| Transpositions (const Transpositions &other) | |
| Standard copy constructor. More... | |
| template<typename Other > | |
| Transpositions (const MatrixBase< Other > &a_indices) | |
| Generic constructor from expression of the transposition indices. More... | |
| template<typename OtherDerived > | |
| Transpositions & | operator= (const TranspositionsBase< OtherDerived > &other) |
Copies the other transpositions into *this. | |
| Transpositions & | operator= (const Transpositions &other) |
| This is a special case of the templated operator=. More... | |
| Transpositions (Index size) | |
| Constructs an uninitialized permutation matrix of given size. | |
| const IndicesType & | indices () const |
| const version of indices(). More... | |
| IndicesType & | indices () |
| Public Member Functions inherited from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > > | |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | derived () |
| const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | derived () const |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | operator= (const TranspositionsBase< OtherDerived > &other) |
Copies the other transpositions into *this. | |
| Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | operator= (const TranspositionsBase &other) |
| This is a special case of the templated operator=. More... | |
| Index | size () const |
| const Index & | coeff (Index i) const |
| Direct access to the underlying index vector. | |
| Index & | coeffRef (Index i) |
| Direct access to the underlying index vector. | |
| const Index & | operator() (Index i) const |
| Direct access to the underlying index vector. | |
| Index & | operator() (Index i) |
| Direct access to the underlying index vector. | |
| const Index & | operator[] (Index i) const |
| Direct access to the underlying index vector. | |
| Index & | operator[] (Index i) |
| Direct access to the underlying index vector. | |
| const IndicesType & | indices () const |
| const version of indices(). More... | |
| IndicesType & | indices () |
| void | resize (int newSize) |
| Resizes to given size. More... | |
| void | setIdentity () |
Sets *this to represents an identity transformation. | |
| Transpose< TranspositionsBase > | inverse () const |
| Transpose< TranspositionsBase > | transpose () const |
Protected Attributes | |
| IndicesType | m_indices |
Detailed Description
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
class Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >
Represents a sequence of transpositions (row/column interchange)
- 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
Constructor & Destructor Documentation
§ Transpositions() [1/3]
|
inline |
Copy constructor.
§ Transpositions() [2/3]
|
inline |
Standard copy constructor.
Defined only to prevent a default copy constructor from hiding the other templated constructor
§ Transpositions() [3/3]
|
inlineexplicit |
Generic constructor from expression of the transposition indices.
Member Function Documentation
§ indices() [1/2]
|
inline |
const version of indices().
§ indices() [2/2]
|
inline |
- Returns
- a reference to the stored array representing the transpositions.
§ operator=()
|
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/Transpositions.h
