Eigen::TranspositionsBase< Derived > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Transpositions.h>

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

Public Member Functions
EIGEN_DEVICE_FUNC Derived &	derived ()
EIGEN_DEVICE_FUNC const Derived &	derived () const
template<typename OtherDerived >
Derived &	operator= (const TranspositionsBase< OtherDerived > &other)
	Copies the other transpositions into *this. More...
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
	Direct access to the underlying index vector. More...
StorageIndex &	coeffRef (Index i)
	Direct access to the underlying index vector. More...
const StorageIndex &	operator() (Index i) const
	Direct access to the underlying index vector. More...
StorageIndex &	operator() (Index i)
	Direct access to the underlying index vector. More...
const StorageIndex &	operator[] (Index i) const
	Direct access to the underlying index vector. More...
StorageIndex &	operator[] (Index i)
	Direct access to the underlying index vector. More...
EIGEN_DEVICE_FUNC const IndicesType &	indices () const
	const version of indices(). More...
EIGEN_DEVICE_FUNC IndicesType &	indices ()
void	resize (Index newSize)
	Resizes to given size. More...
void	setIdentity ()
	Sets *this to represents an identity transformation. More...
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

IndicesType

template<typename Derived >

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

StorageIndex

template<typename Derived >

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

Member Function Documentation

coeff()

template<typename Derived >

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

inline

Direct access to the underlying index vector.

coeffRef()

template<typename Derived >

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

inline

Direct access to the underlying index vector.

cols()

template<typename Derived >

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

inline

Returns

the number of columns of the equivalent permutation matrix

derived() [1/2]

template<typename Derived >

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

inline

derived() [2/2]

template<typename Derived >

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

inline

indices() [1/2]

template<typename Derived >

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

inline

Returns

a reference to the stored array representing the transpositions.

indices() [2/2]

template<typename Derived >

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

inline

const version of indices().

inverse()

template<typename Derived >

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

inline

Returns

the inverse transformation

operator()() [1/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector.

operator()() [2/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector.

operator=()

template<typename Derived >

template<typename OtherDerived >

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

inline

Copies the other transpositions into *this.

operator[]() [1/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector.

operator[]() [2/2]

template<typename Derived >

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

inline

Direct access to the underlying index vector.

resize()

template<typename Derived >

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

inline

Resizes to given size.

rows()

template<typename Derived >

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

inline

Returns

the number of rows of the equivalent permutation matrix

setIdentity()

template<typename Derived >

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

inline

Sets *this to represents an identity transformation.

size()

template<typename Derived >

EIGEN_DEVICE_FUNC 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 files:

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/ForwardDeclarations.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Transpositions.h