Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > Class Template Reference

Represents a sequence of transpositions (row/column interchange) More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Transpositions.h>

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 Traits::IndicesType	IndicesType
typedef IndicesType::Scalar	StorageIndex
typedef Eigen::Index	Index

Public Member Functions
	Transpositions ()
template<typename OtherDerived >
	Transpositions (const TranspositionsBase< OtherDerived > &other)
	Copy constructor. More...
template<typename Other >
	Transpositions (const MatrixBase< Other > &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. More...
	Transpositions (Index size)
	Constructs an uninitialized permutation matrix of given size. More...
EIGEN_DEVICE_FUNC const IndicesType &	indices () const
	const version of indices(). More...
EIGEN_DEVICE_FUNC IndicesType &	indices ()
Public Member Functions inherited from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
EIGEN_DEVICE_FUNC Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived ()
EIGEN_DEVICE_FUNC const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived () const
Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	operator= (const TranspositionsBase< OtherDerived > &other)
	Copies the other transpositions into *this. More...
EIGEN_DEVICE_FUNC Index	size () const
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC const StorageIndex &	coeff (Index i) const
	Direct access to the underlying index vector. More...
StorageIndex &	coeffRef (Index i)
	Direct access to the underlying index vector. More...
const StorageIndex &	operator() (Index i) const
	Direct access to the underlying index vector. More...
StorageIndex &	operator() (Index i)
	Direct access to the underlying index vector. More...
const StorageIndex &	operator[] (Index i) const
	Direct access to the underlying index vector. More...
StorageIndex &	operator[] (Index i)
	Direct access to the underlying index vector. More...
EIGEN_DEVICE_FUNC const IndicesType &	indices () const
	const version of indices(). More...
EIGEN_DEVICE_FUNC IndicesType &	indices ()
void	resize (Index newSize)
	Resizes to given size. More...
void	setIdentity ()
	Sets *this to represents an identity transformation. More...
Transpose< TranspositionsBase >	inverse () const
Transpose< TranspositionsBase >	transpose () const

Protected Attributes
IndicesType	m_indices

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:

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.

See also

class PermutationMatrix

Member Typedef Documentation

Base

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef TranspositionsBase<Transpositions> Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Base

IndicesType

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef Traits::IndicesType Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::IndicesType

StorageIndex

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef IndicesType::Scalar Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::StorageIndex

Constructor & Destructor Documentation

Transpositions() [1/4]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( )

inline

Transpositions() [2/4]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename OtherDerived >

Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( const TranspositionsBase< OtherDerived > &  other )

inline

Copy constructor.

Transpositions() [3/4]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Other >

Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( const MatrixBase< Other > &  indices )

inlineexplicit

Generic constructor from expression of the transposition indices.

Transpositions() [4/4]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( Index  size )

inline

Constructs an uninitialized permutation matrix of given size.

Member Function Documentation

indices() [1/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

EIGEN_DEVICE_FUNC IndicesType & Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::indices ( )

inline

Returns

a reference to the stored array representing the transpositions.

indices() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

EIGEN_DEVICE_FUNC const IndicesType & Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::indices ( ) const

inline

const version of indices().

operator=()

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename OtherDerived >

Transpositions & Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::operator= ( const TranspositionsBase< OtherDerived > &  other )

inline

Copies the other transpositions into *this.

Member Data Documentation

m_indices

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

IndicesType Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::m_indices

protected

---

The documentation for this class was generated from the following files:

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/ForwardDeclarations.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Transpositions.h