Eigen::TranspositionsBase< Derived > Class Template Reference

Public Types
typedef Traits::IndicesType	IndicesType
typedef IndicesType::Scalar	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
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

Detailed Description

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

Definition at line 49 of file Transpositions.h.

Member Function Documentation

template<typename Derived>

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

inline

Direct access to the underlying index vector

Definition at line 84 of file Transpositions.h.

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

template<typename Derived>

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

inline

Direct access to the underlying index vector

Definition at line 86 of file Transpositions.h.

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

template<typename Derived>

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

inline

const version of indices().

Definition at line 97 of file Transpositions.h.

{ return derived().indices(); }

template<typename Derived>

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

inline

Returns

a reference to the stored array representing the transpositions.

Definition at line 99 of file Transpositions.h.

{ return derived().indices(); }

template<typename Derived>

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

inline

Returns

the inverse transformation

Definition at line 136 of file Transpositions.h.

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

template<typename Derived>

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

inline

Direct access to the underlying index vector

Definition at line 88 of file Transpositions.h.

{ return indices()(i); }

template<typename Derived>

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

inline

Direct access to the underlying index vector

Definition at line 90 of file Transpositions.h.

{ return indices()(i); }

template<typename Derived>

template<typename OtherDerived >

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

inline

Copies the other transpositions into *this

Definition at line 63 of file Transpositions.h.

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

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=.

Definition at line 73 of file Transpositions.h.

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

template<typename Derived>

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

inline

Direct access to the underlying index vector

Definition at line 92 of file Transpositions.h.

{ return indices()(i); }

template<typename Derived>

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

inline

Direct access to the underlying index vector

Definition at line 94 of file Transpositions.h.

{ return indices()(i); }

template<typename Derived>

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

inline

Resizes to given size.

Definition at line 102 of file Transpositions.h.

    {
      indices().resize(newSize);
    }

template<typename Derived>

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

inline

Sets *this to represents an identity transformation

Definition at line 108 of file Transpositions.h.

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

template<typename Derived>

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

inline

Returns

the number of transpositions

Definition at line 81 of file Transpositions.h.

{ return indices().size(); }

template<typename Derived>

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

inline

Returns

the tranpose transformation

Definition at line 140 of file Transpositions.h.

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

---

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

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