Regina Calculation Engine
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
regina::NormalSurfaces Class Referenceabstract

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

#include <surfaces/normalsurfaces.h>

Inheritance diagram for regina::NormalSurfaces:
regina::Packet regina::Output< Packet > regina::SafePointeeBase< Packet >

Classes

struct  SurfaceInserter
 An output iterator used to insert surfaces into an NormalSurfaces. More...
 
class  VectorIterator
 A bidirectional iterator that runs through the raw vectors for surfaces in this list. More...
 

Public Types

typedef Packet SafePointeeType
 The type of object being pointed to. More...
 

Public Member Functions

virtual ~NormalSurfaces ()
 Destroys this list and all the surfaces within. More...
 
NormalCoords coords () const
 Returns the coordinate system being used by the surfaces stored in this set. More...
 
NormalList which () const
 Returns details of which normal surfaces this list represents within the underlying triangulation. More...
 
NormalAlg algorithm () const
 Returns details of the algorithm that was used to enumerate this list. More...
 
bool allowsAlmostNormal () const
 Determines if the coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs. More...
 
bool allowsSpun () const
 Determines if the coordinate system being used allows for spun normal surfaces. More...
 
bool allowsOriented () const
 Determines if the coordinate system being used allows for transversely oriented normal surfaces. More...
 
bool isEmbeddedOnly () const
 Returns whether this list was constructed to contain only properly embedded surfaces. More...
 
Triangulation< 3 > * triangulation () const
 Returns the triangulation in which these normal surfaces live. More...
 
size_t size () const
 Returns the number of surfaces stored in this list. More...
 
const NormalSurfacesurface (size_t index) const
 Returns the surface at the requested index in this set. More...
 
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. More...
 
virtual void writeTextShort (std::ostream &out) const override
 Writes a short text representation of this object to the given output stream. More...
 
virtual void writeTextLong (std::ostream &out) const override
 Writes a detailed text representation of this object to the given output stream. More...
 
virtual bool dependsOnParent () const override
 Determines if this packet depends upon its parent. More...
 
NormalSurfacesquadToStandard () 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. More...
 
NormalSurfacesquadOctToStandardAN () 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. More...
 
NormalSurfacesstandardToQuad () 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. More...
 
NormalSurfacesstandardANToQuadOct () 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. More...
 
template<typename Comparison >
void sort (Comparison &&comp)
 Sorts the surfaces in this list according to the given criterion. More...
 
NormalSurfacesfilterForLocallyCompatiblePairs () const
 Creates a new list filled with the surfaces from this list that have at least one locally compatible partner. More...
 
NormalSurfacesfilterForDisjointPairs () const
 Creates a new list filled with the surfaces from this list that have at least one disjoint partner. More...
 
NormalSurfacesfilterForPotentiallyIncompressible () const
 Creates a new list filled with only the surfaces from this list that "might" represent two-sided incompressible surfaces. More...
 
MatrixIntrecreateMatchingEquations () const
 Returns a newly created matrix containing the matching equations that were used to create this normal surface list. More...
 
bool saveCSVStandard (const char *filename, int additionalFields=regina::surfaceExportAll)
 Exports this list of normal surfaces as a plain text CSV (comma-separated value) file, using standard coordinates. More...
 
bool saveCSVEdgeWeight (const char *filename, int additionalFields=regina::surfaceExportAll)
 Exports the given list of normal surfaces as a plain text CSV (comma-separated value) file, using edge weight coordinates. More...
 
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. More...
 
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. More...
 
std::string str () const
 Returns a short text representation of this object. More...
 
std::string utf8 () const
 Returns a short text representation of this object using unicode characters. More...
 
std::string detail () const
 Returns a detailed text representation of this object. More...
 
bool hasSafePtr () const
 Is there one or more SafePtr currently pointing to this object? More...
 
Packet Identification
virtual PacketType type () const =0
 Returns the unique integer ID representing this type of packet. More...
 
virtual std::string typeName () const =0
 Returns an English name for this type of packet. More...
 
const std::string & label () const
 Returns the label associated with this individual packet. More...
 
std::string humanLabel () const
 Returns the label associated with this individual packet, adjusted if necessary for human-readable output. More...
 
std::string adornedLabel (const std::string &adornment) const
 Returns the label of this packet adorned with the given string. More...
 
