Regina Calculation Engine
Public Types | Static Public Member Functions | Protected Member Functions | List of all members
regina::SatBlockStarterSet Class Reference

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

#include <subcomplex/satblockstarter.h>

Inheritance diagram for regina::SatBlockStarterSet:
regina::ListOnCall< SatBlockStarter >

Public Types

typedef ListOnCall< SatBlockStarter >::iterator iterator
 An iterator over the starter blocks in this list. More...
 

Static Public Member Functions

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

Protected Member Functions

void initialise () override
 Fills this list with items. More...
 

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 SatBlockStarter 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:\n Not present.

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

Copyright © 1999-2020, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).