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... | |
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... | |
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) |
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... | |
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... | |
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.
|
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.
|
inlineinherited |
Is there one or more SafePtr currently pointing to this object?
|
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__()
.
|
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.