Eigen::TranspositionsBase< Derived > Class Template Reference

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

Inheritance diagram for Eigen::TranspositionsBase< Derived >:

Public Types
typedef Traits::IndicesType	IndicesType
typedef IndicesType::Scalar	StorageIndex
typedef Eigen::Index	Index

Public Member Functions
Derived &	derived ()
const Derived &	derived () const
template<typename OtherDerived >
Derived &	operator= (const TranspositionsBase< OtherDerived > &other)
Derived &	operator= (const TranspositionsBase &other)
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)
const IndicesType &	indices () const
IndicesType &	indices ()
void	resize (Index newSize)
void	setIdentity ()
Transpose< TranspositionsBase >	inverse () const
Transpose< TranspositionsBase >	transpose () const

Private Types
typedef internal::traits< Derived >	Traits

Detailed Description

template<typename Derived>
class Eigen::TranspositionsBase< Derived >

Member Typedef Documentation

Index

template<typename Derived >

typedef Eigen::Index Eigen::TranspositionsBase< Derived >::Index

IndicesType

template<typename Derived >

typedef Traits::IndicesType Eigen::TranspositionsBase< Derived >::IndicesType

StorageIndex

template<typename Derived >

typedef IndicesType::Scalar Eigen::TranspositionsBase< Derived >::StorageIndex

Traits

template<typename Derived >

typedef internal::traits<Derived> Eigen::TranspositionsBase< Derived >::Traits

private

Member Function Documentation

coeff()

template<typename Derived >

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

inline

Direct access to the underlying index vector

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

References Eigen::TranspositionsBase< Derived >::indices().

Referenced by Eigen::PermutationBase< Derived >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

coeffRef()

template<typename Derived >

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

inline

Direct access to the underlying index vector

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

References Eigen::TranspositionsBase< Derived >::indices().

Referenced by Eigen::TranspositionsBase< Derived >::setIdentity().

Here is the call graph for this function:

Here is the caller graph for this function:

cols()

template<typename Derived >

Index Eigen::TranspositionsBase< Derived >::cols ( ) const

inline

Returns

the number of columns of the equivalent permutation matrix

{ return indices().size(); }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

derived() [1/2]

template<typename Derived >

Derived & Eigen::TranspositionsBase< Derived >::derived ( )

inline

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

Referenced by Eigen::TranspositionsBase< Derived >::indices(), Eigen::TranspositionsBase< Derived >::indices(), Eigen::TranspositionsBase< Derived >::inverse(), Eigen::operator*(), Eigen::operator*(), Eigen::TranspositionsBase< Derived >::operator=(), Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::operator=(), Eigen::Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, _PacketAccess >::operator=(), Eigen::TranspositionsBase< Derived >::operator=(), and Eigen::TranspositionsBase< Derived >::transpose().

Here is the caller graph for this function:

derived() [2/2]

template<typename Derived >

const Derived & Eigen::TranspositionsBase< Derived >::derived ( ) const

inline

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

indices() [1/2]

template<typename Derived >

IndicesType & Eigen::TranspositionsBase< Derived >::indices ( )

inline

Returns

a reference to the stored array representing the transpositions.

{ return derived().indices(); }

References Eigen::TranspositionsBase< Derived >::derived().

Here is the call graph for this function:

indices() [2/2]

template<typename Derived >

const IndicesType & Eigen::TranspositionsBase< Derived >::indices ( ) const

inline

const version of indices().

{ return derived().indices(); }

References Eigen::TranspositionsBase< Derived >::derived().

Referenced by Eigen::TranspositionsBase< Derived >::coeff(), Eigen::TranspositionsBase< Derived >::coeffRef(), Eigen::TranspositionsBase< Derived >::cols(), Eigen::TranspositionsBase< Derived >::operator()(), Eigen::TranspositionsBase< Derived >::operator()(), Eigen::TranspositionsBase< Derived >::operator=(), Eigen::TranspositionsBase< Derived >::operator=(), Eigen::TranspositionsBase< Derived >::operator[](), Eigen::TranspositionsBase< Derived >::operator[](), Eigen::TranspositionsBase< Derived >::resize(), Eigen::TranspositionsBase< Derived >::rows(), Eigen::TranspositionsBase< Derived >::setIdentity(), and Eigen::TranspositionsBase< Derived >::size().

Here is the call graph for this function:

Here is the caller graph for this function:

inverse()

template<typename Derived >

Transpose< TranspositionsBase > Eigen::TranspositionsBase< Derived >::inverse ( ) const

inline

Returns

the inverse transformation

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

References Eigen::TranspositionsBase< Derived >::derived().

Here is the call graph for this function:

operator()() [1/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

{ return indices()(i); }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

operator()() [2/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

{ return indices()(i); }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

operator=() [1/2]

template<typename Derived >

Derived & Eigen::TranspositionsBase< Derived >::operator= ( const TranspositionsBase< Derived > &  other )

inline

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

    {
      indices() = other.indices();
      return derived();
    }

References Eigen::TranspositionsBase< Derived >::derived(), and Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

operator=() [2/2]

template<typename Derived >

template<typename OtherDerived >

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

inline

Copies the other transpositions into *this

    {
      indices() = other.indices();
      return derived();
    }

References Eigen::TranspositionsBase< Derived >::derived(), and Eigen::TranspositionsBase< Derived >::indices().

Referenced by Eigen::Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::operator=(), and Eigen::TranspositionsWrapper< _IndicesType >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

operator[]() [1/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

{ return indices()(i); }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

operator[]() [2/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

{ return indices()(i); }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

resize()

template<typename Derived >

void Eigen::TranspositionsBase< Derived >::resize ( Index  newSize )

inline

Resizes to given size.

    {
      indices().resize(newSize);
    }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

rows()

template<typename Derived >

Index Eigen::TranspositionsBase< Derived >::rows ( ) const

inline

Returns

the number of rows of the equivalent permutation matrix

{ return indices().size(); }

References Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

setIdentity()

template<typename Derived >

void Eigen::TranspositionsBase< Derived >::setIdentity ( )

inline

Sets *this to represents an identity transformation

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

References Eigen::TranspositionsBase< Derived >::coeffRef(), and Eigen::TranspositionsBase< Derived >::indices().

Here is the call graph for this function:

size()

template<typename Derived >

Index Eigen::TranspositionsBase< Derived >::size ( ) const

inline

Returns

the number of transpositions

{ return indices().size(); }

References Eigen::TranspositionsBase< Derived >::indices().

Referenced by Eigen::PermutationBase< Derived >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

transpose()

template<typename Derived >

Transpose< TranspositionsBase > Eigen::TranspositionsBase< Derived >::transpose ( ) const

inline

Returns

the tranpose transformation

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

References Eigen::TranspositionsBase< Derived >::derived().

Here is the call graph for this function:

---

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

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