Regina Calculation Engine
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends
regina::NNormalSurfaceList Class Reference

A packet representing a collection of normal surfaces in a 3-manifold. More...

#include <surfaces/nnormalsurfacelist.h>

Inheritance diagram for regina::NNormalSurfaceList:
regina::NPacket regina::NSurfaceSet regina::ShareableObject regina::boost::noncopyable

List of all members.

Classes

class  FundDualEnumerator
 A thread class that performs fundamental normal surface enumeration using the dual Hilbert basis algorithm.
class  FundPrimalEnumerator
 A thread class that performs fundamental normal surface enumeration using the primal Hilbert basis algorithm.
struct  SurfaceInserter
 An output iterator used to insert surfaces into an NNormalSurfaceList. More...
class  VectorIterator
 A bidirectional iterator that runs through the raw vectors for surfaces in this list. More...
class  VertexEnumerator
 A thread class that actually performs the vertex normal surface enumeration.

Public Member Functions

virtual ~NNormalSurfaceList ()
 Destroys this list and all the surfaces within.
virtual int getFlavour () const
 Returns the flavour of coordinate system being used by the surfaces stored in this set.
virtual bool allowsAlmostNormal () const
 Determines if the flavour of coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs.
virtual bool allowsSpun () const
 Determines if the flavour of coordinate system being used allows for spun normal surfaces.
virtual bool allowsOriented () const
 Determines if the flavour of coordinate system being used allows for transversely oriented normal surfaces.
virtual bool isEmbeddedOnly () const
 Returns whether this set is known to contain only embedded normal surfaces.
virtual NTriangulationgetTriangulation () const
 Returns the triangulation in which these normal surfaces live.
virtual unsigned long getNumberOfSurfaces () const
 Returns the number of surfaces stored in this set.
virtual const NNormalSurfacegetSurface (unsigned long index) const
 Returns the surface at the requested index in this set.
virtual ShareableObjectgetShareableObject ()
 Returns this object cast as a ShareableObject.
virtual int getPacketType () const
 Returns the integer ID representing this type of packet.
virtual std::string getPacketTypeName () const
 Returns an English name for this type of packet.
virtual void writeTextShort (std::ostream &out) const
 Writes this object in short text format to the given output stream.
virtual void writeTextLong (std::ostream &out) const
 Writes this object in long text format to the given output stream.
virtual void writePacket (NFile &out) const
 Writes the packet details to the given old-style binary file.
virtual bool dependsOnParent () const
 Determines if this packet depends upon its parent.
NNormalSurfaceListquadToStandard () const
 Converts the set of all embedded vertex normal surfaces in quadrilateral space to the set of all embedded vertex normal surfaces in standard (tri-quad) space.
NNormalSurfaceListquadOctToStandardAN () const
 Converts the set of all embedded vertex almost normal surfaces in quadrilateral-octagon space to the set of all embedded vertex almost normal surfaces in the standard tri-quad-oct space.
NNormalSurfaceListstandardToQuad () const
 Converts the set of all embedded vertex normal surfaces in standard (tri-quad) space to the set of all embedded vertex normal surfaces in quadrilateral space.
NNormalSurfaceListstandardANToQuadOct () const
 Converts the set of all embedded vertex almost normal surfaces in standard tri-quad-oct space to the set of all embedded vertex almost normal surfaces in the smaller quadrilateral-octagon space.
NNormalSurfaceListfilterForLocallyCompatiblePairs () const
 Creates a new list filled with the surfaces from this list that have at least one locally compatible partner.
NNormalSurfaceListfilterForDisjointPairs () const
 Creates a new list filled with the surfaces from this list that have at least one disjoint partner.
NNormalSurfaceListfilterForPotentiallyIncompressible () const
 Creates a new list filled with only the surfaces from this list that "might" represent two-sided incompressible surfaces.
NMatrixIntrecreateMatchingEquations () const
 Returns a newly created matrix containing the matching equations that were used to create this normal surface list.
VectorIterator beginVectors () const
 An iterator that gives access to the raw vectors for surfaces in this list, pointing to the beginning of this surface list.
VectorIterator endVectors () const
 An iterator that gives access to the raw vectors for surfaces in this list, pointing past the end of this surface list.
- Public Member Functions inherited from regina::NPacket
 NPacket (NPacket *parent=0)
 Constructor that inserts the new packet into the overall tree structure.
virtual ~NPacket ()
 Destructor that also orphans this packet and destroys all of its descendants.
const std::string & getPacketLabel () const
 Returns the label associated with this individual packet.
void setPacketLabel (const std::string &newLabel)
 Sets the label associated with this individual packet.
std::string getFullName () const
 Returns a descriptive text string for the packet.
std::string makeUniqueLabel (const std::string &base) const
 Returns a new label that cannot be found anywhere in the entire tree structure.
bool makeUniqueLabels (NPacket *reference)
 Ensures that all packet labels in both this and the given packet tree combined are distinct.
bool hasTag (const std::string &tag) const
 Determines whether this packet has the given associated tag.
bool hasTags () const
 Determines whether this packet has any associated tags at all.
bool addTag (const std::string &tag)
 Associates the given tag with this packet.
bool removeTag (const std::string &tag)
 Removes the association of the given tag with this packet.
void removeAllTags ()
 Removes all associated tags from this packet.
const std::set< std::string > & getTags () const
 Returns the set of all tags associated with this packet.
bool listen (NPacketListener *listener)
 Registers the given packet listener to listen for events on this packet.
bool isListening (NPacketListener *listener)
 Determines whether the given packet listener is currently listening for events on this packet.
bool unlisten (NPacketListener *listener)
 Unregisters the given packet listener so that it no longer listens for events on this packet.
NPacketgetTreeParent () const
 Determines the parent packet in the tree structure.
NPacketgetFirstTreeChild () const
 Determines the first child of this packet in the tree structure.
NPacketgetLastTreeChild () const
 Determines the last child of this packet in the tree structure.
NPacketgetNextTreeSibling () const
 Determines the next sibling of this packet in the tree structure.
NPacketgetPrevTreeSibling () const
 Determines the previous sibling of this packet in the tree structure.
