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

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

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

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.

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