honey::Permute_< Real >::Iter< T > Class Template Reference

Iter for permutations of a list. More...

#include <Permute.h>

Public Types
typedef std::forward_iterator_tag	iterator_category
typedef const vector< const T * >	value_type
typedef sdt	difference_type
typedef const vector< const T * > *	pointer
typedef const vector< const T * > &	reference

Public Member Functions
	Iter ()=default
	Iter (SharedPtr< State > state)
Iter &	operator++ ()
Iter	operator++ (int)
bool	operator== (const Iter &rhs) const
bool	operator!= (const Iter &rhs) const
vector< const T * > &	operator* () const
	Get current permutation list. More...
vector< const T * > *	operator-> () const
sdt	count () const
	Get current permutation number. Every perm has a unique associated number: the first perm is 1, the last perm is countMax() More...
sdt	countMax () const
	Get total number of permutations for this list. More...

Friends
class	Permute_

Detailed Description

template<class Real>
template<class T>
class honey::Permute_< Real >::Iter< T >

Iter for permutations of a list.

Member Typedef Documentation

template<class Real >

template<class T >

typedef sdt honey::Permute_< Real >::Iter< T >::difference_type

template<class Real >

template<class T >

typedef std::forward_iterator_tag honey::Permute_< Real >::Iter< T >::iterator_category

template<class Real >

template<class T >

typedef const vector<const T*>* honey::Permute_< Real >::Iter< T >::pointer

template<class Real >

template<class T >

typedef const vector<const T*>& honey::Permute_< Real >::Iter< T >::reference

template<class Real >

template<class T >

typedef const vector<const T*> honey::Permute_< Real >::Iter< T >::value_type

Constructor & Destructor Documentation

template<class Real >

template<class T >

honey::Permute_< Real >::Iter< T >::Iter ( )

default

template<class Real >

template<class T >

honey::Permute_< Real >::Iter< T >::Iter

(

SharedPtr< State >

state

)

Member Function Documentation

template<class Real >

template<class T >

sdt honey::Permute_< Real >::Iter< T >::count ( ) const

inline

Get current permutation number. Every perm has a unique associated number: the first perm is 1, the last perm is countMax()

template<class Real >

template<class T >

sdt honey::Permute_< Real >::Iter< T >::countMax ( ) const

inline

Get total number of permutations for this list.

template<class Real >

template<class T >

bool honey::Permute_< Real >::Iter< T >::operator!= ( const Iter< T > &  rhs ) const

inline

template<class Real >

template<class T >

vector<const T*>& honey::Permute_< Real >::Iter< T >::operator* ( ) const

inline

Get current permutation list.

template<class Real >

template<class T >

Permute_< Real >::template Iter< T > & honey::Permute_< Real >::Iter< T >::operator++

(

)

template<class Real >

template<class T >

Iter honey::Permute_< Real >::Iter< T >::operator++ ( int  )

inline

template<class Real >

template<class T >

vector<const T*>* honey::Permute_< Real >::Iter< T >::operator-> ( ) const

inline

template<class Real >

template<class T >

bool honey::Permute_< Real >::Iter< T >::operator==

(

const Iter< T > &

rhs

)

const

Friends And Related Function Documentation

template<class Real >

template<class T >

friend class Permute_

friend

---

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

• src/common/Honey/Math/Random/Permute.h