NPacketgetTreeMatriarch () const
 Determines the matriarch (the root) of the tree to which this packet belongs.
unsigned levelsDownTo (const NPacket *descendant) const
 Counts the number of levels between this packet and its given descendant in the tree structure.
unsigned levelsUpTo (const NPacket *ancestor) const
 Counts the number of levels between this packet and its given ancestor in the tree structure.
bool isGrandparentOf (const NPacket *descendant) const
 Determines if this packet is equal to or an ancestor of the given packet in the tree structure.
unsigned long getNumberOfChildren () const
 Returns the number of immediate children of this packet.
unsigned long getNumberOfDescendants () const
 Returns the total number of descendants of this packet.
unsigned long getTotalTreeSize () const
 Determines the total number of packets in the tree or subtree for which this packet is matriarch.
void insertChildFirst (NPacket *child)
 Inserts the given packet as the first child of this packet.
void insertChildLast (NPacket *child)
 Inserts the given packet as the last child of this packet.
void insertChildAfter (NPacket *newChild, NPacket *prevChild)
 Inserts the given packet as a child of this packet at the given location in this packet's child list.
void makeOrphan ()
 Cuts this packet away from its parent in the tree structure and instead makes it matriarch of its own tree.
void reparent (NPacket *newParent, bool first=false)
 Cuts this packet away from its parent in the tree structure, and inserts it as a child of the given packet instead.
void swapWithNextSibling ()
 Swaps this packet with its next sibling in the sequence of children beneath their common parent packet.
void moveUp (unsigned steps=1)
 Moves this packet the given number of steps towards the beginning of its sibling list.
void moveDown (unsigned steps=1)
 Moves this packet the given number of steps towards the end of its sibling list.
void moveToFirst ()
 Moves this packet to be the first in its sibling list.
void moveToLast ()
 Moves this packet to be the last in its sibling list.
void sortChildren ()
 Sorts the immediate children of this packet according to their packet labels.
NPacketnextTreePacket ()
 Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs.
const NPacketnextTreePacket () const
 Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs.
NPacketfirstTreePacket (const std::string &type)
 Finds the first packet of the requested type in a complete depth-first iteration of the tree structure.
const NPacketfirstTreePacket (const std::string &type) const
 Finds the first packet of the requested type in a complete depth-first iteration of the tree structure.
NPacketnextTreePacket (const std::string &type)
 Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure.
const NPacketnextTreePacket (const std::string &type) const
 Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure.
NPacketfindPacketLabel (const std::string &label)
 Finds the packet with the requested label in the tree or subtree for which this packet is matriarch.
const NPacketfindPacketLabel (const std::string &label) const
 Finds the packet with the requested label in the tree or subtree for which this packet is matriarch.
bool isPacketEditable () const
 Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children.
NPacketclone (bool cloneDescendants=false, bool end=true) const
 Clones this packet (and possibly its descendants), assigns to it a suitable unused label and inserts the clone into the tree as a sibling of this packet.
void writeXMLFile (std::ostream &out) const
 Writes a complete XML file containing the subtree with this packet as matriarch.
- Public Member Functions inherited from regina::ShareableObject
 ShareableObject ()
 Default constructor that does nothing.
virtual ~ShareableObject ()
 Default destructor that does nothing.
std::string toString () const
 Returns the output from writeTextShort() as a string.
std::string toStringLong () const
 Returns the output from writeTextLong() as a string.
- Public Member Functions inherited from regina::NSurfaceSet
virtual ~NSurfaceSet ()
 Default destructor that does nothing.
void writeAllSurfaces (std::ostream &out) const
 Writes the number of surfaces in this set followed by the details of each surface to the given output stream.

Static Public Member Functions

static NNormalSurfaceListenumerate (NTriangulation *owner, int newFlavour, bool embeddedOnly=true, NProgressManager *manager=0)
 Enumerates all vertex normal surfaces in the given triangulation using the given flavour of coordinate system.
static NNormalSurfaceListenumerateFundPrimal (NTriangulation *owner, int newFlavour, bool embeddedOnly=true, NNormalSurfaceList *vtxSurfaces=0, NProgressManager *manager=0)
 Enumerates all fundamental normal surfaces in the given triangulation using the given flavour of coordinate system, using the primal Hilbert basis algorithm.
static NNormalSurfaceListenumerateFundDual (NTriangulation *owner, int newFlavour, bool embeddedOnly=true, NProgressManager *manager=0)
 Enumerates all fundamental normal surfaces in the given triangulation using the given flavour of coordinate system, using the dual Hilbert basis algorithm.
static NNormalSurfaceListenumerateStandardDirect (NTriangulation *owner)
 Uses a slow-but-direct procedure to enumerate all embedded vertex normal surfaces in standard (tri-quad) coordinates within the given triangulation.
static NNormalSurfaceListenumerateStandardANDirect (NTriangulation *owner)
 Uses a slow-but-direct procedure to enumerate all embedded vertex almost normal surfaces in standard (tri-quad-oct) coordinates within the given triangulation.
static NNormalSurfaceListenumerateFundFullCone (NTriangulation *owner, int newFlavour, bool embeddedOnly=true)
 Uses an extremely slow procedure to enumerate all embedded fundamental surfaces in the given triangulation, by running Normaliz over the full (and typically very large) solution cone, and only enforcing embedded constraints (such as the quadrilateral constraints) afterwards.
static NNormalSurfaceListenumerateFundCD (NTriangulation *owner, int newFlavour, bool embeddedOnly=true)
 Uses an extremely slow modified Contejean-Devie procedure to enumerate all embedded fundamental surfaces in the given triangulation.
static NXMLPacketReadergetXMLReader (NPacket *parent)
 (end: File I/O)
static NNormalSurfaceListreadPacket (NFile &in, NPacket *parent)
 Reads a single packet from the specified file and returns a newly created object containing that information.

Static Public Attributes

static const int packetType
 Contains the integer ID for this packet.
static const int STANDARD
 Represents standard triangle-quadrilateral coordinates for normal surfaces.
static const int AN_STANDARD
 Represents standard triangle-quadrilateral-octagon coordinates for octagonal almost normal surfaces.
