Regina Calculation Engine

Describes a triangulation or subcomplex of a triangulation whose structure is wellunderstood. More...
#include <subcomplex/nstandardtri.h>
Public Member Functions  
virtual  ~NStandardTriangulation () 
A destructor that does nothing. More...  
std::string  name () const 
Returns the name of this specific triangulation as a humanreadable string. More...  
REGINA_DEPRECATED std::string  getName () const 
Deprecated routine that returns the name of this specific triangulation as a humanreadable string. More...  
std::string  TeXName () const 
Returns the name of this specific triangulation in TeX format. More...  
REGINA_DEPRECATED std::string  getTeXName () const 
Deprecated routine that returns the name of this specific triangulation in TeX format. More...  
virtual NManifold *  manifold () const 
Returns the 3manifold represented by this triangulation, if such a recognition routine has been implemented. More...  
REGINA_DEPRECATED NManifold *  getManifold () const 
Deprecated routine that returns the 3manifold represented by this triangulation,. More...  
virtual NAbelianGroup *  homology () const 
Returns the expected first homology group of this triangulation, if such a routine has been implemented. More...  
NAbelianGroup *  homologyH1 () const 
Returns the expected first homology group of this triangulation, if such a routine has been implemented. More...  
REGINA_DEPRECATED NAbelianGroup *  getHomologyH1 () const 
Deprecated routine that returns the expected first homology group of this triangulation, if such a routine has been implemented. More...  
virtual std::ostream &  writeName (std::ostream &out) const =0 
Writes the name of this triangulation as a humanreadable string to the given output stream. More...  
virtual std::ostream &  writeTeXName (std::ostream &out) const =0 
Writes the name of this triangulation in TeX format to the given output stream. 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...  
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...  
REGINA_DEPRECATED std::string  toString () const 
A deprecated alias for str(). More...  
REGINA_DEPRECATED std::string  toStringLong () const 
A deprecated alias for detail(). More...  
Static Public Member Functions  
static NStandardTriangulation *  isStandardTriangulation (NComponent *component) 
Determines whether the given component represents one of the standard triangulations understood by Regina. More...  
static NStandardTriangulation *  isStandardTriangulation (NTriangulation *tri) 
Determines whether the given triangulation represents one of the standard triangulations understood by Regina. More...  
Describes a triangulation or subcomplex of a triangulation whose structure is wellunderstood.
An NStandardTriangulation is generally connected with a real triangulation, i.e., an NTriangulation object, which it describes some portion of.
In general NStandardTriangulation objects cannot be constructed directly, but are instead created through static identification routines such as NStandardTriangulation::isStandardTriangulation(NTriangulation*).
Subclasses corresponding to different families of triangulations may, but not need to, override the output routines writeTextShort() and writeTextLong(). This class offers sensible default implementations of both routines, which call the pure virtual function writeName() (which every subclass must override).

inlinevirtual 
A destructor that does nothing.

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 humanreadable, 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 
Deprecated routine that returns the expected first homology group of this triangulation, if such a routine has been implemented.

inline 
Deprecated routine that returns the 3manifold represented by this triangulation,.

inline 
Deprecated routine that returns the name of this specific triangulation as a humanreadable string.

inline 
Deprecated routine that returns the name of this specific triangulation in TeX format.

inlinevirtual 
Returns the expected first homology group of this triangulation, if such a routine has been implemented.
If the calculation of homology has not yet been implemented for this triangulation then this routine will return 0.
This routine does not work by calling NTriangulation::homology() on the associated real triangulation. Instead the homology is calculated directly from the known properties of this standard triangulation.
The details of which standard triangulations have homology calculation routines can be found in the notes for the corresponding subclasses of NStandardTriangulation. The default implementation of this routine returns 0.
The homology group will be newly allocated and must be destroyed by the caller of this routine.
If this NStandardTriangulation describes an entire NTriangulation (and not just a part thereof) then the results of this routine should be identical to the homology group obtained by calling NTriangulation::homology() upon the associated real triangulation.
This routine can also be accessed via the alias homologyH1() (a name that is more specific, but a little longer to type).
Reimplemented in regina::NLayeredSolidTorus, regina::NLayeredChain, regina::NTriSolidTorus, regina::NSpiralSolidTorus, regina::NLayeredTorusBundle, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NL31Pillow, regina::NTrivialTri, and regina::NLayeredChainPair.

inline 
Returns the expected first homology group of this triangulation, if such a routine has been implemented.
If the calculation of homology has not yet been implemented for this triangulation then this routine will return 0.
This routine does not work by calling NTriangulation::homology() on the associated real triangulation. Instead the homology is calculated directly from the known properties of this standard triangulation.
The details of which standard triangulations have homology calculation routines can be found in the notes for the corresponding subclasses of NStandardTriangulation. The default implementation of this routine returns 0.
The homology group will be newly allocated and must be destroyed by the caller of this routine.
If this NStandardTriangulation describes an entire NTriangulation (and not just a part thereof) then the results of this routine should be identical to the homology group obtained by calling NTriangulation::homology() upon the associated real triangulation.
This routine can also be accessed via the alias homology() (a name that is less specific, but a little easier to type).

