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

A packet representing a collection of normal hypersurfaces in a 4-manifold triangulation. More...

#include <hypersurface/normalhypersurfaces.h>

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

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 NormalHypersurfacehypersurface (size_t index) const
 Returns the hypersurface at the requested index in this list. 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...
 
template<typename Comparison >
void sort (Comparison &&comp)
 
Sorts the hypersurfaces in this list according to the given criterion. More...
 
MatrixIntrecreateMatchingEquations () 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...
 
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
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...
 
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 NormalHypersurfacesenumerate (Triangulation< 4 > *owner, HyperCoords coords, HyperList which=HS_LIST_DEFAULT, HyperAlg algHints=HS_ALG_DEFAULT, ProgressTracker *tracker=nullptr)
 A unified routine for enumerating various classes of normal hypersurfaces 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

 NormalHypersurfaces (HyperCoords coords, HyperList which, HyperAlg algorithm)
 Creates an empty list of normal hypersurfaces 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...
 
void writeXMLPacketTree (std::ostream &out) const
 Writes a chunk of XML containing the subtree with this packet as matriarch. 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
 

Detailed Description

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

Member Typedef Documentation

◆ SafePointeeType

The type of object being pointed to.

Constructor & Destructor Documentation

◆ ~NormalHypersurfaces()

regina::NormalHypersurfaces::~NormalHypersurfaces ( )
inlinevirtual

Destroys this list and all the hypersurfaces within.

◆ NormalHypersurfaces()

regina::NormalHypersurfaces::NormalHypersurfaces ( HyperCoords  coords,
HyperList  which,
HyperAlg  algorithm 
)
inlineprotected

Creates an empty list of normal hypersurfaces with the given parameters.

Parameters
coordsthe coordinate system to be used for filling this list.
whichindicates which normal hypersurfaces these will represent within the underlying triangulation.
algorithmdetails of the enumeration algorithm that will be used to fill this list.

Member Function Documentation

◆ algorithm()

HyperAlg regina::NormalHypersurfaces::algorithm ( ) const
inline

Returns details of the algorithm that was used to enumerate this list.

These may not be the same HyperAlg 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.

Returns
details of the algorithm used to enumerate this list.

◆ beginVectors()

NormalHypersurfaces::VectorIterator regina::NormalHypersurfaces::beginVectors ( ) const
inline


An iterator that gives access to the raw vectors for hypersurfaces in this list, pointing to the beginning of this hypersurface list.

Python
Not present.
      @return an iterator at the beginning of this hypersurface list.

◆ coords()

HyperCoords regina::NormalHypersurfaces::coords ( ) const
inline

Returns the coordinate system being used by the hypersurfaces stored in this set.

Returns
the coordinate system used.

◆ dependsOnParent()

bool regina::NormalHypersurfaces::dependsOnParent ( ) const
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.

Returns
true if and only if this packet depends on its parent.

Implements regina::Packet.

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

◆ endVectors()

NormalHypersurfaces::VectorIterator regina::NormalHypersurfaces::endVectors ( ) const
inline


An iterator that gives access to the raw vectors for hypersurfaces in this list, pointing past the end of this hypersurface list.

This iterator is not dereferenceable.

Python
Not present.
      @return an iterator past the end of this hypersurface list.

◆ enumerate()

static NormalHypersurfaces* regina::NormalHypersurfaces::enumerate ( Triangulation< 4 > *  owner,
HyperCoords  coords,
HyperList  which = HS_LIST_DEFAULT,
HyperAlg  algHints = HS_ALG_DEFAULT,
ProgressTracker tracker = nullptr 
)
static

A unified routine for enumerating various classes of normal hypersurfaces within a given triangulation.

The HyperCoords argument allows you to specify an underlying coordinate system.

The HyperList argument is a combination of flags that allows you to specify exactly which normal hypersurfaces you require. This includes (i) whether you want all vertex hypersurfaces or all fundamental hypersurfaces, which defaults to HS_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 HS_EMBEDDED_ONLY if you specify neither or both.

The HyperAlg 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 HS_ALG_DEFAULT (which makes no hints at all) will allow Regina to choose what it thinks will be the most efficient method.

The enumerated hypersurfaces will be stored in a new normal hypersurface list, and their representations will be scaled down to use the smallest possible integer coordinates. This normal hypersurface 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 hypersurface list, and must not change while this normal hypersurface list remains in existence.

If a progress tracker is passed, the normal hypersurface 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 hypersurface list will be created, and the progress tracker (if passed) will be marked as finished. Errors can occur in the following scenarios:

  • Regina could not create the matching equations for the given triangulation in the given coordinate system. This is only possible in certain coordinate systems, and all such coordinate systems are marked as such in the HyperCoords enum documentation.
  • A progress tracker is passed but a new thread could not be started.