static const int QUAD
 Represents quadrilateral coordinates for normal surfaces.
static const int AN_QUAD_OCT
 Represents quadrilateral-octagon coordinates for octagonal almost normal surfaces.
static const int EDGE_WEIGHT
 Represents edge weight coordinates for normal surfaces.
static const int FACE_ARCS
 Represents face arc coordinates for normal surfaces.
static const int AN_LEGACY
 Indicates that a list of almost normal surfaces was created using Regina 4.5.1 or earlier, where surfaces with more than one octagon of the same type were stripped out of the final solution set.
static const int ORIENTED
 Represents standard triangle-quadrilateral coordinates for transversely oriented normal surfaces.
static const int ORIENTED_QUAD
 Represents quadrilateral coordinates for transversely oriented normal surfaces.
- Static Public Attributes inherited from regina::NPacket

Protected Member Functions

 NNormalSurfaceList ()
 Creates a new normal surface list performing no initialisation whatsoever other than property initialisation.
virtual NPacketinternalClonePacket (NPacket *parent) const
 Makes a newly allocated copy of this packet.
virtual void writeXMLPacketData (std::ostream &out) const
 Writes a chunk of XML containing the data for this packet only.
- Protected Member Functions inherited from regina::NPacket
void writeXMLPacketTree (std::ostream &out) const
 Writes a chunk of XML containing the subtree with this packet as matriarch.

Protected Attributes

std::vector< NNormalSurface * > surfaces
 Contains the normal surfaces stored in this packet.
int flavour
 Stores which flavour of coordinate system is being used by the normal surfaces in this packet.
bool embedded
 Stores whether we are only interested in embedded normal surfaces.

Friends

class regina::NXMLNormalSurfaceListReader

Additional Inherited Members

- Public Types inherited from regina::NPacket
typedef ChangeEventSpan ChangeEventBlock
 A deprecated typedef for ChangeEventSpan.

Detailed Description

A packet representing a collection of normal surfaces in a 3-manifold.

Such a packet must always be a child packet of the triangulation from which the surfaces were obtained. If this triangulation changes, the information contained in this packet will become invalid.

See the NNormalSurfaceVector class notes for details of what to do when introducing a new flavour of coordinate system.

Normal surface lists should be created using the routine enumerate(), which is new as of Regina 3.95.

Test:
Included in the test suite.
Todo:

Feature: Allow custom matching equations.

Feature: Allow enumeration with some coordinates explicitly set to zero.

Feature: Allow generating only closed surfaces.

Feature: Generate facets of the solution space representing embedded surfaces.


Constructor & Destructor Documentation

regina::NNormalSurfaceList::~NNormalSurfaceList ( )
inlinevirtual

Destroys this list and all the surfaces within.

regina::NNormalSurfaceList::NNormalSurfaceList ( )
inlineprotected

Creates a new normal surface list performing no initialisation whatsoever other than property initialisation.


Member Function Documentation

virtual bool regina::NNormalSurfaceList::allowsAlmostNormal ( ) const
virtual

Determines if the flavour of coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs.

Returns:
true if and only if almost normal surfaces are allowed.

Implements regina::NSurfaceSet.

virtual bool regina::NNormalSurfaceList::allowsOriented ( ) const
virtual

Determines if the flavour of coordinate system being used allows for transversely oriented normal surfaces.

Returns:
true if and only if transverse orientations are supported.

Implements regina::NSurfaceSet.

virtual bool regina::NNormalSurfaceList::allowsSpun ( ) const
virtual

Determines if the flavour of coordinate system being used allows for spun normal surfaces.

Returns:
true if and only if spun normal surface are supported.

Implements regina::NSurfaceSet.

NNormalSurfaceList::VectorIterator regina::NNormalSurfaceList::beginVectors ( ) const
inline

An iterator that gives access to the raw vectors for surfaces in this list, pointing to the beginning of this surface list.

Python:
Not present.
Returns:
an iterator at the beginning of this surface list.
bool regina::NNormalSurfaceList::dependsOnParent ( ) const
inlinevirtual

Determines if this packet depends upon its parent.

This is true if the parent cannot be altered without invalidating or otherwise upsetting this packet.

Returns:
true if and only if this packet depends on its parent.

Implements regina::NPacket.

NNormalSurfaceList::VectorIterator regina::NNormalSurfaceList::endVectors ( ) const
inline

An iterator that gives access to the raw vectors for surfaces in this list, pointing past the end of this surface list.

This iterator is not dereferenceable.

Python:
Not present.
Returns:
an iterator past the end of this surface list.
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerate ( NTriangulation owner,
int  newFlavour,
bool  embeddedOnly = true,
NProgressManager manager = 0 
)
static

Enumerates all vertex normal surfaces in the given triangulation using the given flavour of coordinate system.

These vertex normal surfaces will be stored in a new normal surface list. Their representations will use the smallest possible integer coordinates. The option is offered to find only embedded normal surfaces or to also include immersed and singular normal surfaces.

The normal surface list that is created will be inserted as the last child of the given triangulation. This triangulation must remain the parent of this normal surface list, and must not change while this normal surface list remains in existence.

If a progress manager is passed, the normal surface enumeration will take place in a new thread and this routine will return immediately. The NProgress object assigned to this progress manager is guaranteed to be of the class NProgressNumber.

If no progress manager is passed, the enumeration will run in the current thread and this routine will return only when the enumeration is complete. Note that this enumeration can be extremely slow for larger triangulations.

Todo:

Feature: Allow picking up the first ``interesting'' surface and bailing en route.

Feature (long-term): Determine the faces of the normal solution space.

Feature (long-term): Allow either subsets of normal surface lists or allow deletion of surfaces from lists.

Parameters:
ownerthe triangulation upon which this list of normal surfaces will be based.
newFlavourthe flavour of coordinate system to be used; this must be one of the predefined coordinate system constants in NNormalSurfaceList.
embeddedOnlytrue if only embedded normal surfaces are to be produced, or false if immersed and singular normal surfaces are also to be produced; this defaults to true.
managera progress manager through which progress will be reported, or 0 if no progress reporting is required. If non-zero, manager must point to a progress manager for which NProgressManager::isStarted() is still false.
Returns:
the newly created normal surface list. Note that if a progress manager is passed then this list may not be completely filled when this routine returns. If a progress manager is passed and a new thread could not be started, this routine returns 0 (and no normal surface list is created).
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerateFundCD ( NTriangulation owner,
int  newFlavour,
bool  embeddedOnly = true 
)
static

