Eigen::PermutationWrapper< IndicesType_ > Class Template Reference

#include <Eigen/src/Core/PermutationMatrix.h>

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

Inheritance diagram for Eigen::PermutationWrapper< IndicesType_ >:

Public Member Functions
const internal::remove_all_t< typename IndicesType::Nested > &	indices () const
Public Member Functions inherited from Eigen::PermutationBase< PermutationWrapper< IndicesType_ > >
PermutationWrapper< IndicesType_ > &	applyTranspositionOnTheLeft (Index i, Index j)
PermutationWrapper< IndicesType_ > &	applyTranspositionOnTheRight (Index i, Index j)
Index	cols () const
Index	determinant () const
DenseMatrixType	eval () 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
PermutationWrapper< IndicesType_ > &	operator= (const PermutationBase< OtherDerived > &other)
PermutationWrapper< IndicesType_ > &	operator= (const TranspositionsBase< OtherDerived > &tr)
void	resize (Index newSize)
Index	rows () const
void	setIdentity ()
void	setIdentity (Index newSize)
Index	size () const
DenseMatrixType	toDenseMatrix () const
InverseReturnType	transpose () const
Public Member Functions inherited from Eigen::EigenBase< PermutationWrapper< IndicesType_ > >
constexpr Index	cols () const noexcept
constexpr PermutationWrapper< IndicesType_ > &	derived ()
constexpr const PermutationWrapper< IndicesType_ > &	derived () const
constexpr Index	rows () const noexcept
constexpr Index	size () const noexcept

Additional Inherited Members
Public Types inherited from Eigen::EigenBase< PermutationWrapper< IndicesType_ > >
typedef Eigen::Index	Index
	The interface type of indices.

Member Function Documentation

indices()

template<typename IndicesType_>

const internal::remove_all_t< typename IndicesType::Nested > & Eigen::PermutationWrapper< IndicesType_ >::indices ( ) const

inline

const version of indices().

---

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

• /builds/libeigen/eigen/Eigen/src/Core/PermutationMatrix.h