Public Types | Public Member Functions | Protected Attributes | Private Types
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > Class Template Reference

Permutation matrix. More...

#include <PermutationMatrix.h>

Inheritance diagram for Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Traits::IndicesType IndicesType

Public Member Functions

const IndicesTypeindices () const
IndicesTypeindices ()
template<typename Other >
PermutationMatrixoperator= (const PermutationBase< Other > &other)
template<typename Other >
PermutationMatrixoperator= (const TranspositionsBase< Other > &tr)
PermutationMatrixoperator= (const PermutationMatrix &other)
 PermutationMatrix ()
 PermutationMatrix (int size)
template<typename OtherDerived >
 PermutationMatrix (const PermutationBase< OtherDerived > &other)
 PermutationMatrix (const PermutationMatrix &other)
template<typename Other >
 PermutationMatrix (const MatrixBase< Other > &indices)
template<typename Other >
 PermutationMatrix (const TranspositionsBase< Other > &tr)
template<typename Other >
 PermutationMatrix (const Transpose< PermutationBase< Other > > &other)
template<typename Lhs , typename Rhs >
 PermutationMatrix (internal::PermPermProduct_t, const Lhs &lhs, const Rhs &rhs)

Protected Attributes

IndicesType m_indices

Private Types

typedef PermutationBase
< PermutationMatrix
Base
typedef internal::traits
< PermutationMatrix
Traits

Detailed Description

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

Permutation matrix.

Parameters:
SizeAtCompileTimethe number of rows/cols, or Dynamic
MaxSizeAtCompileTimethe maximum number of rows/cols, or Dynamic. This optional parameter defaults to SizeAtCompileTime. Most of the time, you should not have to specify it.
IndexTypethe 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

Definition at line 283 of file PermutationMatrix.h.


Member Typedef Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
typedef PermutationBase<PermutationMatrix> Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::Base [private]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
typedef Traits::IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::IndicesType
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
typedef internal::traits<PermutationMatrix> Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::Traits [private]

Constructor & Destructor Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( ) [inline]

Definition at line 293 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( int  size) [inline]

Constructs an uninitialized permutation matrix of given size.

Definition at line 298 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename OtherDerived >
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( const PermutationBase< OtherDerived > &  other) [inline]

Copy constructor.

Definition at line 303 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &  other) [inline]

Standard copy constructor. Defined only to prevent a default copy constructor from hiding the other templated constructor

Definition at line 309 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename Other >
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::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.

Definition at line 320 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename Other >
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( const TranspositionsBase< Other > &  tr) [inline, explicit]

Convert the Transpositions tr to a permutation matrix

Definition at line 325 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename Other >
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( const Transpose< PermutationBase< Other > > &  other) [inline]

Definition at line 367 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename Lhs , typename Rhs >
Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::PermutationMatrix ( internal::PermPermProduct_t  ,
const Lhs &  lhs,
const Rhs &  rhs 
) [inline]

Definition at line 373 of file PermutationMatrix.h.


Member Function Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
const IndicesType& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::indices ( ) const [inline]
template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
IndicesType& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::indices ( ) [inline]
Returns:
a reference to the stored array representing the permutation.

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

Definition at line 360 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename Other >
PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= ( const PermutationBase< Other > &  other) [inline]

Copies the other permutation into *this

Definition at line 333 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
template<typename Other >
PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= ( const TranspositionsBase< Other > &  tr) [inline]

Assignment from the Transpositions tr

Definition at line 341 of file PermutationMatrix.h.

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
PermutationMatrix& Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::operator= ( const PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > &  other) [inline]

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

Definition at line 350 of file PermutationMatrix.h.


Member Data Documentation

template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename IndexType>
IndicesType Eigen::PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >::m_indices [protected]

Definition at line 382 of file PermutationMatrix.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Wed Sep 16 2015 07:12:56