gsl::permutation::const_iterator_t< reverse > Class Template Reference

A class template for the const iterators. More...

Inheritance diagram for gsl::permutation::const_iterator_t< reverse >:

Collaboration diagram for gsl::permutation::const_iterator_t< reverse >:

Public Types
typedef iterator_base< permutationconst, unsignedlong, reverse >::difference_type	difference_type
	Difference type. More...
Public Types inherited from gsl::permutation::iterator_base< permutation const, unsigned long, reverse >
typedef std::random_access_iterator_tag	iterator_category
	An iterator must have an iterator category. More...
typedef size_t	value_type
	An iterator must have a value type. More...
typedef value_type *	pointer
	An iterator must have a pointer typea. More...
typedef value_type &	reference
	An iterator must have a reference type. More...
typedef ptrdiff_t	difference_type
	An iterator must have a difference_type. More...

Public Member Functions
const_iterator_t< reverse > &	operator= (const_iterator_t< reverse > const &i)
	We can assign one output iterator from another. More...
const_iterator_t< reverse > &	operator++ ()
	The prefix ++ operator. More...
const_iterator_t< reverse >	operator++ (int)
	The postfix ++ operator. More...
const_iterator_t< reverse > &	operator-- ()
	The prefix – operator. More...
const_iterator_t< reverse >	operator-- (int)
	The postfix – operator. More...
const_iterator_t< reverse > &	operator+= (difference_type const n)
	The += operator. More...
const_iterator_t< reverse > &	operator-= (difference_type const n)
	The -= operator. More...
const_iterator_t< reverse >	operator+ (difference_type const n) const
	The + operator. More...
const_iterator_t< reverse >	operator- (difference_type const n) const
	The - operator: subtract distance from iterator. More...
difference_type	operator- (const_iterator_t< reverse > const &i) const
	The - operator: find distance between two iterators. More...
	const_iterator_t ()
	The default constructor. More...
	const_iterator_t (const_iterator_t< reverse > const &i)
	A copy constructor. More...
bool	operator== (const_iterator_t< reverse > const &i) const
	Comparison with const_iterator. More...
bool	operator!= (const_iterator_t< reverse > const &i) const
	Comparison with const_iterator. More...
bool	operator< (const_iterator_t< reverse > const &i) const
	Comparison with const_iterator. More...
Public Member Functions inherited from gsl::permutation::iterator_base< permutation const, unsigned long, reverse >
reference	operator* () const
	Dereference the pointer. More...
pointer	operator-> () const
	Dereference the pointer. More...
reference	operator[] (difference_type const n) const
	Get element at i + n by reference ([] operator). More...
difference_type	operator- (iterator_base< permutation const, unsigned long, reverse > const &i) const
	The - operator: find distance between two iterators. More...
bool	operator== (iterator_base< permutation const, unsigned long, reverse > const &i) const
	The == operator. More...
bool	operator!= (iterator_base< permutation const, unsigned long, reverse > const &i) const
	The != operator. More...
bool	operator< (iterator_base< permutation const, unsigned long, reverse > const &i) const
	The < operator is used to compare iterators. More...

Protected Member Functions
	const_iterator_t (permutation const *v, difference_type position)
	This constructor allows permutation to create non-default iterators. More...
Protected Member Functions inherited from gsl::permutation::iterator_base< permutation const, unsigned long, reverse >
void	increment ()
	Increment the iterator. More...
void	decrement ()
	Decrement the iterator. More...
void	shift (difference_type const n)
	Shift iterator n places. More...
	iterator_base ()
	The iterator is default constructible. More...
	iterator_base (permutation const *v, difference_type position)
	This constructor allows permutation to create non-default iterators. More...

Friends
class	permutation

Additional Inherited Members
Protected Attributes inherited from gsl::permutation::iterator_base< permutation const, unsigned long, reverse >
permutation const *	v
	Store a pointer to a permutation we can iterate over: 0 if no permutation. More...
difference_type	position
	Mark position of iterator within permutation. More...

Detailed Description

template<bool reverse>
class gsl::permutation::const_iterator_t< reverse >

A class template for the const iterators.

Definition at line 564 of file permutation.hpp.

Member Typedef Documentation

difference_type

template<bool reverse>

typedef iterator_base<permutationconst,unsignedlong,reverse>::difference_type gsl::permutation::const_iterator_t< reverse >::difference_type

Difference type.

Definition at line 622 of file permutation.hpp.

Constructor & Destructor Documentation

const_iterator_t() [1/3]

template<bool reverse>

gsl::permutation::const_iterator_t< reverse >::const_iterator_t ( )

inline

The default constructor.

Definition at line 678 of file permutation.hpp.

const_iterator_t() [2/3]

template<bool reverse>

gsl::permutation::const_iterator_t< reverse >::const_iterator_t ( const_iterator_t< reverse > const &  i )

inline

A copy constructor.

Parameters

i	The iterator to copy

Definition at line 683 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::position, and gsl::permutation::iterator_base< container, content, reverse >::v.

const_iterator_t() [3/3]

template<bool reverse>

gsl::permutation::const_iterator_t< reverse >::const_iterator_t ( permutation const *  v, difference_type  position  )

inlineprotected

This constructor allows permutation to create non-default iterators.

Parameters

