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

#include <Transpositions.h>

Inheritance diagram for Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >:

Collaboration diagram for Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >:

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)

	Transpositions (const Transpositions &other)

template<typename Other >
	Transpositions (const MatrixBase< Other > &a_indices)

template<typename OtherDerived >
Transpositions &	operator= (const TranspositionsBase< OtherDerived > &other)

Transpositions &	operator= (const Transpositions &other)

	Transpositions (Index size)

const IndicesType &	indices () const

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)

Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &	operator= (const TranspositionsBase &other)

Index	size () const

const Index &	coeff (Index i) const

Index &	coeffRef (Index i)

const Index &	operator() (Index i) const

Index &	operator() (Index i)

const Index &	operator[] (Index i) const

Index &	operator[] (Index i)

const IndicesType &	indices () const

IndicesType &	indices ()

void	resize (int newSize)

void	setIdentity ()

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:

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

Definition at line 156 of file Transpositions.h.

Constructor & Destructor Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

template<typename OtherDerived >

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

inline

Copy constructor.

Definition at line 169 of file Transpositions.h.

170 : m_indices(other.indices()) {}

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::Transpositions ( const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & other )

inline

Standard copy constructor. Defined only to prevent a default copy constructor from hiding the other templated constructor

Definition at line 175 of file Transpositions.h.

175 : m_indices(other.indices()) {}

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

template<typename Other >

Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::Transpositions ( const MatrixBase< Other > & a_indices )

inlineexplicit

Generic constructor from expression of the transposition indices.

Definition at line 180 of file Transpositions.h.

180 : m_indices(a_indices)

181 {}

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

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

inline

Constructs an uninitialized permutation matrix of given size.

Definition at line 203 of file Transpositions.h.

203 : m_indices(size)

204 {}

Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::size

Index size() const

Definition: Transpositions.h:81

Member Function Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

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

inline

const version of indices().

Definition at line 207 of file Transpositions.h.

207 { return m_indices; }

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

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

inline

Returns: a reference to the stored array representing the transpositions.

Definition at line 209 of file Transpositions.h.

209 { return m_indices; }

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

template<typename OtherDerived >

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

inline

Copies the other transpositions into *this

Definition at line 185 of file Transpositions.h.

     {
       return Base::operator=(other);
     }

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>

Transpositions& Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= ( const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > & other )

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 194 of file Transpositions.h.

     {
       m_indices = other.m_indices;
       return *this;
     }

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

C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/Core/Transpositions.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType> class Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >

Constructor & Destructor Documentation

Member Function Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
class Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >