Eigen::TranspositionsWrapper< _IndicesType > Class Template Reference

#include <src/eigen/Eigen/src/Core/Transpositions.h>

Inheritance diagram for Eigen::TranspositionsWrapper< _IndicesType >:

Collaboration diagram for Eigen::TranspositionsWrapper< _IndicesType >:

Public Types
typedef TranspositionsBase< TranspositionsWrapper >	Base
typedef Traits::IndicesType	IndicesType
typedef IndicesType::Scalar	StorageIndex
typedef Eigen::Index	Index

Public Member Functions
	TranspositionsWrapper (IndicesType &indices)
template<typename OtherDerived >
TranspositionsWrapper &	operator= (const TranspositionsBase< OtherDerived > &other)
TranspositionsWrapper &	operator= (const TranspositionsWrapper &other)
const IndicesType &	indices () const
IndicesType &	indices ()
TranspositionsWrapper< _IndicesType > &	derived ()
const TranspositionsWrapper< _IndicesType > &	derived () const
Index	size () const
Index	rows () const
Index	cols () const
const StorageIndex &	coeff (Index i) const
StorageIndex &	coeffRef (Index i)
const StorageIndex &	operator() (Index i) const
StorageIndex &	operator() (Index i)
const StorageIndex &	operator[] (Index i) const
StorageIndex &	operator[] (Index i)
void	resize (Index newSize)
void	setIdentity ()
Transpose< TranspositionsBase >	inverse () const
Transpose< TranspositionsBase >	transpose () const

Protected Attributes
IndicesType::Nested	m_indices

Private Types
typedef internal::traits< TranspositionsWrapper >	Traits

Detailed Description

template<typename _IndicesType>
class Eigen::TranspositionsWrapper< _IndicesType >

Member Typedef Documentation

Base

template<typename _IndicesType >

typedef TranspositionsBase<TranspositionsWrapper> Eigen::TranspositionsWrapper< _IndicesType >::Base

Index

typedef Eigen::Index Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::Index

inherited

IndicesType

template<typename _IndicesType >

typedef Traits::IndicesType Eigen::TranspositionsWrapper< _IndicesType >::IndicesType

StorageIndex

template<typename _IndicesType >

typedef IndicesType::Scalar Eigen::TranspositionsWrapper< _IndicesType >::StorageIndex

Traits

template<typename _IndicesType >

typedef internal::traits<TranspositionsWrapper> Eigen::TranspositionsWrapper< _IndicesType >::Traits

private

Constructor & Destructor Documentation

TranspositionsWrapper()

template<typename _IndicesType >

Eigen::TranspositionsWrapper< _IndicesType >::TranspositionsWrapper ( IndicesType &  indices )

inlineexplicit

      : m_indices(indices)
    {}

Member Function Documentation

coeff()

const StorageIndex & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::coeff ( Index  i ) const

inlineinherited

Direct access to the underlying index vector

{ return indices().coeff(i); }

coeffRef()

StorageIndex & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::coeffRef ( Index  i )

inlineinherited

Direct access to the underlying index vector

{ return indices().coeffRef(i); }

cols()

Index Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::cols ( ) const

inlineinherited

Returns

the number of columns of the equivalent permutation matrix

{ return indices().size(); }

derived() [1/2]

TranspositionsWrapper< _IndicesType > & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::derived ( )

inlineinherited

{ return *static_cast<Derived*>(this); }

derived() [2/2]

const TranspositionsWrapper< _IndicesType > & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::derived ( ) const

inlineinherited

{ return *static_cast<const Derived*>(this); }

indices() [1/2]

template<typename _IndicesType >

IndicesType & Eigen::TranspositionsWrapper< _IndicesType >::indices ( )

inline

Returns

a reference to the stored array representing the transpositions.

{ return m_indices; }

References Eigen::TranspositionsWrapper< _IndicesType >::m_indices.

indices() [2/2]

template<typename _IndicesType >

const IndicesType & Eigen::TranspositionsWrapper< _IndicesType >::indices ( ) const

inline

const version of indices().

{ return m_indices; }

References Eigen::TranspositionsWrapper< _IndicesType >::m_indices.

inverse()

Transpose< TranspositionsBase > Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::inverse ( ) const

inlineinherited

Returns

the inverse transformation

    { return Transpose<TranspositionsBase>(derived()); }

operator()() [1/2]

StorageIndex & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::operator() ( Index  i )

inlineinherited

Direct access to the underlying index vector

{ return indices()(i); }

operator()() [2/2]

const StorageIndex & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::operator() ( Index  i ) const

inlineinherited

Direct access to the underlying index vector

{ return indices()(i); }

operator=() [1/2]

template<typename _IndicesType >

template<typename OtherDerived >

TranspositionsWrapper & Eigen::TranspositionsWrapper< _IndicesType >::operator= ( const TranspositionsBase< OtherDerived > &  other )

inline

Copies the other transpositions into *this

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

References Eigen::TranspositionsBase< Derived >::operator=().

Here is the call graph for this function:

operator=() [2/2]

template<typename _IndicesType >

TranspositionsWrapper & Eigen::TranspositionsWrapper< _IndicesType >::operator= ( const TranspositionsWrapper< _IndicesType > &  other )

inline

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

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

References Eigen::TranspositionsWrapper< _IndicesType >::m_indices.

operator[]() [1/2]

StorageIndex & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::operator[] ( Index  i )

inlineinherited

Direct access to the underlying index vector

{ return indices()(i); }

operator[]() [2/2]

const StorageIndex & Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::operator[] ( Index  i ) const

inlineinherited

Direct access to the underlying index vector

{ return indices()(i); }

resize()

void Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::resize ( Index  newSize )

inlineinherited

Resizes to given size.

    {
      indices().resize(newSize);
    }

rows()

Index Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::rows ( ) const

inlineinherited

Returns

the number of rows of the equivalent permutation matrix

{ return indices().size(); }

setIdentity()

void Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::setIdentity ( )

inlineinherited

Sets *this to represents an identity transformation

    {
      for(StorageIndex i = 0; i < indices().size(); ++i)
        coeffRef(i) = i;
    }

size()

Index Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::size ( ) const

inlineinherited

Returns

the number of transpositions

{ return indices().size(); }

transpose()

Transpose< TranspositionsBase > Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >::transpose ( ) const

inlineinherited

Returns

the tranpose transformation

    { return Transpose<TranspositionsBase>(derived()); }

Member Data Documentation

m_indices

template<typename _IndicesType >

IndicesType::Nested Eigen::TranspositionsWrapper< _IndicesType >::m_indices

protected

Referenced by Eigen::TranspositionsWrapper< _IndicesType >::indices(), Eigen::TranspositionsWrapper< _IndicesType >::indices(), and Eigen::TranspositionsWrapper< _IndicesType >::operator=().

---

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

• src/eigen/Eigen/src/Core/PermutationMatrix.h
• src/eigen/Eigen/src/Core/Transpositions.h