void setLabel (const std::string &label)
 Sets the label associated with this individual packet. More...
 
std::string fullName () const
 Returns a descriptive text string for the packet. More...
 
Tags
bool hasTag (const std::string &tag) const
 Determines whether this packet has the given associated tag. More...
 
bool hasTags () const
 Determines whether this packet has any associated tags at all. More...
 
bool addTag (const std::string &tag)
 Associates the given tag with this packet. More...
 
bool removeTag (const std::string &tag)
 Removes the association of the given tag with this packet. More...
 
void removeAllTags ()
 Removes all associated tags from this packet. More...
 
const std::set< std::string > & tags () const
 Returns the set of all tags associated with this packet. More...
 
Event Handling
bool listen (PacketListener *listener)
 Registers the given packet listener to listen for events on this packet. More...
 
bool isListening (PacketListener *listener)
 Determines whether the given packet listener is currently listening for events on this packet. More...
 
bool unlisten (PacketListener *listener)
 Unregisters the given packet listener so that it no longer listens for events on this packet. More...
 
Tree Queries
Packetparent () const
 Determines the parent packet in the tree structure. More...
 
PacketfirstChild () const
 Determines the first child of this packet in the tree structure. More...
 
PacketlastChild () const
 Determines the last child of this packet in the tree structure. More...
 
PacketnextSibling () const
 Determines the next sibling of this packet in the tree structure. More...
 
PacketprevSibling () const
 Determines the previous sibling of this packet in the tree structure. More...
 
Packetroot () const
 Determines the root of the tree to which this packet belongs. More...
 
unsigned levelsDownTo (const Packet *descendant) const
 Counts the number of levels between this packet and its given descendant in the tree structure. More...
 
unsigned levelsUpTo (const Packet *ancestor) const
 Counts the number of levels between this packet and its given ancestor in the tree structure. More...
 
bool isGrandparentOf (const Packet *descendant) const
 Determines if this packet is equal to or an ancestor of the given packet in the tree structure. More...
 
size_t countChildren () const
 Returns the number of immediate children of this packet. More...
 
size_t countDescendants () const
 Returns the total number of strict descendants of this packet. More...
 
size_t totalTreeSize () const
 Determines the total number of packets in the tree or subtree for which this packet is matriarch. More...
 
Tree Manipulation
void insertChildFirst (Packet *child)
 Inserts the given packet as the first child of this packet. More...
 
void insertChildLast (Packet *child)
 Inserts the given packet as the last child of this packet. More...
 
void insertChildAfter (Packet *newChild, Packet *prevChild)
 Inserts the given packet as a child of this packet at the given location in this packet's child list. More...
 
void makeOrphan ()
 Cuts this packet away from its parent in the tree structure and instead makes it matriarch of its own tree. More...
 
