PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > Class Template Reference

Permutation matrix. More...

Inheritance diagram for PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >:

List of all members.

Public Member Functions
const IndicesType &	indices () const
IndicesType &	indices ()
template<typename Other >
PermutationMatrix &	operator= (const PermutationBase< Other > &other)
template<typename Other >
PermutationMatrix &	operator= (const TranspositionsBase< Other > &tr)
	PermutationMatrix (int size)
template<typename OtherDerived >
	PermutationMatrix (const PermutationBase< OtherDerived > &other)
template<typename Other >
	PermutationMatrix (const MatrixBase< Other > &indices)
template<typename Other >
	PermutationMatrix (const TranspositionsBase< Other > &tr)

---

Detailed Description

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

Permutation matrix.

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.
IndexType	the interger 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

---

Constructor & Destructor Documentation

PermutationMatrix

(

int

size

)

[inline]

Constructs an uninitialized permutation matrix of given size.

PermutationMatrix

(

const PermutationBase< OtherDerived > &

other

)

[inline]

Copy constructor.

PermutationMatrix

(

const MatrixBase< Other > &

indices

)

[inline, explicit]

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

(

const TranspositionsBase< Other > &

tr

)

[inline, explicit]

Convert the Transpositions tr to a permutation matrix

---

Member Function Documentation

const IndicesType& indices

(

)

const [inline]

const version of indices().

Reimplemented from PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

IndicesType& indices

(

)

[inline]

Returns:

a reference to the stored array representing the permutation.

Reimplemented from PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

PermutationMatrix& operator=

(

const PermutationBase< Other > &

other

)

[inline]

Copies the other permutation into *this

PermutationMatrix& operator=

(

const TranspositionsBase< Other > &

tr

)

[inline]

Assignment from the Transpositions tr

---

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