MOAB  4.9.3pre
Public Types | Public Member Functions | Protected Attributes | Private Types
Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > Class Template Reference

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

#include <Transpositions.h>

Inheritance diagram for Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >:
Inheritance graph
[legend]
Collaboration diagram for Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef TranspositionsBase
< Transpositions > 		Base
typedef Traits::IndicesType IndicesType
typedef IndicesType::Scalar StorageIndex

Public Member Functions

 Transpositions ()
template<typename OtherDerived >
 Transpositions (const TranspositionsBase< OtherDerived > &other)
 Transpositions (const Transpositions &other)
template<typename Other >
 Transpositions (const MatrixBase< Other > &indices)
template<typename OtherDerived >
Transpositions & operator= (const TranspositionsBase< OtherDerived > &other)
Transpositions & operator= (const Transpositions &other)
 Transpositions (Index size)
const IndicesType & indices () const
IndicesType & indices ()

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:
SizeAtCompileTimethe number of transpositions, or Dynamic
MaxSizeAtCompileTimethe 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 158 of file Transpositions.h.

Member Typedef Documentation

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

Definition at line 163 of file Transpositions.h.

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

Reimplemented from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.

Definition at line 164 of file Transpositions.h.

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

Reimplemented from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.

Definition at line 165 of file Transpositions.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
typedef internal::traits<Transpositions> Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Traits [private]

Reimplemented from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.

Definition at line 160 of file Transpositions.h.

Constructor & Destructor Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( ) [inline]

Definition at line 167 of file Transpositions.h.

{}
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
template<typename OtherDerived >
Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( const TranspositionsBase< OtherDerived > &  other) [inline]

Copy constructor.

Definition at line 171 of file Transpositions.h.

      : m_indices(other.indices()) {}
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &  other) [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.

: m_indices(other.indices()) {}
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
template<typename Other >
Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( const MatrixBase< Other > &  indices) [inline, explicit]

Generic constructor from expression of the transposition indices.

Definition at line 182 of file Transpositions.h.

                                                                     : m_indices(indices)
    {}
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Transpositions ( Index  size) [inline]

Constructs an uninitialized permutation matrix of given size.

Definition at line 205 of file Transpositions.h.

                                      : m_indices(size)
    {}

Member Function Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
const IndicesType& Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::indices ( ) const [inline]

const version of indices().

Reimplemented from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.

Definition at line 209 of file Transpositions.h.

{ return m_indices; }
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
IndicesType& Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::indices ( ) [inline]
Returns:
a reference to the stored array representing the transpositions.

Reimplemented from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.

Definition at line 211 of file Transpositions.h.

{ return m_indices; }
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

Reimplemented from Eigen::TranspositionsBase< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.

Definition at line 187 of file Transpositions.h.

    {
      return Base::operator=(other);
    }
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
Transpositions& Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::operator= ( const Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &  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 196 of file Transpositions.h.

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

Member Data Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
IndicesType Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::m_indices [protected]

Definition at line 215 of file Transpositions.h.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines