Eigen::TranspositionsWrapper< _IndicesType > Class Template Reference

#include <Transpositions.h>

Inheritance diagram for Eigen::TranspositionsWrapper< _IndicesType >:

Collaboration diagram for Eigen::TranspositionsWrapper< _IndicesType >:

List of all members.

Public Types
typedef TranspositionsBase < TranspositionsWrapper >	Base
typedef Traits::IndicesType	IndicesType
typedef IndicesType::Scalar	StorageIndex
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 ()
Protected Attributes
IndicesType::Nested	m_indices
Private Types
typedef internal::traits < TranspositionsWrapper >	Traits

---

Detailed Description

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

Definition at line 288 of file Transpositions.h.

---

Member Typedef Documentation

template<typename _IndicesType >

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

Definition at line 294 of file Transpositions.h.

template<typename _IndicesType >

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

Reimplemented from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >.

Definition at line 295 of file Transpositions.h.

template<typename _IndicesType >

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

Reimplemented from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >.

Definition at line 296 of file Transpositions.h.

template<typename _IndicesType >

typedef internal::traits<TranspositionsWrapper> Eigen::TranspositionsWrapper< _IndicesType >::Traits [private]

Reimplemented from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >.

Definition at line 291 of file Transpositions.h.

---

Constructor & Destructor Documentation

template<typename _IndicesType >

Eigen::TranspositionsWrapper< _IndicesType >::TranspositionsWrapper

(

IndicesType &

indices

)

[inline, explicit]

Definition at line 298 of file Transpositions.h.

      : m_indices(indices)
    {}

---

Member Function Documentation

template<typename _IndicesType >

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

(

)

const [inline]

const version of indices().

Reimplemented from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >.

Definition at line 321 of file Transpositions.h.

{ return m_indices; }

template<typename _IndicesType >

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

(

)

[inline]

Returns:

a reference to the stored array representing the transpositions.

Reimplemented from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >.

Definition at line 324 of file Transpositions.h.

{ return m_indices; }

template<typename _IndicesType >

template<typename OtherDerived >

TranspositionsWrapper& Eigen::TranspositionsWrapper< _IndicesType >::operator=

(

const TranspositionsBase< OtherDerived > &

other

)

[inline]

Copies the other transpositions into *this

Reimplemented from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >.

Definition at line 304 of file Transpositions.h.

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

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

Definition at line 313 of file Transpositions.h.

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

---

Member Data Documentation

template<typename _IndicesType >

IndicesType::Nested Eigen::TranspositionsWrapper< _IndicesType >::m_indices [protected]

Definition at line 328 of file Transpositions.h.

---

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

• Transpositions.h