Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > Class Template Reference

Permutation matrix. More...

#include <PermutationMatrix.h>

Inheritance diagram for Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >:

Public Types
typedef Traits::IndicesType	IndicesType
typedef Traits::StorageIndex	StorageIndex
Public Types inherited from Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
enum
typedef Matrix< StorageIndex, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType
typedef Traits::IndicesType	IndicesType
typedef Inverse< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >	InverseReturnType
typedef PlainPermutationType	PlainObject
typedef PermutationMatrix< IndicesType::SizeAtCompileTime, IndicesType::MaxSizeAtCompileTime, StorageIndex >	PlainPermutationType
typedef void	Scalar
typedef Traits::StorageIndex	StorageIndex
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
IndicesType &	indices ()
const IndicesType &	indices () const
template<typename Other >
PermutationMatrix &	operator= (const PermutationBase< Other > &other)
template<typename Other >
PermutationMatrix &	operator= (const TranspositionsBase< Other > &tr)
	PermutationMatrix ()
template<typename Other >
	PermutationMatrix (const InverseImpl< Other, PermutationStorage > &other)
template<typename Other >
	PermutationMatrix (const MatrixBase< Other > &indices)
template<typename OtherDerived >
	PermutationMatrix (const PermutationBase< OtherDerived > &other)
template<typename Other >
	PermutationMatrix (const TranspositionsBase< Other > &tr)
	PermutationMatrix (Index size)
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 > &	applyTranspositionOnTheLeft (Index i, Index j)
PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	applyTranspositionOnTheRight (Index i, Index j)
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived ()
const EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived () const
Index	determinant () const
void	evalTo (MatrixBase< DenseDerived > &other) const
IndicesType &	indices ()
const IndicesType &	indices () const
InverseReturnType	inverse () const
PlainPermutationType	operator* (const InverseImpl< Other, PermutationStorage > &other) const
PlainPermutationType	operator* (const PermutationBase< Other > &other) const
PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	operator= (const PermutationBase< OtherDerived > &other)
PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	operator= (const TranspositionsBase< OtherDerived > &tr)
void	resize (Index newSize)
EIGEN_DEVICE_FUNC Index	rows () const
void	setIdentity ()
void	setIdentity (Index newSize)
EIGEN_DEVICE_FUNC Index	size () const
DenseMatrixType	toDenseMatrix () const
InverseReturnType	transpose () const
Public Member Functions inherited from Eigen::EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	const_cast_derived () const
const EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	const_derived () const
EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived ()
const EIGEN_DEVICE_FUNC PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > &	derived () const
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

Public Attributes
const typedef PermutationMatrix &	Nested

Protected Attributes
IndicesType	m_indices

Private Types
typedef PermutationBase< PermutationMatrix >	Base
typedef internal::traits< PermutationMatrix >	Traits

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

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

Definition at line 297 of file PermutationMatrix.h.

Member Typedef Documentation

Base

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef PermutationBase<PermutationMatrix> Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Base

private

Definition at line 299 of file PermutationMatrix.h.

IndicesType

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

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

Definition at line 306 of file PermutationMatrix.h.

StorageIndex

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

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

Definition at line 307 of file PermutationMatrix.h.

Traits

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

typedef internal::traits<PermutationMatrix> Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::Traits

private

Definition at line 300 of file PermutationMatrix.h.

Constructor & Destructor Documentation

PermutationMatrix() [1/7]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

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

inline

Definition at line 310 of file PermutationMatrix.h.

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.

Definition at line 315 of file PermutationMatrix.h.

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.

Definition at line 322 of file PermutationMatrix.h.

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.

Definition at line 333 of file PermutationMatrix.h.

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

Definition at line 338 of file PermutationMatrix.h.

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

Definition at line 369 of file PermutationMatrix.h.

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

Definition at line 378 of file PermutationMatrix.h.

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.

Definition at line 362 of file PermutationMatrix.h.

indices() [2/2]

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

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

inline

const version of indices().

Definition at line 360 of file PermutationMatrix.h.

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

Definition at line 346 of file PermutationMatrix.h.

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

Definition at line 354 of file PermutationMatrix.h.

Member Data Documentation

m_indices

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >::m_indices

protected

Definition at line 387 of file PermutationMatrix.h.

Nested

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename _StorageIndex >

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

Definition at line 303 of file PermutationMatrix.h.

---

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

• PermutationMatrix.h