static 
Determines whether the given component represents one of the standard triangulations understood by Regina.
The list of recognised triangulations is expected to grow between releases.
If the standard triangulation returned has boundary triangles then the given component must have the same corresponding boundary triangles, i.e., the component cannot have any further identifications of these boundary triangles with each other.
Note that the triangulationbased routine isStandardTriangulation(NTriangulation*) may recognise more triangulations than this routine, since passing an entire triangulation allows access to more information.
component  the triangulation component under examination. 

static 
Determines whether the given triangulation represents one of the standard triangulations understood by Regina.
The list of recognised triangulations is expected to grow between releases.
If the standard triangulation returned has boundary triangles then the given triangulation must have the same corresponding boundary triangles, i.e., the triangulation cannot have any further identifications of these boundary triangles with each other.
This routine may recognise more triangulations than the componentbased isStandardTriangulation(NComponent*), since passing an entire triangulation allows access to more information.
tri  the triangulation under examination. 

inlinevirtual 
Returns the 3manifold represented by this triangulation, if such a recognition routine has been implemented.
If the 3manifold cannot be recognised then this routine will return 0.
The details of which standard triangulations have 3manifold recognition routines can be found in the notes for the corresponding subclasses of NStandardTriangulation. The default implementation of this routine returns 0.
It is expected that the number of triangulations whose underlying 3manifolds can be recognised will grow between releases.
The 3manifold will be newly allocated and must be destroyed by the caller of this routine.
Reimplemented in regina::NLayeredSolidTorus, regina::NAugTriSolidTorus, regina::NLayeredChain, regina::NTriSolidTorus, regina::NSpiralSolidTorus, regina::NPlugTriSolidTorus, regina::NLayeredTorusBundle, regina::NBlockedSFSTriple, regina::NPluggedTorusBundle, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NBlockedSFSLoop, regina::NL31Pillow, regina::NBlockedSFSPair, regina::NTrivialTri, regina::NLayeredChainPair, and regina::NBlockedSFS.
std::string regina::NStandardTriangulation::name  (  )  const 
Returns the name of this specific triangulation as a humanreadable string.

inherited 
Returns a short text representation of this object.
This text should be humanreadable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.
__str__()
.std::string regina::NStandardTriangulation::TeXName  (  )  const 
Returns the name of this specific triangulation in TeX format.
No leading or trailing dollar signs will be included.

inherited 
A deprecated alias for str().

inherited 
A deprecated alias for detail().

inherited 
Returns a short text representation of this object using unicode characters.
Like str(), this text should be humanreadable, 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 UTF8.

pure virtual 
Writes the name of this triangulation as a humanreadable string to the given output stream.
out  the output stream to which to write. 
Implemented in regina::NLayeredSolidTorus, regina::NAugTriSolidTorus, regina::NLayeredChain, regina::NTriSolidTorus, regina::NSpiralSolidTorus, regina::NPlugTriSolidTorus, regina::NLayeredTorusBundle, regina::NBlockedSFSTriple, regina::NPluggedTorusBundle, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NL31Pillow, regina::NBlockedSFSLoop, regina::NBlockedSFSPair, regina::NTrivialTri, regina::NLayeredChainPair, and regina::NBlockedSFS.

pure virtual 
Writes the name of this triangulation in TeX format to the given output stream.
No leading or trailing dollar signs will be included.
out  the output stream to which to write. 
Implemented in regina::NLayeredSolidTorus, regina::NAugTriSolidTorus, regina::NLayeredChain, regina::NTriSolidTorus, regina::NSpiralSolidTorus, regina::NPlugTriSolidTorus, regina::NLayeredTorusBundle, regina::NBlockedSFSTriple, regina::NPluggedTorusBundle, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NL31Pillow, regina::NBlockedSFSLoop, regina::NBlockedSFSPair, regina::NTrivialTri, regina::NLayeredChainPair, and regina::NBlockedSFS.

inlinevirtual 
Writes a detailed text representation of this object to the given output stream.
This may be reimplemented by subclasses, but the parent NStandardTriangulation class offers a reasonable default implementation based on writeName().
out  the output stream to which to write. 
Reimplemented in regina::NLayeredSolidTorus, regina::NAugTriSolidTorus, regina::NLayeredChain, regina::NTriSolidTorus, regina::NSpiralSolidTorus, regina::NPlugTriSolidTorus, regina::NLayeredTorusBundle, regina::NBlockedSFSTriple, regina::NPluggedTorusBundle, regina::NSnappedBall, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NL31Pillow, regina::NBlockedSFSLoop, regina::NBlockedSFSPair, regina::NTrivialTri, regina::NLayeredChainPair, and regina::NBlockedSFS.

inlinevirtual 
Writes a short text representation of this object to the given output stream.
This may be reimplemented by subclasses, but the parent NStandardTriangulation class offers a reasonable default implementation based on writeName().
out  the output stream to which to write. 