Eigen::TranspositionsBase< Derived > Class Template Reference

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)
	Copies the other transpositions into *this.
Derived &	operator= (const TranspositionsBase &other)
	This is a special case of the templated operator=.
Index	size () const
Index	rows () const
Index	cols () const
const StorageIndex &	coeff (Index i) const
	Direct access to the underlying index vector.
StorageIndex &	coeffRef (Index i)
	Direct access to the underlying index vector.
const StorageIndex &	operator() (Index i) const
	Direct access to the underlying index vector.
StorageIndex &	operator() (Index i)
	Direct access to the underlying index vector.
const StorageIndex &	operator[] (Index i) const
	Direct access to the underlying index vector.
StorageIndex &	operator[] (Index i)
	Direct access to the underlying index vector.
const IndicesType &	indices () const
	const version of indices().
IndicesType &	indices ()
void	resize (Index newSize)
	Resizes to given size.
void	setIdentity ()
	Sets *this to represents an identity transformation.
Transpose< TranspositionsBase >	inverse () const
Transpose< TranspositionsBase >	transpose () const

Member Typedef Documentation

Index

template<typename Derived >

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

Deprecated:

since Eigen 3.3

Member Function Documentation

cols()

template<typename Derived >

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

inline

Returns

the number of columns of the equivalent permutation matrix

indices()

template<typename Derived >

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

inline

Returns

a reference to the stored array representing the transpositions.

inverse()

template<typename Derived >

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

inline

Returns

the inverse transformation

operator=()

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

rows()

template<typename Derived >

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

inline

Returns

the number of rows of the equivalent permutation matrix

size()

template<typename Derived >

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

inline

Returns

the number of transpositions

transpose()

template<typename Derived >

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

inline

Returns

the tranpose transformation

---

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

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