Represents a sequence of transpositions (row/column interchange) More...
#include <Transpositions.h>
Public Types | |
typedef TranspositionsBase < Transpositions > | Base |
typedef IndicesType::Scalar | Index |
typedef Traits::IndicesType | IndicesType |
Public Member Functions | |
const Index & | coeff (Index i) const |
Index & | coeffRef (Index i) |
Transpositions < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | derived () |
const Transpositions < SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & | derived () const |
const IndicesType & | indices () const |
IndicesType & | indices () |
Transpose< TranspositionsBase > | inverse () const |
const Index & | operator() (Index i) const |
Index & | operator() (Index i) |
template<typename OtherDerived > | |
Transpositions & | operator= (const TranspositionsBase< OtherDerived > &other) |
const Index & | operator[] (Index i) const |
Index & | operator[] (Index i) |
void | resize (int size) |
void | setIdentity () |
Index | size () const |
Transpose< TranspositionsBase > | transpose () const |
Transpositions () | |
template<typename OtherDerived > | |
Transpositions (const TranspositionsBase< OtherDerived > &other) | |
template<typename Other > | |
Transpositions (const MatrixBase< Other > &indices) | |
Transpositions (Index size) | |
Protected Attributes | |
IndicesType | m_indices |
Represents a sequence of transpositions (row/column interchange)
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 . 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:
Transpositions tr; MatrixXf mat; mat = tr * mat;
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.
typedef TranspositionsBase<Transpositions> Base |
typedef IndicesType::Scalar Index |
typedef Traits::IndicesType IndicesType |
Transpositions | ( | ) | [inline] |
Transpositions | ( | const TranspositionsBase< OtherDerived > & | other | ) | [inline] |
Copy constructor.
Transpositions | ( | const MatrixBase< Other > & | indices | ) | [inline, explicit] |
Generic constructor from expression of the transposition indices.
Transpositions | ( | Index | size | ) | [inline] |
Constructs an uninitialized permutation matrix of given size.
Direct access to the underlying index vector
References TranspositionsBase< Derived >::indices().
Direct access to the underlying index vector
References TranspositionsBase< Derived >::indices().
Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & derived | ( | ) | [inline, inherited] |
const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & derived | ( | ) | const [inline, inherited] |
const IndicesType& indices | ( | ) | const [inline] |
const version of indices().
Reimplemented from TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
IndicesType& indices | ( | ) | [inline] |
Reimplemented from TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Transpose<TranspositionsBase> inverse | ( | ) | const [inline, inherited] |
References TranspositionsBase< Derived >::derived().
Direct access to the underlying index vector
References TranspositionsBase< Derived >::indices().
Direct access to the underlying index vector
References TranspositionsBase< Derived >::indices().
Transpositions& operator= | ( | const TranspositionsBase< OtherDerived > & | other | ) | [inline] |
Copies the other transpositions into *this
Reimplemented from TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Direct access to the underlying index vector
References TranspositionsBase< Derived >::indices().
Direct access to the underlying index vector
References TranspositionsBase< Derived >::indices().
Resizes to given size.
References TranspositionsBase< Derived >::indices().
void setIdentity | ( | ) | [inline, inherited] |
Sets *this
to represents an identity transformation
References TranspositionsBase< Derived >::coeffRef(), and TranspositionsBase< Derived >::indices().
References TranspositionsBase< Derived >::indices().
Transpose<TranspositionsBase> transpose | ( | ) | const [inline, inherited] |
References TranspositionsBase< Derived >::derived().
IndicesType m_indices [protected] |