Parameters
ownerthe triangulation upon which this list of normal hypersurfaces will be based.
coordsthe coordinate system to be used.
whichindicates which normal hypersurfaces should be enumerated.
algHintspasses requests to Regina for which specific enumeration algorithm should be used.
trackera progress tracker through which progress will be reported, or null if no progress reporting is required.
Returns
the newly created normal hypersurface list. Note that if a progress tracker is passed then this list may not be completely filled when this routine returns. If an error occurs (as described above) then this routine will return null instead.

◆ hasSafePtr()

bool regina::SafePointeeBase< Packet >::hasSafePtr ( ) const
inlineinherited

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

◆ hypersurface()

const NormalHypersurface * regina::NormalHypersurfaces::hypersurface ( size_t  index) const
inline

Returns the hypersurface at the requested index in this list.

Parameters
indexthe index of the requested hypersurface in this list; this must be between 0 and size()-1 inclusive.
Returns
the normal hypersurface at the requested index in this list.

◆ internalClonePacket()

virtual Packet* regina::NormalHypersurfaces::internalClonePacket ( Packet parent) const
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.

Parameters
parentthe parent beneath which the new packet will eventually be inserted.
Returns
the newly allocated packet.

Implements regina::Packet.

◆ isEmbeddedOnly()

bool regina::NormalHypersurfaces::isEmbeddedOnly ( ) const
inline

Returns whether this set is known to contain only embedded normal hypersurfaces.

If this returns false, it does not guarantee that immersed and/or singular hypersurfaces are present; it merely indicates that they were not deliberately excluded (for instance, the prism constraints were not enforced).

Returns
true if this list was constructed to contain only properly embedded hypersurfaces, or false otherwise.

◆ recreateMatchingEquations()

MatrixInt * regina::NormalHypersurfaces::recreateMatchingEquations ( ) const
inline

Returns a newly created matrix containing the matching equations that were used to create this normal hypersurface 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 hypersurface list would not have been created in the first place.

Returns
the matching equations used to create this normal hypersurface list.

◆ size()

size_t regina::NormalHypersurfaces::size ( ) const
inline

Returns the number of hypersurfaces stored in this list.

Returns
the number of hypersurfaces.

◆ sort()

template<typename Comparison >
void regina::NormalHypersurfaces::sort ( Comparison &&  comp)
inline


Sorts the hypersurfaces in this list according to the given criterion.

This sort is stable, i.e., hypersurfaces that are equivalent under the given criterion will remain in the same relative order.

The implementation of this routine uses std::stable_sort.

Python
Not present.
Parameters
compa binary function (or function object) that accepts two const HyperSurface pointers, and returns true if and only if the first hypersurface should appear before the second in the sorted list.

◆ 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
In addition to str(), this is also used as the Python "stringification" function __str__().
Returns
a short text representation of this object.

◆ triangulation()

Triangulation<4>* regina::NormalHypersurfaces::triangulation ( ) const

Returns the triangulation in which these normal hypersurfaces live.

Returns
the triangulation in which these hypersurfaces live.

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

◆ which()

HyperList regina::NormalHypersurfaces::which ( ) const
inline

Returns details of which normal hypersurfaces this list represents within the underlying triangulation.

This may not be the same HyperList that was passed to enumerate(). In particular, default values will have been explicitly filled in (such as HS_VERTEX and/or HS_EMBEDDED_ONLY), and invalid and/or redundant values will have been removed.

Returns
details of what this list represents.

◆ writeTextLong()

virtual void regina::NormalHypersurfaces::writeTextLong ( std::ostream &  out) const
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.

Python
Not present.
Parameters
outthe output stream to which to write.

Reimplemented from regina::Packet.

◆ writeTextShort()

virtual void regina::NormalHypersurfaces::writeTextShort ( std::ostream &  out) const
overridevirtual


Writes a short text representation of this object to the given output stream.

This must be reimplemented by subclasses.

Python
Not present.
Parameters
outthe output stream to which to write.

Implements regina::Packet.

◆ writeXMLPacketData()

virtual void regina::NormalHypersurfaces::writeXMLPacketData ( std::ostream &  out) const
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.

Parameters
outthe output stream to which the XML should be written.

Implements regina::Packet.

Member Data Documentation

◆ algorithm_

HyperAlg regina::NormalHypersurfaces::algorithm_
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).

◆ coords_

HyperCoords regina::NormalHypersurfaces::coords_
protected

Stores which coordinate system is being used by the normal hypersurfaces in this packet.

◆ surfaces_

std::vector<NormalHypersurface*> regina::NormalHypersurfaces::surfaces_
protected

Contains the normal hypersurfaces stored in this packet.

◆ which_

HyperList regina::NormalHypersurfaces::which_
protected

Indicates which normal hypersurfaces these represent within the underlying triangulation.


The documentation for this class was generated from the following file:

Copyright © 1999-2021, 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).