Eigen::TranspositionsBase< Derived > Class Template Reference

#include <Transpositions.h>

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

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

Private Types
typedef internal::traits< Derived >	Traits

Detailed Description

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

Definition at line 16 of file Transpositions.h.

Member Typedef Documentation

Index

template<typename Derived >

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

Deprecated:

since Eigen 3.3

Definition at line 24 of file Transpositions.h.

IndicesType

template<typename Derived >

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

Definition at line 22 of file Transpositions.h.

StorageIndex

template<typename Derived >

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

Definition at line 23 of file Transpositions.h.

Traits

template<typename Derived >

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

private

Definition at line 18 of file Transpositions.h.

Member Function Documentation

coeff()

template<typename Derived >

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

inline

Direct access to the underlying index vector

Definition at line 56 of file Transpositions.h.

coeffRef()

template<typename Derived >

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

inline

Direct access to the underlying index vector

Definition at line 58 of file Transpositions.h.

cols()

template<typename Derived >

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

inline

Returns

the number of columns of the equivalent permutation matrix

Definition at line 53 of file Transpositions.h.

derived() [1/2]

template<typename Derived >

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

inline

Definition at line 26 of file Transpositions.h.

derived() [2/2]

template<typename Derived >

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

inline

Definition at line 27 of file Transpositions.h.

indices() [1/2]

template<typename Derived >

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

inline

Returns

a reference to the stored array representing the transpositions.

Definition at line 71 of file Transpositions.h.

indices() [2/2]

template<typename Derived >

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

inline

const version of indices().

Definition at line 69 of file Transpositions.h.

inverse()

template<typename Derived >

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

inline

Returns

the inverse transformation

Definition at line 108 of file Transpositions.h.

operator()() [1/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

Definition at line 62 of file Transpositions.h.

operator()() [2/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

Definition at line 60 of file Transpositions.h.

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

Definition at line 41 of file Transpositions.h.

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

Definition at line 31 of file Transpositions.h.

operator[]() [1/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

Definition at line 66 of file Transpositions.h.

operator[]() [2/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector

Definition at line 64 of file Transpositions.h.

resize()

template<typename Derived >

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

inline

Resizes to given size.

Definition at line 74 of file Transpositions.h.

rows()

template<typename Derived >

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

inline

Returns

the number of rows of the equivalent permutation matrix

Definition at line 51 of file Transpositions.h.

setIdentity()

template<typename Derived >

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

inline

Sets *this to represents an identity transformation

Definition at line 80 of file Transpositions.h.

size()

template<typename Derived >

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

inline

Returns

the number of transpositions

Definition at line 49 of file Transpositions.h.

transpose()

template<typename Derived >

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

inline

Returns

the tranpose transformation

Definition at line 112 of file Transpositions.h.

---

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

• Transpositions.h