Uses an extremely slow modified Contejean-Devie procedure to enumerate all embedded fundamental surfaces in the given triangulation.

For details of the modifications, see "Fundamental normal surfaces and the enumeration of Hilbert bases", Burton, arXiv:1111.7055, Nov 2011.

Aside from the underlying algorithm, the behaviour of this routine is identical to enumerateFundPrimal() and enumerateFundDual(). See those routines for details regarding preconditions, postconditions, ownership and so on.

Unlike enumerateFundPrimal() and enumerateFundDual(), this routine does not support progress management, and does not support running in a separate thread.

Warning:
Users will generally not want to call this routine, since it is typically much slower than either enumerateFundPrimal() or enumerateFundDual(), and it gives precisely the same results. This routine is provided mainly for interest's sake, and to allow comparisons between different algorithms.
Parameters:
ownerthe triangulation upon which this list of normal surfaces will be based.
newFlavourthe flavour of coordinate system to be used; this must be one of the predefined coordinate system constants in NNormalSurfaceList.
embeddedOnlytrue if only embedded normal surfaces are to be produced, or false if immersed and singular normal surfaces are also to be produced; this defaults to true.
Returns:
the newly created normal surface list.
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerateFundDual ( NTriangulation owner,
int  newFlavour,
bool  embeddedOnly = true,
NProgressManager manager = 0 
)
static

Enumerates all fundamental normal surfaces in the given triangulation using the given flavour of coordinate system, using the dual Hilbert basis algorithm.

These fundamental normal surfaces will be stored in a new normal surface list. The option is offered to find only embedded normal surfaces or to also include immersed and singular normal surfaces.

The dual algorithm is fast but its performance is highly variable; for this reason the primal algorithm is recommended instead. For full details of both procedures, see "Fundamental normal surfaces and the enumeration of Hilbert bases", Burton, arXiv:1111.7055, Nov 2011.

The normal surface list that is created will be inserted as the last child of the given triangulation. This triangulation must remain the parent of this normal surface list, and must not change while this normal surface list remains in existence.

If a progress manager is passed, the normal surface enumeration will take place in a new thread and this routine will return immediately. The NProgress object assigned to this progress manager is guaranteed to be of the class NProgressNumber.

If no progress manager is passed, the enumeration will run in the current thread and this routine will return only when the enumeration is complete. Note that this enumeration can be extremely slow for larger triangulations.

Parameters:
ownerthe triangulation upon which this list of normal surfaces will be based.
newFlavourthe flavour of coordinate system to be used; this must be one of the predefined coordinate system constants in NNormalSurfaceList.
embeddedOnlytrue if only embedded normal surfaces are to be produced, or false if immersed and singular normal surfaces are also to be produced; this defaults to true.
managera progress manager through which progress will be reported, or 0 if no progress reporting is required. If non-zero, manager must point to a progress manager for which NProgressManager::isStarted() is still false.
Returns:
the newly created normal surface list. Note that if a progress manager is passed then this list may not be completely filled when this routine returns. If a progress manager is passed and a new thread could not be started, this routine returns 0 (and no normal surface list is created).
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerateFundFullCone ( NTriangulation owner,
int  newFlavour,
bool  embeddedOnly = true 
)
static

Uses an extremely slow procedure to enumerate all embedded fundamental surfaces in the given triangulation, by running Normaliz over the full (and typically very large) solution cone, and only enforcing embedded constraints (such as the quadrilateral constraints) afterwards.

Aside from the underlying algorithm, the behaviour of this routine is identical to enumerateFundPrimal() and enumerateFundDual(). See those routines for details regarding preconditions, postconditions, ownership and so on.

Unlike enumerateFundPrimal() and enumerateFundDual(), this routine does not support progress management, and does not support running in a separate thread.

Warning:
Users will generally not want to call this routine, since it is typically much slower than either enumerateFundPrimal() or enumerateFundDual(), and it gives precisely the same results. This routine is provided mainly for interest's sake, and to allow comparisons between different algorithms.
Parameters:
ownerthe triangulation upon which this list of normal surfaces will be based.
newFlavourthe flavour of coordinate system to be used; this must be one of the predefined coordinate system constants in NNormalSurfaceList.
embeddedOnlytrue if only embedded normal surfaces are to be produced, or false if immersed and singular normal surfaces are also to be produced; this defaults to true.
Returns:
the newly created normal surface list.
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerateFundPrimal ( NTriangulation owner,
int  newFlavour,
bool  embeddedOnly = true,
NNormalSurfaceList vtxSurfaces = 0,
NProgressManager manager = 0 
)
static

Enumerates all fundamental normal surfaces in the given triangulation using the given flavour of coordinate system, using the primal Hilbert basis algorithm.

These fundamental normal surfaces will be stored in a new normal surface list. The option is offered to find only embedded normal surfaces or to also include immersed and singular normal surfaces.

The primal algorithm is the recommended method for enumerating fundamental normal surfaces, although other algorithms are made available in this class also. For full details of the procedure, see "Fundamental normal surfaces and the enumeration of Hilbert bases", Burton, arXiv:1111.7055, Nov 2011.

The normal surface list that is created will be inserted as the last child of the given triangulation. This triangulation must remain the parent of this normal surface list, and must not change while this normal surface list remains in existence.

The first step of the primal algorithm is to enumerate all vertex normal surfaces. If you have already done this, you may pass the list of vertex normal surfaces as the (optional) parameter vtxSurfaces.

If a progress manager is passed, the normal surface enumeration will take place in a new thread and this routine will return immediately. The NProgress object assigned to this progress manager is guaranteed to be of the class NProgressNumber.

If no progress manager is passed, the enumeration will run in the current thread and this routine will return only when the enumeration is complete. Note that this enumeration can be extremely slow for larger triangulations.