v	The permutation that creates this
position	The initial postion of the iterator

Definition at line 730 of file permutation.hpp.

Member Function Documentation

operator!=()

template<bool reverse>

bool gsl::permutation::const_iterator_t< reverse >::operator!= ( const_iterator_t< reverse > const &  i ) const

inline

Comparison with const_iterator.

Parameters

i	another iterator

Returns

false or true according as this points to same element as i

Definition at line 700 of file permutation.hpp.

References gsl::permutation::const_iterator_t< reverse >::operator==().

operator+()

template<bool reverse>

const_iterator_t< reverse > gsl::permutation::const_iterator_t< reverse >::operator+ ( difference_type const  n ) const

inline

The + operator.

Parameters

n	A difference_type value to be added

Returns

A new iterator

See also

ccgsl::operator+();

Definition at line 650 of file permutation.hpp.

References gsl::rstat::n().

operator++() [1/2]

template<bool reverse>

const_iterator_t< reverse > & gsl::permutation::const_iterator_t< reverse >::operator++ ( )

inline

The prefix ++ operator.

Returns

this

Definition at line 584 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::increment().

operator++() [2/2]

template<bool reverse>

const_iterator_t< reverse > gsl::permutation::const_iterator_t< reverse >::operator++ ( int  )

inline

The postfix ++ operator.

Returns

this

Definition at line 592 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::increment().

operator+=()

template<bool reverse>

const_iterator_t< reverse > & gsl::permutation::const_iterator_t< reverse >::operator+= ( difference_type const  n )

inline

The += operator.

Parameters

n	A difference_type value to be added to position of iterator

Returns

this

Definition at line 629 of file permutation.hpp.

References gsl::permutation::iterator_base< permutation const, unsigned long, reverse >::shift().

operator-() [1/2]

template<bool reverse>

difference_type gsl::permutation::const_iterator_t< reverse >::operator- ( const_iterator_t< reverse > const &  i ) const

inline

The - operator: find distance between two iterators.

Parameters

i	A second iterator

Returns

(signed) distance between this and i

Definition at line 672 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::operator-().

operator-() [2/2]

template<bool reverse>

const_iterator_t< reverse > gsl::permutation::const_iterator_t< reverse >::operator- ( difference_type const  n ) const

inline

The - operator: subtract distance from iterator.

Parameters

n	A difference_type value to be subtracted

Returns

A new iterator

See also

ccgsl::operator-();

Definition at line 662 of file permutation.hpp.

References gsl::rstat::n().

operator--() [1/2]

template<bool reverse>

const_iterator_t< reverse > & gsl::permutation::const_iterator_t< reverse >::operator-- ( )

inline

The prefix – operator.

Returns

this

Definition at line 604 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::decrement().

operator--() [2/2]

template<bool reverse>

const_iterator_t< reverse > gsl::permutation::const_iterator_t< reverse >::operator-- ( int  )

inline

The postfix – operator.

Returns

this

Definition at line 612 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::decrement().

operator-=()

template<bool reverse>

const_iterator_t< reverse > & gsl::permutation::const_iterator_t< reverse >::operator-= ( difference_type const  n )

inline

The -= operator.

Parameters

n	A difference_type value to be subtracted from position of iterator

Returns

this

Definition at line 639 of file permutation.hpp.

References gsl::permutation::iterator_base< permutation const, unsigned long, reverse >::shift().

operator<()

template<bool reverse>

bool gsl::permutation::const_iterator_t< reverse >::operator< ( const_iterator_t< reverse > const &  i ) const

inline

Comparison with const_iterator.

Parameters

i	another iterator

Returns

true or false according as this points to earlier element than i

Definition at line 708 of file permutation.hpp.

References gsl::permutation::ccgsl_pointer, gsl::exception::GSL_EFAILED, gsl::permutation::iterator_base< permutation const, unsigned long, reverse >::position, gsl::permutation::iterator_base< container, content, reverse >::position, gsl::permutation::reverse(), gsl::permutation::iterator_base< container, content, reverse >::v, and gsl::permutation::iterator_base< permutation const, unsigned long, reverse >::v.

operator=()

template<bool reverse>

const_iterator_t< reverse > & gsl::permutation::const_iterator_t< reverse >::operator= ( const_iterator_t< reverse > const &  i )

inline

We can assign one output iterator from another.

Parameters

i	The iterator to copy

Definition at line 573 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::position, and gsl::permutation::iterator_base< container, content, reverse >::v.

operator==()

template<bool reverse>

bool gsl::permutation::const_iterator_t< reverse >::operator== ( const_iterator_t< reverse > const &  i ) const

inline

Comparison with const_iterator.

Parameters

i	another iterator

Returns

true or false according as this points to same element as i

Definition at line 692 of file permutation.hpp.

References gsl::permutation::iterator_base< container, content, reverse >::position, gsl::permutation::iterator_base< permutation const, unsigned long, reverse >::position, gsl::permutation::iterator_base< container, content, reverse >::v, and gsl::permutation::iterator_base< permutation const, unsigned long, reverse >::v.

Referenced by gsl::permutation::const_iterator_t< reverse >::operator!=().

Friends And Related Function Documentation

permutation

template<bool reverse>

friend class permutation

friend

Definition at line 724 of file permutation.hpp.

---

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

• permutation.hpp