void reparent (Packet *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. More...
 
void transferChildren (Packet *newParent)
 Cuts all of this packet's children out of the packet tree, and reinserts them as children of the given packet instead. More...
 
void swapWithNextSibling ()
 Swaps this packet with its next sibling in the sequence of children beneath their common parent packet. More...
 
void moveUp (unsigned steps=1)
 Moves this packet the given number of steps towards the beginning of its sibling list. More...
 
void moveDown (unsigned steps=1)
 Moves this packet the given number of steps towards the end of its sibling list. More...
 
void moveToFirst ()
 Moves this packet to be the first in its sibling list. More...
 
void moveToLast ()
 Moves this packet to be the last in its sibling list. More...
 
void sortChildren ()
 Sorts the immediate children of this packet according to their packet labels. More...
 
Searching and Iterating
SubtreeIterator begin ()
 Returns an iterator at the beginning of the range of packets in the subtree rooted at this packet. More...
 
SubtreeIterator end ()
 Returns an iterator beyond the end of the range of packets in the subtree rooted at this packet. More...
 
PacketDescendants descendants () const
 Returns a lightweight object for iterating through all strict descendants of this packet in the packet tree. More...
 
PacketChildren children () const
 Returns a lightweight object for iterating through the immediate children of this packet. More...
 
PacketnextTreePacket ()
 Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. More...
 
const PacketnextTreePacket () const
 Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. More...
 
PacketnextTreePacket (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. More...
 
const PacketnextTreePacket (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. More...
 
PacketfirstTreePacket (const std::string &type)
 Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. More...
 
const PacketfirstTreePacket (const std::string &type) const
 Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. More...
 
PacketfindPacketLabel (const std::string &label)
 Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. More...
 
const PacketfindPacketLabel (const std::string &label) const
 Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. More...
 
Packet Dependencies
bool isPacketEditable () const
 Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children. More...
 
Cloning
Packetclone (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. More...
 

Static Public Member Functions

static NormalSurfacesenumerate (Triangulation< 3 > *owner, NormalCoords coords, NormalList which=NS_LIST_DEFAULT, NormalAlg algHints=NS_ALG_DEFAULT, ProgressTracker *tracker=nullptr)
 A unified routine for enumerating various classes of normal surfaces within a given triangulation. More...
 
static XMLPacketReaderxmlReader (Packet *parent, XMLTreeResolver &resolver)
 
Constructors and Destructors
static void safeDelete (Packet *p)
 Either destroys or orphans the given packet, according to whether it has safe pointers that currently reference it. More...
 

Protected Member Functions

 NormalSurfaces (NormalCoords coords, NormalList which, NormalAlg algorithm)
 Creates an empty list of normal surfaces with the given parameters. More...
 
virtual PacketinternalClonePacket (Packet *parent) const override
 Makes a newly allocated copy of this packet. More...
 
virtual void writeXMLPacketData (std::ostream &out) const override
 Writes a chunk of XML containing the data for this packet only. More...
 

Protected Attributes

std::vector< NormalSurface * > surfaces
 Contains the normal surfaces stored in this packet. More...
 
NormalCoords coords_
 Stores which coordinate system is being used by the normal surfaces in this packet. More...
 
NormalList which_
 Indicates which normal surfaces these represent within the underlying triangulation. More...
 
NormalAlg algorithm_
 Stores the details of the enumeration algorithm that was used to generate this list. More...
 

Friends

class XMLNormalSurfacesReader
 

File I/O

bool save (const char *filename, bool compressed=true) const
 Saves the subtree rooted at this packet to the given Regina data file, using Regina's native XML file format. More...
 
bool save (std::ostream &s, bool compressed=true) const
 Writes the subtree rooted at this packet to the given output stream, in the format of a Regina XML data file. More...
 
void writeXMLFile (std::ostream &out) const
 Writes the subtree rooted at this packet to the given output stream in Regina's native XML file format. More...
 
std::string internalID () const
 Returns a unique string ID that identifies this packet. More...
 
bool hasOwner () const
 Indicates whether some other object in the calculation engine is responsible for ultimately destroying this object. More...
 
void writeXMLPacketTree (std::ostream &out) const
 Writes a chunk of XML containing the subtree with this packet as matriarch. More...
 

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 NormalSurfaceVector class notes for details of what to do when introducing a new coordinate system.

Normal surface lists should be created using the routine enumerate().

Todo:
Feature: Allow custom matching equations.
Todo:
Feature: Allow enumeration with some coordinates explicitly set to zero.
Todo:
Feature: Allow generating only closed surfaces.
Todo:
Feature: Generate facets of the solution space representing embedded surfaces.

Member Typedef Documentation

◆ SafePointeeType

The type of object being pointed to.

Member Function Documentation

◆ detail()

std::string regina::Output< Packet , false >::detail ( ) const
inherited

Returns a detailed text representation of this object.

This text may span many lines, and should provide the user with all the information they could want. It should be human-readable, should not contain extremely long lines (which cause problems for users reading the output in a terminal), and should end with a final newline. There are no restrictions on the underlying character set.

Returns
a detailed text representation of this object.

◆ hasSafePtr()

bool regina::SafePointeeBase< Packet >::hasSafePtr
inlineinherited

Is there one or more SafePtr currently pointing to this object?

◆ str()

std::string regina::Output< Packet , false >::str ( ) const
inherited

Returns a short text representation of this object.

This text should be human-readable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.

Python:\n In addition to str(), this is also used as the
Python "stringification" function str().
Returns
a short text representation of this object.

◆ utf8()

std::string regina::Output< Packet , false >::utf8 ( ) const
inherited

Returns a short text representation of this object using unicode characters.

Like str(), this text should be human-readable, should fit on a single line, and should not end with a newline. In addition, it may use unicode characters to make the output more pleasant to read. This string will be encoded in UTF-8.

Returns
a short text representation of this object.

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).