Eigen::PermutationWrapper< _IndicesType > Class Template Reference

Class to view a vector of integers as a permutation matrix. More...

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

Inheritance diagram for Eigen::PermutationWrapper< _IndicesType >:

Public Types
typedef Traits::IndicesType	IndicesType
Public Types inherited from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >
enum
typedef Traits::IndicesType	IndicesType
typedef Traits::StorageIndex	StorageIndex
typedef Matrix< StorageIndex, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType
typedef PermutationMatrix< IndicesType::SizeAtCompileTime, IndicesType::MaxSizeAtCompileTime, StorageIndex >	PlainPermutationType
typedef PlainPermutationType	PlainObject
typedef Inverse< PermutationWrapper< _IndicesType > >	InverseReturnType
typedef void	Scalar
Public Types inherited from Eigen::EigenBase< PermutationWrapper< _IndicesType > >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< PermutationWrapper< _IndicesType > >::StorageKind	StorageKind

Public Member Functions
	PermutationWrapper (const IndicesType &indices)
const internal::remove_all< typenameIndicesType::Nested >::type &	indices () const
	const version of indices(). More...
Public Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >
PermutationWrapper< _IndicesType > &	operator= (const PermutationBase< OtherDerived > &other)
	Copies the other permutation into *this. More...
PermutationWrapper< _IndicesType > &	operator= (const TranspositionsBase< OtherDerived > &tr)
	Assignment from the Transpositions tr. More...
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC Index	size () const
void	evalTo (MatrixBase< DenseDerived > &other) const
DenseMatrixType	toDenseMatrix () const
const IndicesType &	indices () const
	const version of indices(). More...
IndicesType &	indices ()
void	resize (Index newSize)
	Resizes to given size. More...
void	setIdentity ()
	Sets *this to be the identity permutation matrix. More...
void	setIdentity (Index newSize)
	Sets *this to be the identity permutation matrix of given size. More...
PermutationWrapper< _IndicesType > &	applyTranspositionOnTheLeft (Index i, Index j)
	Multiplies *this by the transposition \((ij)\) on the left. More...
PermutationWrapper< _IndicesType > &	applyTranspositionOnTheRight (Index i, Index j)
	Multiplies *this by the transposition \((ij)\) on the right. More...
InverseReturnType	inverse () const
InverseReturnType	transpose () const
PlainPermutationType	operator* (const PermutationBase< Other > &other) const
PlainPermutationType	operator* (const InverseImpl< Other, PermutationStorage > &other) const
Index	determinant () const
EIGEN_DEVICE_FUNC PermutationWrapper< _IndicesType > &	derived ()
EIGEN_DEVICE_FUNC const PermutationWrapper< _IndicesType > &	derived () const
Public Member Functions inherited from Eigen::EigenBase< PermutationWrapper< _IndicesType > >
EIGEN_DEVICE_FUNC PermutationWrapper< _IndicesType > &	derived ()
EIGEN_DEVICE_FUNC const PermutationWrapper< _IndicesType > &	derived () const
EIGEN_DEVICE_FUNC PermutationWrapper< _IndicesType > &	const_cast_derived () const
EIGEN_DEVICE_FUNC const PermutationWrapper< _IndicesType > &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Protected Attributes
IndicesType::Nested	m_indices

Additional Inherited Members
Protected Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< _IndicesType > >
void	assignTranspose (const PermutationBase< OtherDerived > &other)
void	assignProduct (const Lhs &lhs, const Rhs &rhs)

Detailed Description

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

Class to view a vector of integers as a permutation matrix.

Template Parameters

_IndicesType

the type of the vector of integer (can be any compatible expression)

This class allows to view any vector expression of integers as a permutation matrix.

See also

class PermutationBase, class PermutationMatrix

Member Typedef Documentation

IndicesType

template<typename _IndicesType >

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

Constructor & Destructor Documentation

PermutationWrapper()

template<typename _IndicesType >

Eigen::PermutationWrapper< _IndicesType >::PermutationWrapper ( const IndicesType &  indices )

inline

Member Function Documentation

indices()

template<typename _IndicesType >

const internal::remove_all< typenameIndicesType::Nested >::type & Eigen::PermutationWrapper< _IndicesType >::indices ( ) const

inline

const version of indices().

Member Data Documentation

m_indices

template<typename _IndicesType >

IndicesType::Nested Eigen::PermutationWrapper< _IndicesType >::m_indices

protected

---

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

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