Regina Calculation Engine
|
A packet representing a collection of normal hypersurfaces in a 4-manifold triangulation. More...
#include <hypersurface/normalhypersurfaces.h>
Classes | |
struct | HypersurfaceInserter |
An output iterator used to insert hypersurfaces into an NormalHypersurfaces. More... | |
class | VectorIterator |
A bidirectional iterator that runs through the raw vectors for hypersurfaces in this list. More... | |
Public Types | |
typedef Packet | SafePointeeType |
The type of object being pointed to. More... | |
Public Member Functions | |
virtual | ~NormalHypersurfaces () |
Destroys this list and all the hypersurfaces within. More... | |
HyperCoords | coords () const |
Returns the coordinate system being used by the hypersurfaces stored in this set. More... | |
HyperList | which () const |
Returns details of which normal hypersurfaces this list represents within the underlying triangulation. More... | |
HyperAlg | algorithm () const |
Returns details of the algorithm that was used to enumerate this list. More... | |
bool | isEmbeddedOnly () const |
Returns whether this set is known to contain only embedded normal hypersurfaces. More... | |
Triangulation< 4 > * | triangulation () const |
Returns the triangulation in which these normal hypersurfaces live. More... | |
size_t | size () const |
Returns the number of hypersurfaces stored in this list. More... | |
const NormalHypersurface * | hypersurface (size_t index) const |
Returns the hypersurface at the requested index in this list. More... | |
virtual void | writeTextShort (std::ostream &out) const |
Writes a short text representation of this object to the given output stream. More... | |
virtual void | writeTextLong (std::ostream &out) const |
Writes a detailed text representation of this object to the given output stream. More... | |
virtual bool | dependsOnParent () const |
Determines if this packet depends upon its parent. More... | |
MatrixInt * | recreateMatchingEquations () const |
Returns a newly created matrix containing the matching equations that were used to create this normal hypersurface list. More... | |
VectorIterator | beginVectors () const |
An iterator that gives access to the raw vectors for hypersurfaces in this list, pointing to the beginning of this hypersurface list. More... | |
VectorIterator | endVectors () const |
An iterator that gives access to the raw vectors for hypersurfaces in this list, pointing past the end of this hypersurface 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... | |
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 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 | |
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... | |
Static Public Member Functions | |
static NormalHypersurfaces * | enumerate (Triangulation< 4 > *owner, HyperCoords coords, HyperList which=HS_LIST_DEFAULT, HyperAlg algHints=HS_ALG_DEFAULT, ProgressTracker *tracker=0) |
A unified routine for enumerating various classes of normal hypersurfaces within a given triangulation. More... | |
static XMLPacketReader * | xmlReader (Packet *parent, XMLTreeResolver &resolver) |
Protected Member Functions | |
NormalHypersurfaces (HyperCoords coords, HyperList which, HyperAlg algorithm) | |
Creates an empty list of normal hypersurfaces with the given parameters. More... | |
virtual Packet * | internalClonePacket (Packet *parent) const |
Makes a newly allocated copy of this packet. More... | |
virtual void | writeXMLPacketData (std::ostream &out) const |
Writes a chunk of XML containing the data for this packet only. More... | |
Protected Attributes | |
std::vector< NormalHypersurface * > | surfaces_ |
Contains the normal hypersurfaces stored in this packet. More... | |
HyperCoords | coords_ |
Stores which coordinate system is being used by the normal hypersurfaces in this packet. More... | |
HyperList | which_ |
Indicates which normal hypersurfaces these represent within the underlying triangulation. More... | |
HyperAlg | algorithm_ |
Stores the details of the enumeration algorithm that was used to generate this list. More... | |
Friends | |
class | XMLNormalHypersurfacesReader |
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 hypersurfaces in a 4-manifold triangulation.
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 NormalHypersurfaceVector class notes for details of what to do when introducing a new coordinate system.
Normal hypersurface lists should be created using the routine enumerate().
|
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.
|
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.