A forward iterator used for running through all normal discs in a normal surface. More...

#include <surfaces/disc.h>

Public Member Functions
	DiscSpecIterator ()
	Creates a new uninitialised iterator. More...

	DiscSpecIterator (const DiscSetSurface &discSet)
	Creates a new iterator pointing to the first disc in the given disc set. More...

	DiscSpecIterator (const DiscSpecIterator &)=default
	Default copy constructor. More...

void	init (const DiscSetSurface &discSet)
	Points this iterator to the first disc in the given disc set. More...

DiscSpecIterator &	operator= (const DiscSpecIterator &)=default
	Default copy assignment operator. More...

DiscSpecIterator &	operator++ ()
	Preincrement operator. More...

DiscSpecIterator	operator++ (int)
	Postincrement operator. More...

const DiscSpec &	operator* () const
	Returns a reference to the disc pointed to by this iterator. More...

bool	done () const
	Determines if this iterator is past-the-end. More...

bool	operator== (const DiscSpecIterator &other) const
	Determines if this and the given iterator are equal. More...

bool	operator!= (const DiscSpecIterator &other) const
	Determines if this and the given iterator are different. More...

Protected Attributes
const DiscSetSurface *	internalDiscSet
	The disc set through which we are iterating. More...

DiscSpec	current
	The disc currently pointed to. More...

Detailed Description

A forward iterator used for running through all normal discs in a normal surface.

This header also specialises std::iterator_traits for this iterator class.

Warning: This class converts the indices of normal discs of a given type from LargeInteger to unsigned long. See the precondition below.

Precondition: The number of normal discs of a particular type in a particular tetrahedron can be represented by a long integer.

Python: Instead of the C++ interface described here, in Python DiscSetSurface and this class together implement the Python iterable/iterator interface. The DiscSetSurface class implements iter(), which returns a DiscSpecIterator; then DiscSpecIterator implements next(), which either returns the next normal disc in the set or else throws a StopException if there are no more discs to return.

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

Public Member Functions