Regina Calculation Engine
Public Types | Static Public Member Functions | Protected Member Functions
regina::NSatBlockStarterSet Class Reference

Represents a set of starter blocks that can be used for identifying triangulations of Seifert fibred spaces. More...

#include <nsatblockstarter.h>

Inheritance diagram for regina::NSatBlockStarterSet:
regina::NListOnCall< NSatBlockStarter >

List of all members.

Public Types

typedef NListOnCall
< NSatBlockStarter >::iterator 
iterator
 An iterator over the starter blocks in this list.

Static Public Member Functions

static iterator begin ()
 Returns an iterator pointing to the first block in the hard-coded list.
static iterator end ()
 Returns an iterator pointing past the end of the hard-coded list (i.e., just after the last item).

Protected Member Functions

void initialise ()
 Fills this list with items.

Detailed Description

Represents a set of starter blocks that can be used for identifying triangulations of Seifert fibred spaces.

This class provides a list of saturated blocks that can be used as starting points for recognising triangulations; see the NSatBlockStarter class notes for details.

More importantly, this list is global and hard-coded. The only access to the list is through the static routines begin() and end().

Creating the list of starter blocks is expensive, and so this is not done until the first time that begin() is called. This way, if the list is never used then the work is never done. As a consequence however, you must be sure to call begin() before calling end() (which is the usual way in which iterator loops are structured in code).

Be aware that this list makes no claims to be exhaustive; it is expected to grow as future versions of Regina are released.

Python:
Not present.

Member Typedef Documentation

An iterator over the starter blocks in this list.

This operates as a forward iterator in a manner consistent with the standard C++ library.

Reimplemented from regina::NListOnCall< NSatBlockStarter >.


Member Function Documentation

NSatBlockStarterSet::iterator regina::NSatBlockStarterSet::begin ( ) [inline, static]

Returns an iterator pointing to the first block in the hard-coded list.

The very first time this routine is called, the list will be filled with items (and as such the call will be expensive). Every subsequent call will be very cheap.

Returns:
an iterator pointing to the first starter block.
NSatBlockStarterSet::iterator regina::NSatBlockStarterSet::end ( ) [inline, static]

Returns an iterator pointing past the end of the hard-coded list (i.e., just after the last item).

Precondition:
The begin() routine has been called at least once.
Returns:
a past-the-end iterator.
void regina::NSatBlockStarterSet::initialise ( ) [protected, virtual]

Fills this list with items.

The particular set of items to use will typically depend on the particular subclass of NListOnCall that is being defined.

This routine will be run the first time that begin() is called on each list, and will not be run again.

Implements regina::NListOnCall< NSatBlockStarter >.


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

Copyright © 1999-2009, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).