Regina Calculation Engine
|
A packet representing a collection of normal surfaces in a 3-manifold. More...
#include <surfaces/normalsurfaces.h>
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 NormalSurface * | surface (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... | |
NormalSurfaces * | 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. More... | |
NormalSurfaces * | 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. More... | |
NormalSurfaces * | 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. More... | |
NormalSurfaces * | 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. More... | |
template<typename Comparison > | |
void | sort (Comparison &&comp) |
Sorts the surfaces in this list according to the given criterion. More... | |
NormalSurfaces * | filterForLocallyCompatiblePairs () const |
Creates a new list filled with the surfaces from this list that have at least one locally compatible partner. More... | |
NormalSurfaces * | filterForDisjointPairs () const |
Creates a new list filled with the surfaces from this list that have at least one disjoint partner. More... | |
NormalSurfaces * | filterForPotentiallyIncompressible () const |
Creates a new list filled with only the surfaces from this list that "might" represent two-sided incompressible surfaces. More... | |
MatrixInt * | recreateMatchingEquations () 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... | |
bool | hasOwner () const |
Indicates whether some other object in the calculation engine is responsible for ultimately destroying this object. 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 | |
Packet * | parent () const |
Determines the parent packet in the tree structure. More... | |
Packet * | firstChild () const |
Determines the first child of this packet in the tree structure. More... | |
Packet * | lastChild () const |
Determines the last child of this packet in the tree structure. More... | |
Packet * | nextSibling () const |
Determines the next sibling of this packet in the tree structure. More... | |
Packet * | prevSibling () const |
Determines the previous sibling of this packet in the tree structure. More... | |
Packet * | root () 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... | |
Packet * | nextTreePacket () |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. More... | |
const Packet * | nextTreePacket () const |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. More... | |
Packet * | nextTreePacket (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 Packet * | nextTreePacket (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... | |
Packet * | firstTreePacket (const std::string &type) |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. More... | |
const Packet * | firstTreePacket (const std::string &type) const |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. More... | |
Packet * | findPacketLabel (const std::string &label) |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. More... | |
const Packet * | findPacketLabel (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 | |
Packet * | clone (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... | |
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... | |
Static Public Member Functions | |
static NormalSurfaces * | enumerate (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 XMLPacketReader * | xmlReader (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 Packet * | internalClonePacket (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... | |
void | writeXMLPacketTree (std::ostream &out) const |
Writes a chunk of XML containing the subtree with this packet as matriarch. 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 |
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().
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.
|
inherited |
The type of object being pointed to.
|
inlinevirtual |
Destroys this list and all the surfaces within.
|
inlineprotected |
Creates an empty list of normal surfaces with the given parameters.
coords | the coordinate system to be used for filling this list. |
which | indicates which normal surfaces these will represent within the underlying triangulation. |
algorithm | details of the enumeration algorithm that will be used to fill this list. |
|
inline |
Returns details of the algorithm that was used to enumerate this list.
These may not be the same NormalAlg flags that were passed to enumerate(). In particular, default values will have been explicitly filled in, invalid and/or redundant values will have been removed, and unavailable and/or unsupported combinations of algorithm flags will be replaced with whatever algorithm was actually used.
bool regina::NormalSurfaces::allowsAlmostNormal | ( | ) | const |
Determines if the coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs.
true
if and only if almost normal surfaces are allowed. bool regina::NormalSurfaces::allowsOriented | ( | ) | const |
Determines if the coordinate system being used allows for transversely oriented normal surfaces.
true
if and only if transverse orientations are supported. bool regina::NormalSurfaces::allowsSpun | ( | ) | const |
Determines if the coordinate system being used allows for spun normal surfaces.
true
if and only if spun normal surface are supported.
|
inline |
An iterator that gives access to the raw vectors for surfaces in this list, pointing to the beginning of this surface list.
@return an iterator at the beginning of this surface list.
|
inline |
Returns the coordinate system being used by the surfaces stored in this set.
|
inlineoverridevirtual |
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::Packet.
|
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.
|
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.
@return an iterator past the end of this surface list.
|
static |
A unified routine for enumerating various classes of normal surfaces within a given triangulation.
The NormalCoords argument allows you to specify an underlying coordinate system (e.g., standard coordinates, quadrilateral coordinates or almost normal coordinates).
The NormalList argument is a combination of flags that allows you to specify exactly which normal surfaces you require. This includes (i) whether you want all vertex surfaces or all fundamental surfaces, which defaults to NS_VERTEX if you specify neither or both; and (ii) whether you want only properly embedded surfaces or you also wish to include immersed and/or singular surfaces, which defaults to NS_EMBEDDED_ONLY if you specify neither or both.
The NormalAlg argument is a combination of flags that allows you to control the underlying enumeration algorithm. These flags are treated as hints only: if your selection of algorithm is invalid, unavailable or unsupported then Regina will choose something more appropriate. Unless you have some specialised need, the default NS_ALG_DEFAULT (which makes no hints at all) will allow Regina to choose what it thinks will be the most efficient method.
The enumerated surfaces will be stored in a new normal surface list, and their representations will be scaled down to use the smallest possible integer coordinates. This normal surface list will be inserted into the packet tree 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 tracker is passed, the normal surface enumeration will take place in a new thread and this routine will return immediately. If the user cancels the operation from another thread, then the normal surface list will not be inserted into the packet tree (but the caller of this routine will still need to delete it). Regarding progress tracking, this routine will declare and work through a series of stages whose combined weights sum to 1; typically this means that the given tracker must not have been used before.
If no progress tracker 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.
If an error occurs, then this routine will return null
, no normal surface list will be created, and the progress tracker (if passed) will be marked as finished. Errors can occur in the following scenarios:
owner | the triangulation upon which this list of normal surfaces will be based. |
coords | the coordinate system to be used. |
which | indicates which normal surfaces should be enumerated. |
algHints | passes requests to Regina for which specific enumeration algorithm should be used. |
tracker | a progress tracker through which progress will be reported, or null if no progress reporting is required. |
null
instead. NormalSurfaces* regina::NormalSurfaces::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 NormalSurface::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).
true
. NormalSurfaces* regina::NormalSurfaces::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 NormalSurface::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).
true
.NormalSurfaces* regina::NormalSurfaces::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 NormalSurface::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 Triangulation<3>::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.
true
.
|
inlineinherited |
Is there one or more SafePtr currently pointing to this object?
|
overrideprotectedvirtual |
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::Packet.
|
inline |
Returns whether this list was constructed to contain only properly embedded surfaces.
If this returns false
, it does not guarantee that immersed and/or singular surfaces are present; it merely indicates that they were not deliberately excluded (for instance, the quadrilateral constraints were not enforced).
true
if this list was constructed to contain only properly embedded surfaces, or false
otherwise. NormalSurfaces* regina::NormalSurfaces::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.
true
.null
if any of the basic sanity checks failed. NormalSurfaces* regina::NormalSurfaces::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 system and embedded-only flag are set to NS_QUAD and true
respectively. If any of these checks fails, this routine will do nothing and return null
.
true
.null
if any of the basic sanity checks failed. MatrixInt* regina::NormalSurfaces::recreateMatchingEquations | ( | ) | const |
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().
Note that there are situations in which makeMatchingEquations() returns null
(because the triangulation is not supported by the chosen coordinate system). However, this routine should never return null
, because if makeMatchingEquations() had returned null
then this normal surface list would not have been created in the first place.
bool regina::NormalSurfaces::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.
CSV files are human-readable and human-editable, and are suitable for importing into spreadsheets and databases.
The surfaces will be exported in edge weight coordinates. Thus there will be one coordinate for each edge of the underlying triangulation; each such coordinate will become a separate field in the CSV file.
As well as the normal surface coordinates, additional properties of the normal surfaces (such as Euler characteristic, orientability, and so on) can be included as extra fields in the export. Users can select precisely which properties to include by passing a bitmask, formed as a bitwise or combination of constants from the regina::SurfaceExportFields enumeration type.
The CSV format used here begins with a header row, and uses commas as field separators. Text fields with arbitrary contents are placed inside double quotes, and the double quote character itself is represented by a pair of double quotes. Thus the string my "normal" surface's name
would be stored as "my ""normal"" surface's name"
.
filename | the name of the CSV file to export to. |
additionalFields | a bitwise combination of constants from regina::SurfaceExportFields indicating which additional properties of surfaces should be included in the export. |
true
if the export was successful, or false
otherwise. bool regina::NormalSurfaces::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.
CSV files are human-readable and human-editable, and are suitable for importing into spreadsheets and databases.
The surfaces will be exported in standard coordinates (tri-quad coordinates for normal surfaces, or tri-quad-oct coordinates for almost normal surfaces). Each coordinate will become a separate field in the CSV file.
As well as the normal surface coordinates, additional properties of the normal surfaces (such as Euler characteristic, orientability, and so on) can be included as extra fields in the export. Users can select precisely which properties to include by passing a bitmask, formed as a bitwise or combination of constants from the regina::SurfaceExportFields enumeration type.
The CSV format used here begins with a header row, and uses commas as field separators. Text fields with arbitrary contents are placed inside double quotes, and the double quote character itself is represented by a pair of double quotes. Thus the string my "normal" surface's name
would be stored as "my ""normal"" surface's name"
.
filename | the name of the CSV file to export to. |
additionalFields | a bitwise combination of constants from regina::SurfaceExportFields indicating which additional properties of surfaces should be included in the export. |
true
if the export was successful, or false
otherwise.
|
inline |
Returns the number of surfaces stored in this list.
|
inline |
Sorts the surfaces in this list according to the given criterion.
This sort is stable, i.e., surfaces that are equivalent under the given criterion will remain in the same relative order.
The implementation of this routine uses std::stable_sort.
comp | a binary function (or function object) that accepts two const NormalSurface pointers, and returns true if and only if the first surface should appear before the second in the sorted list. |
NormalSurfaces* regina::NormalSurfaces::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.
true
.null
if any of the basic sanity checks failed. NormalSurfaces* regina::NormalSurfaces::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 system and embedded-only flag are set to NS_STANDARD and true
respectively. If any of these checks fails, this routine will do nothing and return null
.
true
.null
if any of the basic sanity checks failed.
|
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.
__str__()
.
|
inline |
Triangulation<3>* regina::NormalSurfaces::triangulation | ( | ) | const |
Returns the triangulation in which these normal surfaces live.
|
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.
|
inline |
Returns details of which normal surfaces this list represents within the underlying triangulation.
This may not be the same NormalList that was passed to enumerate(). In particular, default values will have been explicitly filled in (such as NS_VERTEX and/or NS_EMBEDDED_ONLY), and invalid and/or redundant values will have been removed.
void regina::NormalSurfaces::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.
Output will be over many lines.
out | the output stream to which to write. |
|
overridevirtual |
Writes a detailed text representation of this object to the given output stream.
This may be reimplemented by subclasses, but the parent Packet class offers a reasonable default implementation.
out | the output stream to which to write. |
Reimplemented from regina::Packet.
|
overridevirtual |
Writes a short text representation of this object to the given output stream.
This must be reimplemented by subclasses.
out | the output stream to which to write. |
Implements regina::Packet.
|
overrideprotectedvirtual |
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::Packet.
|
protected |
Stores the details of the enumeration algorithm that was used to generate this list.
This might not be the same as the algorithmHints flag passed to the corresponding enumeration routine (e.g., if invalid or inappropriate flags were passed).
|
protected |
Stores which coordinate system is being used by the normal surfaces in this packet.
|
protected |
Contains the normal surfaces stored in this packet.
|
protected |
Indicates which normal surfaces these represent within the underlying triangulation.