Precondition:
If non-zero, the argument vtxSurfaces is precisely the set of all vertex normal surfaces in the given triangulation, enumerated using the same coordinate system and embedded-only constraints as given here.
Parameters:
ownerthe triangulation upon which this list of normal surfaces will be based.
newFlavourthe flavour of coordinate system to be used; this must be one of the predefined coordinate system constants in NNormalSurfaceList.
embeddedOnlytrue if only embedded normal surfaces are to be produced, or false if immersed and singular normal surfaces are also to be produced; this defaults to true.
vtxSurfacesthe set of all vertex normal surfaces as enumerated under the same coordinate system and constraints as given here; this may be 0 if unknown.
managera progress manager through which progress will be reported, or 0 if no progress reporting is required. If non-zero, manager must point to a progress manager for which NProgressManager::isStarted() is still false.
Returns:
the newly created normal surface list. Note that if a progress manager is passed then this list may not be completely filled when this routine returns. If a progress manager is passed and a new thread could not be started, this routine returns 0 (and no normal surface list is created).
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerateStandardANDirect ( NTriangulation owner)
static

Uses a slow-but-direct procedure to enumerate all embedded vertex almost normal surfaces in standard (tri-quad-oct) coordinates within the given triangulation.

This routine is the almost normal analogue to the enumerateStandardDirect() enumeration routine; see the enumerateStandardDirect() documentation for further information.

Warning:
Users will generally not want to call this routine, since it is often much slower than enumerate() and it gives precisely the same results. This routine is provided mainly for interest's sake, and to allow comparisons between different algorithms.
Parameters:
ownerthe triangulation upon which this list of almost normal surfaces will be based.
Returns:
the newly created surface list.
static NNormalSurfaceList* regina::NNormalSurfaceList::enumerateStandardDirect ( NTriangulation owner)
static

Uses a slow-but-direct procedure to enumerate all embedded vertex normal surfaces in standard (tri-quad) coordinates within the given triangulation.

The standard enumerate() routine will choose the fastest available algorithm for enumerating vertex normal surfaces. In particular, when enumerating embedded vertex normal surfaces in standard (tri-quad) coordinates, it will often take a two-step approach: (i) enumerate vertex normal surfaces in quadrilateral space; (ii) convert the quadrilateral space solution set to a standard tri-quad space solution set. This two-step procedure is typically much faster than enumerating solutions in standard coordinates directly. For details on this procedure see "Converting between quadrilateral and standard solution sets in normal surface theory", Benjamin A. Burton, Algebr. Geom. Topol. 9 (2009), 2121-2174.

This routine allows the user to force a direct enumeration in standard space, without going via quadrilateral space. The algorithm used is the souped-up double description method in standard coordinates as described in "Optimizing the double description method for normal surface enumeration", Benjamin A. Burton, Math. Comp. 79 (2010), 453-484.

Aside from the underlying algorithm, the behaviour of this routine is identical to enumerate(). See enumerate() for details regarding preconditions, postconditions, ownership and so on.

Unlike enumerate(), this routine does not support progress management and does not support running in a separate thread.

Warning:
Users will generally not want to call this routine, since it is often much slower than enumerate() and it gives precisely the same results. This routine is provided mainly for interest's sake, and to allow comparisons between different algorithms.
Parameters:
ownerthe triangulation upon which this list of normal surfaces will be based.
Returns:
the newly created normal surface list.
NNormalSurfaceList* regina::NNormalSurfaceList::filterForDisjointPairs ( ) const

Creates a new list filled with the surfaces from this list that have at least one disjoint partner.

In other words, a surface S from this list will be placed in the new list if and only if there is some other surface T in this list for which S and T can be made to intersect nowhere at all, without changing either normal isotopy class. See NNormalSurface::disjoint() for further details on disjointness testing.

This routine cannot deal with empty, disconnected or non-compact surfaces. Such surfaces will be silently ignored, and will not be used in any disjointness tests (in particular, they will never be considered as a "disjoint partner" for any other surface).

The new list will be inserted as a new child packet of the underlying triangulation (specifically, as the final child). As a convenience, the new list will also be returned from this routine.

This original list is not altered in any way. Likewise, the surfaces in the new list are deep copies of the originals (so they can be altered without affecting the original surfaces).

Precondition:
This list contains only embedded normal surfaces. More precisely, isEmbeddedOnly() must return true.
All surfaces within this list are stored using the same flavour of coordinate system (i.e., the same subclass of NNormalSurfaceVector).
Warning:
If this list contains a vertex link (plus at least one other surface), then the new list will be identical to the old (i.e., every surface will be copied across).
Todo:
Deal properly with surfaces that are too large to handle.
Returns:
the new list, which will also have been inserted as a new child packet of the underlying triangulation.
NNormalSurfaceList* regina::NNormalSurfaceList::filterForLocallyCompatiblePairs ( ) const

Creates a new list filled with the surfaces from this list that have at least one locally compatible partner.

In other words, a surface S from this list will be placed in the new list if and only if there is some other surface T in this list for which S and T are locally compatible. See NNormalSurface::locallyCompatible() for further details on compatibility testing.

The new list will be inserted as a new child packet of the underlying triangulation (specifically, as the final child). As a convenience, the new list will also be returned from this routine.

This original list is not altered in any way. Likewise, the surfaces in the new list are deep copies of the originals (so they can be altered without affecting the original surfaces).

Precondition:
This list contains only embedded normal surfaces. More precisely, isEmbeddedOnly() must return true.
Warning:
If this list contains a vertex link (plus at least one other surface), then the new list will be identical to the old (i.e., every surface will be copied across).
Returns:
the new list, which will also have been inserted as a new child packet of the underlying triangulation.
NNormalSurfaceList* regina::NNormalSurfaceList::filterForPotentiallyIncompressible ( ) const

Creates a new list filled with only the surfaces from this list that "might" represent two-sided incompressible surfaces.

More precisely, we consider all two-sided surfaces in this list, as well as the two-sided double covers of all one-sided surfaces in this list (see below for details on how one-sided surfaces are handled). Each of these surfaces is examined using relatively fast heuristic tests for incompressibility. Any surface that is definitely not incompressible is thrown away, and all other surfaces are placed in the new list.

