Regina Calculation Engine
|
An iterator used for running through all normal discs in a normal surface. More...
#include <surfaces/ndisc.h>
Public Member Functions | |
NDiscSpecIterator () | |
Creates a new uninitialised iterator. | |
NDiscSpecIterator (const NDiscSetSurface &discSet) | |
Creates a new iterator pointing to the first disc in the given disc set. | |
void | init (const NDiscSetSurface &discSet) |
Points this iterator to the first disc in the given disc set. | |
void | operator++ () |
Points this iterator to the next disc, or makes it past-the-end if there is no next disc. | |
void | operator++ (int) |
Points this iterator to the next disc, or makes it past-the-end if there is no next disc. | |
const NDiscSpec & | operator* () const |
Returns a reference to the disc pointed to by this iterator. | |
bool | done () const |
Determines if this iterator is past-the-end. | |
Protected Attributes | |
const NDiscSetSurface * | internalDiscSet |
The disc set through which we are iterating. | |
NDiscSpec | current |
The disc currently pointed to. |
An iterator used for running through all normal discs in a normal surface.
unsigned long
. See the precondition below.regina::NDiscSpecIterator::NDiscSpecIterator | ( | ) | [inline] |
Creates a new uninitialised iterator.
This iterator cannot be used or queried until init() is called.
regina::NDiscSpecIterator::NDiscSpecIterator | ( | const NDiscSetSurface & | discSet | ) | [inline] |
Creates a new iterator pointing to the first disc in the given disc set.
discSet | the disc set used to initialise this iterator. |
bool regina::NDiscSpecIterator::done | ( | ) | const [inline] |
Determines if this iterator is past-the-end.
true
if and only if this iterator is past-the-end. void regina::NDiscSpecIterator::init | ( | const NDiscSetSurface & | discSet | ) | [inline] |
Points this iterator to the first disc in the given disc set.
discSet | the disc set used to reinitialise this iterator. |
const NDiscSpec & regina::NDiscSpecIterator::operator* | ( | ) | const [inline] |
Returns a reference to the disc pointed to by this iterator.
void regina::NDiscSpecIterator::operator++ | ( | ) | [inline] |
Points this iterator to the next disc, or makes it past-the-end if there is no next disc.
Unlike most standard increment operators, this operator returns void
. One consequence of this is that the preincrement and postincrement operators for this class are identical. This interface will need to be made more standard some day.
void regina::NDiscSpecIterator::operator++ | ( | int | ) | [inline] |
Points this iterator to the next disc, or makes it past-the-end if there is no next disc.
Unlike most standard increment operators, this operator returns void
. One consequence of this is that the preincrement and postincrement operators for this class are identical. This interface will need to be made more standard some day.
NDiscSpec regina::NDiscSpecIterator::current [protected] |
The disc currently pointed to.
const NDiscSetSurface* regina::NDiscSpecIterator::internalDiscSet [protected] |
The disc set through which we are iterating.