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::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >:

Public Types
typedef const PermutationMatrix &	Nested

typedef Traits::IndicesType	IndicesType

typedef Traits::StorageIndex	StorageIndex

Public Types inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
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< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >	InverseReturnType

typedef void	Scalar

Public Types inherited from Eigen::EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
typedef Eigen::Index	Index
	The interface type of indices. More...

typedef internal::traits< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::StorageKind	StorageKind

Public Member Functions
	PermutationMatrix ()

	PermutationMatrix (Index size)
	Constructs an uninitialized permutation matrix of given size. More...

template<typename OtherDerived >
	PermutationMatrix (const PermutationBase< OtherDerived > &other)
	Copy constructor. More...

template<typename Other >
	PermutationMatrix (const MatrixBase< Other > &indices)
	Generic constructor from expression of the indices. More...

template<typename Other >
	PermutationMatrix (const TranspositionsBase< Other > &tr)
	Convert the Transpositions tr to a permutation matrix. More...

template<typename Other >
PermutationMatrix &	operator= (const PermutationBase< Other > &other)
	Copies the other permutation into *this. More...

template<typename Other >
PermutationMatrix &	operator= (const TranspositionsBase< Other > &tr)
	Assignment from the Transpositions tr. More...

const IndicesType &	indices () const
	const version of indices(). More...

IndicesType &	indices ()

template<typename Other >
	PermutationMatrix (const InverseImpl< Other, PermutationStorage > &other)

template<typename Lhs , typename Rhs >
	PermutationMatrix (internal::PermPermProduct_t, const Lhs &lhs, const Rhs &rhs)

Public Member Functions inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	operator= (const PermutationBase< OtherDerived > &other)
	Copies the other permutation into *this. More...

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	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...

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	applyTranspositionOnTheLeft (Index i, Index j)
	Multiplies *this by the transposition \((ij)\) on the left. More...

PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	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 PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived ()

EIGEN_DEVICE_FUNC const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived () const

Public Member Functions inherited from Eigen::EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived ()

EIGEN_DEVICE_FUNC const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived () const

EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	const_cast_derived () const

EIGEN_DEVICE_FUNC const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	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	m_indices

Additional Inherited Members
Protected Member Functions inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
void	assignTranspose (const PermutationBase< OtherDerived > &other)

void	assignProduct (const Lhs &lhs, const Rhs &rhs)

Detailed Description

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex>
class Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >

Permutation matrix.

Template Parameters

SizeAtCompileTime	the number of rows/cols, or Dynamic
MaxSizeAtCompileTime	the maximum number of rows/cols, or Dynamic. This optional parameter defaults to SizeAtCompileTime. Most of the time, you should not have to specify it.
_StorageIndex	the integer type of the indices

This class represents a permutation matrix, internally stored as a vector of integers.

See also: class PermutationBase, class PermutationWrapper, class DiagonalMatrix

Member Typedef Documentation

◆ IndicesType

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef Traits::IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::IndicesType

◆ Nested

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef const PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Nested

◆ StorageIndex

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef Traits::StorageIndex Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::StorageIndex

Constructor & Destructor Documentation

◆ PermutationMatrix() [1/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix ( )

inline

◆ PermutationMatrix() [2/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix ( Index size )

inlineexplicit

Constructs an uninitialized permutation matrix of given size.

◆ PermutationMatrix() [3/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename OtherDerived >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix ( const PermutationBase< OtherDerived > & other )

inline

Copy constructor.

◆ PermutationMatrix() [4/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Other >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix ( const MatrixBase< Other > & indices )

inlineexplicit

Generic constructor from expression of the indices.

The indices array has the meaning that the permutations sends each integer i to indices[i].

Warning: It is your responsibility to check that the indices array that you passes actually describes a permutation, i.e., each value between 0 and n-1 occurs exactly once, where n is the array's size.

◆ PermutationMatrix() [5/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Other >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix ( const TranspositionsBase< Other > & tr )

inlineexplicit

Convert the Transpositions tr to a permutation matrix.

◆ PermutationMatrix() [6/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Other >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix ( const InverseImpl< Other, PermutationStorage > & other )

inline

◆ PermutationMatrix() [7/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Lhs , typename Rhs >

Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::PermutationMatrix	(	internal::PermPermProduct_t	,
		const Lhs &	lhs,
		const Rhs &	rhs
	)

inline

Member Function Documentation

◆ indices() [1/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

IndicesType & Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::indices ( )

inline

Returns: a reference to the stored array representing the permutation.

◆ indices() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

const IndicesType & Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::indices ( ) const

inline

const version of indices().

◆ operator=() [1/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Other >

PermutationMatrix & Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::operator= ( const PermutationBase< Other > & other )

inline

Copies the other permutation into *this.

◆ operator=() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

template<typename Other >

PermutationMatrix & Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::operator= ( const TranspositionsBase< Other > & tr )

inline

Assignment from the Transpositions tr.

Member Data Documentation

◆ m_indices

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::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

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IndicesType

◆ Nested

◆ StorageIndex

Constructor & Destructor Documentation

◆ PermutationMatrix() [1/7]

◆ PermutationMatrix() [2/7]

◆ PermutationMatrix() [3/7]

◆ PermutationMatrix() [4/7]

◆ PermutationMatrix() [5/7]

◆ PermutationMatrix() [6/7]

◆ PermutationMatrix() [7/7]

Member Function Documentation

◆ indices() [1/2]

◆ indices() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ m_indices