Therefore, it is guaranteed that every incompressible surface from the old list will be placed in the new list. However, it is not known whether any given surface in the new list is indeed incompressible.

See NNormalSurface::isIncompressible() for the definition of incompressibility that is used here. Note in particular that spheres are never considered incompressible.

As indicated above, this filter works exclusively with two-sided surfaces. If a surface in this list is one-sided, the heuristic incompressibility tests will be run on its two-sided double cover. Nevertheless, if the tests pass, the original one-sided surface (not the double cover) will be added to the new list.

The new list will be inserted as a new child packet of the underlying triangulation (specifically, as the final child). As a convenience, the new list will also be returned from this routine.

This original list is not altered in any way. Likewise, the surfaces in the new list are deep copies of the originals (so they can be altered without affecting the original surfaces).

Currently the heuristic tests include (i) throwing away all vertex links and thin edge links, and then (ii) cutting along the remaining surfaces and running NTriangulation::hasSimpleCompressingDisc() on the resulting bounded triangulations. For more details on these tests see "The Weber-Seifert dodecahedral space is non-Haken", Benjamin A. Burton, J. Hyam Rubinstein and Stephan Tillmann, Trans. Amer. Math. Soc. 364:2 (2012), pp. 911-932.

Precondition:
The underlying 3-manifold triangulation is valid and closed. In particular, it has no ideal vertices.
This list contains only embedded normal surfaces. More precisely, isEmbeddedOnly() must return true.
This list contains only compact, connected normal surfaces.
No surfaces in this list contain any octagonal discs.
Warning:
The behaviour of this routine is subject to change in future versions of Regina, since additional tests may be added to improve the power of this filtering.
Todo:
Add progress tracking.
Returns:
the new list, which will also have been inserted as a new child packet of the underlying triangulation.
int regina::NNormalSurfaceList::getFlavour ( ) const
inlinevirtual

Returns the flavour of coordinate system being used by the surfaces stored in this set.

This will be one of the predefined coordinate system constants in NNormalSurfaceList.

Returns:
the flavour of coordinate system used.

Implements regina::NSurfaceSet.

unsigned long regina::NNormalSurfaceList::getNumberOfSurfaces ( ) const
inlinevirtual

Returns the number of surfaces stored in this set.

Returns:
the number of surfaces.

Implements regina::NSurfaceSet.

virtual int regina::NNormalSurfaceList::getPacketType ( ) const
virtual

Returns the integer ID representing this type of packet.

This is the same for all packets of this class.

Returns:
the packet type ID.

Implements regina::NPacket.

virtual std::string regina::NNormalSurfaceList::getPacketTypeName ( ) const
virtual

Returns an English name for this type of packet.

An example is NTriangulation. This is the same for all packets of this class.

Returns:
the packet type name.

Implements regina::NPacket.

ShareableObject * regina::NNormalSurfaceList::getShareableObject ( )
inlinevirtual

Returns this object cast as a ShareableObject.

Generally the implementation of this routine will simply be return this;.

This routine is necessary because NSurfaceSet is not of type ShareableObject; however, it is presumed that each of its derived classes will be. The aim here is to reduce the mess that could arise combining virtual multiple inheritance with the voluminous casting and recasting that takes place when working with external interfaces.

Returns:
this object cast as a ShareableObject.

Implements regina::NSurfaceSet.

const NNormalSurface * regina::NNormalSurfaceList::getSurface ( unsigned long  index) const
inlinevirtual

Returns the surface at the requested index in this set.

Parameters:
indexthe index of the requested surface in this set; this must be between 0 and getNumberOfSurfaces()-1 inclusive.
Returns:
the normal surface at the requested index in this set.

Implements regina::NSurfaceSet.

virtual NTriangulation* regina::NNormalSurfaceList::getTriangulation ( ) const
virtual

Returns the triangulation in which these normal surfaces live.

Returns:
the triangulation in which these surfaces live.

Implements regina::NSurfaceSet.

static NXMLPacketReader* regina::NNormalSurfaceList::getXMLReader ( NPacket parent)
static

(end: File I/O)

Returns a newly created XML element reader that will read the contents of a single XML packet element. You may assume that the packet to be read is of the same type as the class in which you are implementing this routine.

The XML element reader should read exactly what writeXMLPacketData() writes, and vice versa.

parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. The XML element reader can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.

This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated.

Python:
Not present.
Parameters:
parentthe packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the newly created XML element reader.

Reimplemented from regina::NPacket.

virtual NPacket* regina::NNormalSurfaceList::internalClonePacket ( NPacket parent) const
protectedvirtual

Makes a newly allocated copy of this packet.

This routine should not insert the new packet into the tree structure, clone the packet's associated tags or give the packet a label. It should also not clone any descendants of this packet.

You may assume that the new packet will eventually be inserted into the tree beneath either the same parent as this packet or a clone of that parent.

Parameters:
parentthe parent beneath which the new packet will eventually be inserted.
Returns:
the newly allocated packet.

Implements regina::NPacket.

bool regina::NNormalSurfaceList::isEmbeddedOnly ( ) const
inlinevirtual

Returns whether this set is known to contain only embedded normal surfaces.

If it is possible that there are non-embedded surfaces in this set but it is not known whether any are actually present or not, this routine should return false.

Returns:
true if it is known that only embedded normal surfaces exist in this list, or false if immersed and/or singular normal surfaces might be present.

Implements regina::NSurfaceSet.

NNormalSurfaceList* regina::NNormalSurfaceList::quadOctToStandardAN ( ) const

Converts the set of all embedded vertex almost normal surfaces in quadrilateral-octagon space to the set of all embedded vertex almost normal surfaces in the standard tri-quad-oct space.

This routine is the almost normal analogue to the quadToStandard() conversion routine; see the quadToStandard() documentation for further information.

