Eigen::TranspositionsWrapper< IndicesType_ > Class Template Reference

#include <Transpositions.h>

Inheritance diagram for Eigen::TranspositionsWrapper< IndicesType_ >:

Public Types
typedef TranspositionsBase< TranspositionsWrapper >	Base
typedef Traits::IndicesType	IndicesType
typedef IndicesType::Scalar	StorageIndex
Public Types inherited from Eigen::TranspositionsBase< TranspositionsWrapper< IndicesType_ > >
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)
EIGEN_DEVICE_FUNC const IndicesType &	indices () const
EIGEN_DEVICE_FUNC IndicesType &	indices ()
Public Member Functions inherited from Eigen::TranspositionsBase< TranspositionsWrapper< IndicesType_ > >
EIGEN_DEVICE_FUNC TranspositionsWrapper< IndicesType_ > &	derived ()
EIGEN_DEVICE_FUNC const TranspositionsWrapper< IndicesType_ > &	derived () const
TranspositionsWrapper< IndicesType_ > &	operator= (const TranspositionsBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC Index	size () const
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC 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)
EIGEN_DEVICE_FUNC const IndicesType &	indices () const
EIGEN_DEVICE_FUNC IndicesType &	indices ()
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

Member Typedef Documentation

Base

template<typename IndicesType_ >

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

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

indices() [1/2]

template<typename IndicesType_ >

EIGEN_DEVICE_FUNC 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_ >

EIGEN_DEVICE_FUNC const IndicesType& Eigen::TranspositionsWrapper< IndicesType_ >::indices ( ) const

inline

const version of indices().

{ return m_indices; }

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

operator=()

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

Member Data Documentation

m_indices

template<typename IndicesType_ >

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

protected

Referenced by Eigen::TranspositionsWrapper< IndicesType_ >::indices().

---

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

• PermutationMatrix.h
• Transpositions.h