#include <nnormalsurfacelist.h>
Inheritance diagram for regina::NNormalSurfaceList:
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 octahedral discs. | |
virtual bool | isEmbeddedOnly () const |
Returns whether this set is known to contain only embedded normal surfaces. | |
virtual NTriangulation * | getTriangulation () const |
Returns the triangulation upon which these normal surfaces are based. | |
virtual unsigned long | getNumberOfSurfaces () const |
Returns the number of surfaces stored in this set. | |
virtual const NNormalSurface * | getSurface (unsigned long index) const |
Returns the surface at the requested index in this set. | |
virtual ShareableObject * | getShareableObject () |
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. | |
NMatrixInt * | recreateMatchingEquations () const |
Returns a newly created matrix containing the matching equations that were used to create this normal surface list. | |
Static Public Member Functions | |
static NNormalSurfaceList * | enumerate (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 NXMLPacketReader * | getXMLReader (NPacket *parent) |
Returns a newly created XML element reader that will read the contents of a single XML packet element. | |
static NNormalSurfaceList * | readPacket (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-quad coordinates for normal surfaces. | |
static const int | AN_STANDARD |
Represents standard triangle-quad-oct coordinates for almost normal surfaces. | |
static const int | QUAD |
Represents quad coordinates for 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. | |
Protected Member Functions | |
NNormalSurfaceList () | |
Creates a new normal surface list performing no intialisation whatsoever other than property initialisation. | |
virtual NPacket * | internalClonePacket (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 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 |
Classes | |
class | Enumerator |
A thread class that actually performs the normal surface enumeration. | |
struct | SurfaceInserter |
An output iterator used to insert surfaces into an NNormalSurfaceList. More... |
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.
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.
regina::NNormalSurfaceList::~NNormalSurfaceList | ( | ) | [inline, virtual] |
Destroys this list and all the surfaces within.
regina::NNormalSurfaceList::NNormalSurfaceList | ( | ) | [inline, protected] |
Creates a new normal surface list performing no intialisation whatsoever other than property initialisation.
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 octahedral discs.
true
if and only if almost normal surfaces are allowed. Implements regina::NSurfaceSet.
bool regina::NNormalSurfaceList::dependsOnParent | ( | ) | const [inline, virtual] |
Determines if this packet depends upon its parent.
This is true if the parent cannot be altered without invalidating or otherwise upsetting this packet.
true
if and only if this packet depends on its parent. Implements regina::NPacket.
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.
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.
Optimise: Investigate obvious compressions.
Optimise: Investigate monte carlo methods.
owner | the triangulation upon which this list of normal surfaces will be based. | |
newFlavour | the flavour of coordinate system to be used; this must be one of the predefined coordinate system constants in NNormalSurfaceList. | |
embeddedOnly | true 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 . | |
manager | a 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 . |
int regina::NNormalSurfaceList::getFlavour | ( | ) | const [inline, virtual] |
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.
Implements regina::NSurfaceSet.
unsigned long regina::NNormalSurfaceList::getNumberOfSurfaces | ( | ) | const [inline, virtual] |
Returns the number of surfaces stored in this set.
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.
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.
Implements regina::NPacket.
ShareableObject * regina::NNormalSurfaceList::getShareableObject | ( | ) | [inline, virtual] |
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.
Implements regina::NSurfaceSet.
const NNormalSurface * regina::NNormalSurfaceList::getSurface | ( | unsigned long | index | ) | const [inline, virtual] |
Returns the surface at the requested index in this set.
index | the index of the requested surface in this set; this must be between 0 and getNumberOfSurfaces()-1 inclusive. |
Implements regina::NSurfaceSet.
virtual NTriangulation* regina::NNormalSurfaceList::getTriangulation | ( | ) | const [virtual] |
Returns the triangulation upon which these normal surfaces are based.
Implements regina::NSurfaceSet.
static NXMLPacketReader* regina::NNormalSurfaceList::getXMLReader | ( | NPacket * | parent | ) | [static] |
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.
parent | the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch. |
Reimplemented from regina::NPacket.
virtual NPacket* regina::NNormalSurfaceList::internalClonePacket | ( | NPacket * | parent | ) | const [protected, virtual] |
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.
parent | the parent beneath which the new packet will eventually be inserted. |
Implements regina::NPacket.
bool regina::NNormalSurfaceList::isEmbeddedOnly | ( | ) | const [inline, virtual] |
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
.
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.
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.
in | the file from which to read the packet. | |
parent | the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch. |
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().
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.
out | the 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.
out | the 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.
out | the output stream to which to write. |
Implements regina::ShareableObject.
virtual void regina::NNormalSurfaceList::writeXMLPacketData | ( | std::ostream & | out | ) | const [protected, virtual] |
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.
out | the output stream to which the XML should be written. |
Implements regina::NPacket.
const int regina::NNormalSurfaceList::AN_STANDARD [static] |
Represents standard triangle-quad-oct coordinates for 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::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 quad coordinates for normal surfaces.
const int regina::NNormalSurfaceList::STANDARD [static] |
Represents standard triangle-quad coordinates for normal surfaces.
std::vector<NNormalSurface*> regina::NNormalSurfaceList::surfaces [protected] |
Contains the normal surfaces stored in this packet.