Precondition:
The underlying triangulation (the parent packet of this normal surface list) is valid, and the link of every vertex is either a sphere or a disc.
This surface list is precisely the set of all embedded vertex almost normal surfaces in quadrilateral-octagon space; no more, no less. Moreover, these vectors are stored using quadrilateral-octagon coordinates. Typically this means that it was obtained through enumerate(), with the flavour set to NNormalSurfaceList::AN_QUAD_OCT and with embeddedOnly set to true.
Returns:
a full list of vertex almost normal surfaces in standard tri-quad-oct coordinates, or 0 if any of the basic sanity checks failed.
NNormalSurfaceList* regina::NNormalSurfaceList::quadToStandard ( ) const

Converts the set of all embedded vertex normal surfaces in quadrilateral space to the set of all embedded vertex normal surfaces in standard (tri-quad) space.

The initial list in quadrilateral space is taken to be this normal surface list; the final list in standard space will be inserted as a new child packet of the underlying triangulation (specifically, as the final child). As a convenience, the final list will also be returned from this routine.

This routine can only be used with normal surfaces, not almost normal surfaces. For almost normal surfaces, see the similar routine quadOctToStandardAN().

This procedure is available for any triangulation whose vertex links are all spheres and/or discs, and is much faster than enumerating surfaces directly in standard tri-quad coordinates. The underlying algorithm is described in detail in "Converting between quadrilateral and standard solution sets in normal surface theory", Benjamin A. Burton, Algebr. Geom. Topol. 9 (2009), 2121-2174.

Typically users do not need to call this routine directly, since the standard enumerate() routine will use it implicitly where possible. That is, when asked for standard vertex surfaces, enumerate() will first find all quadrilateral vertex surfaces and then use this procedure to convert them to standard vertex surfaces; this is generally orders of magnitude faster than enumerating surfaces directly in standard coordinates.

Nevertheless, this standalone routine is provided as a convenience for users who already have a set of quadrilateral vertex surfaces, and who simply wish to convert them to a set of standard vertex surfaces without the cost of implicitly enumerating the quadrilateral vertex surfaces again.

It should be noted that this routine does not simply convert vectors from one form to another; instead it converts a full solution set of vertex surfaces in quadrilateral coordinates to a full solution set of vertex surfaces in standard coordinates. Typically there are many more vertex surfaces in standard coordinates (all of which this routine will find).

This routine will run some very basic sanity checks before starting. Specifically, it will check the validity and vertex links of the underlying triangulation, and will verify that the coordinate flavour and embedded-only flag are set to NNormalSurfaceList::QUAD and true respectively. If any of these checks fails, this routine will do nothing and return 0.

Precondition:
The underlying triangulation (the parent packet of this normal surface list) is valid, and the link of every vertex is either a sphere or a disc.
This normal surface list is precisely the set of all embedded vertex normal surfaces in quadrilateral space; no more, no less. Moreover, these vectors are stored using quadrilateral coordinates. Typically this means that it was obtained through enumerate(), with the flavour set to NNormalSurfaceList::QUAD and with embeddedOnly set to true.
Returns:
a full list of vertex normal surfaces in standard (tri-quad) coordinates, or 0 if any of the basic sanity checks failed.
static NNormalSurfaceList* regina::NNormalSurfaceList::readPacket ( NFile in,
NPacket parent 
)
static

Reads a single packet from the specified file and returns a newly created object containing that information.

You may assume that the packet to be read is of the same type as the class in which you are implementing this routine. The newly created object must also be of this type.

For instance, NTriangulation::readPacket() may assume that the packet is of type NTriangulation, and must return a pointer to a newly created NTriangulation. Deallocation of the newly created packet is the responsibility of whoever calls this routine.

The packet type and label may be assumed to have already been read from the file, and should not be reread. The readPacket() routine should read exactly what writePacket() writes, and vice versa.

parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. This routine can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.

This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated. Within each such subclass the function must be declared to return a pointer to an object of that subclass. For instance, NTriangulation::readPacket() must be declared to return an NTriangulation*, not simply an NPacket*.

New packet types should make this routine simply return 0 since this file format is now obsolete, and older calculation engines will not understand newer packet types anyway.

Deprecated:
For the preferred way to read packets from file, see getXMLReader() and class NXMLPacketReader instead.
Precondition:
The given file is open for reading and all above conditions have been satisfied.
Python:
Not present.
Parameters:
inthe file from which to read the packet.
parentthe packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the packet read from file, or 0 if an error occurred.

Reimplemented from regina::NPacket.

NMatrixInt * regina::NNormalSurfaceList::recreateMatchingEquations ( ) const
inline

Returns a newly created matrix containing the matching equations that were used to create this normal surface list.

The destruction of this matrix is the responsibility of the caller of this routine. Multiple calls to this routine will result in the construction of multiple matrices. This routine in fact merely calls makeMatchingEquations() with the appropriate parameters.

The format of the matrix is identical to that returned by makeMatchingEquations().

Returns:
the matching equations used to create this normal surface list.
NNormalSurfaceList* regina::NNormalSurfaceList::standardANToQuadOct ( ) const

Converts the set of all embedded vertex almost normal surfaces in standard tri-quad-oct space to the set of all embedded vertex almost normal surfaces in the smaller quadrilateral-octagon space.

This routine is the almost normal analogue to the standardToQuad() conversion routine; see the standardToQuad() documentation for further information.

Precondition:
The underlying triangulation (the parent packet of this normal surface list) is valid, and the link of every vertex is either a sphere or a disc.
This normal surface list is precisely the set of all embedded vertex almost normal surfaces in standard tri-quad-oct space; no more, no less. Typically this means that it was obtained through enumerate(), with the flavour set to NNormalSurfaceList::AN_STANDARD and with embeddedOnly set to true.
Returns:
a full list of vertex almost normal surfaces in quadrilateral-octagon coordinates, or 0 if any of the basic sanity checks failed.
NNormalSurfaceList* regina::NNormalSurfaceList::standardToQuad ( ) const

Converts the set of all embedded vertex normal surfaces in standard (tri-quad) space to the set of all embedded vertex normal surfaces in quadrilateral space.

The initial list in standard space is taken to be this normal surface list; the final list in quadrilateral space will be inserted as a new child packet of the underlying triangulation (specifically, as the final child). As a convenience, the final list will also be returned from this routine.

This routine can only be used with normal surfaces, not almost normal surfaces. For almost normal surfaces, see the similar routine standardANToQuadOct().

This procedure is available for any triangulation whose vertex links are all spheres and/or discs. The underlying algorithm is described in detail in "Converting between quadrilateral and standard solution sets in normal surface theory", Benjamin A. Burton, Algebr. Geom. Topol. 9 (2009), 2121-2174.

It should be noted that this routine does not simply convert vectors from one form to another; instead it converts a full solution set of vertex surfaces in standard coordinates to a full solution set of vertex surfaces in quadrilateral coordinates. Typically there are far fewer vertex surfaces in quadrilateral coordinates (all of which this routine will find).

This routine will run some very basic sanity checks before starting. Specifically, it will check the validity and vertex links of the underlying triangulation, and will verify that the coordinate flavour and embedded-only flag are set to NNormalSurfaceList::STANDARD and true respectively. If any of these checks fails, this routine will do nothing and return 0.

Precondition:
The underlying triangulation (the parent packet of this normal surface list) is valid, and the link of every vertex is either a sphere or a disc.
This normal surface list is precisely the set of all embedded vertex normal surfaces in standard (tri-quad) space; no more, no less. Moreover, these vectors are stored using standard coordinates. Typically this means that this list was obtained through enumerate(), with the flavour set to NNormalSurfaceList::STANDARD and with embeddedOnly set to true.
Returns:
a full list of vertex normal surfaces in quadrilateral coordinates, or 0 if any of the basic sanity checks failed.
virtual void regina::NNormalSurfaceList::writePacket ( NFile out) const
virtual

Writes the packet details to the given old-style binary file.

You may assume that the packet type and label have already been written. Only the actual data stored in the packet need be written.

The default implementation for this routine does nothing; new packet types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown packet types when reading from binary files.

Deprecated:
For the preferred way to write packets to file, see writeXMLFile() and writeXMLPacketData() instead.
Precondition:
The given file is open for writing and satisfies the assumptions listed above.
Python:
Not present.
Parameters:
outthe file to be written to.

Reimplemented from regina::NPacket.

virtual void regina::NNormalSurfaceList::writeTextLong ( std::ostream &  out) const
virtual

Writes this object in long text format to the given output stream.

The output should provided the user with all the information they could want. The output should end with a newline.

The default implementation of this routine merely calls writeTextShort() and adds a newline.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
outthe output stream to which to write.

Reimplemented from regina::ShareableObject.

virtual void regina::NNormalSurfaceList::writeTextShort ( std::ostream &  out) const
virtual

Writes this object in short text format to the given output stream.

The output should fit on a single line and no newline should be written.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
outthe output stream to which to write.

Implements regina::ShareableObject.

virtual void regina::NNormalSurfaceList::writeXMLPacketData ( std::ostream &  out) const
protectedvirtual

Writes a chunk of XML containing the data for this packet only.

You may assume that the packet opening tag (including the packet type and label) has already been written, and that all child packets followed by the corresponding packet closing tag will be written immediately after this routine is called. This routine need only write the internal data stored in this specific packet.

Parameters:
outthe output stream to which the XML should be written.

Implements regina::NPacket.


Member Data Documentation

const int regina::NNormalSurfaceList::AN_LEGACY
static

Indicates that a list of almost normal surfaces was created using Regina 4.5.1 or earlier, where surfaces with more than one octagon of the same type were stripped out of the final solution set.

As of Regina 4.6 such surfaces are now included in the solution set, since we need them if we wish to enumerate all almost normal surfaces (not just the vertex almost normal surfaces).

This flavour is only used with legacy data files; new vectors and lists of this flavour cannot be created. The underlying coordinate system is identical to AN_STANDARD.

const int regina::NNormalSurfaceList::AN_QUAD_OCT
static

Represents quadrilateral-octagon coordinates for octagonal almost normal surfaces.

For details, see "Quadrilateral-octagon coordinates for almost normal surfaces", Benjamin A. Burton, Experiment. Math. 19 (2010), 285-315.

const int regina::NNormalSurfaceList::AN_STANDARD
static

Represents standard triangle-quadrilateral-octagon coordinates for octagonal almost normal surfaces.

const int regina::NNormalSurfaceList::EDGE_WEIGHT
static

Represents edge weight coordinates for normal surfaces.

This flavour is for representation only; surface vectors and lists of this flavour cannot be created.

bool regina::NNormalSurfaceList::embedded
protected

Stores whether we are only interested in embedded normal surfaces.

const int regina::NNormalSurfaceList::FACE_ARCS
static

Represents face arc coordinates for normal surfaces.

This flavour is for representation only; surface vectors and lists of this flavour cannot be created.

int regina::NNormalSurfaceList::flavour
protected

Stores which flavour of coordinate system is being used by the normal surfaces in this packet.

const int regina::NNormalSurfaceList::ORIENTED
static

Represents standard triangle-quadrilateral coordinates for transversely oriented normal surfaces.

const int regina::NNormalSurfaceList::ORIENTED_QUAD
static

Represents quadrilateral coordinates for transversely oriented normal surfaces.

const int regina::NNormalSurfaceList::packetType
static

Contains the integer ID for this packet.

Each distinct packet type must have a unique ID, and this should be a positive integer. See packetregistry.h for further requirements regarding ID selection.

This member is not actually provided for NPacket itself, but must be declared for every packet subclass that will be instantiated. A value need not be assigned; packetregistry.h will take care of this task when you register the packet.

Reimplemented from regina::NPacket.

const int regina::NNormalSurfaceList::QUAD
static

Represents quadrilateral coordinates for normal surfaces.

For details, see "Normal surface Q-theory", Jeffrey L. Tollefson, Pacific J. Math. 183 (1998), no. 2, 359–374.

const int regina::NNormalSurfaceList::STANDARD
static

Represents standard triangle-quadrilateral coordinates for normal surfaces.

std::vector<NNormalSurface*> regina::NNormalSurfaceList::surfaces
protected

Contains the normal surfaces stored in this packet.


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

Copyright © 1999-2012, The Regina development team
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).