regina::NStandardTriangulation Class Reference
[Standard Triangulations and Subcomplexes]

Describes a triangulation or subcomplex of a triangulation whose structure is well-understood. More...

#include <nstandardtri.h>

Inheritance diagram for regina::NStandardTriangulation:

regina::ShareableObject regina::boost::noncopyable regina::NAugTriSolidTorus regina::NBlockedSFS regina::NBlockedSFSLoop regina::NBlockedSFSPair regina::NBlockedSFSTriple regina::NL31Pillow regina::NLayeredChain regina::NLayeredChainPair regina::NLayeredLensSpace regina::NLayeredLoop regina::NLayeredSolidTorus regina::NLayeredTorusBundle regina::NPluggedTorusBundle regina::NPlugTriSolidTorus regina::NSnapPeaCensusTri regina::NSnappedBall regina::NSpiralSolidTorus regina::NTriSolidTorus regina::NTrivialTri

List of all members.

Public Member Functions

virtual ~NStandardTriangulation ()
 A destructor that does nothing.
std::string getName () const
 Returns the name of this specific triangulation as a human-readable string.
std::string getTeXName () const
 Returns the name of this specific triangulation in TeX format.
virtual NManifoldgetManifold () const
 Returns the 3-manifold represented by this triangulation, if such a recognition routine has been implemented.
virtual NAbelianGroupgetHomologyH1 () const
 Returns the expected first homology group of this triangulation, if such a routine has been implemented.
virtual std::ostream & writeName (std::ostream &out) const =0
 Writes the name of this triangulation as a human-readable string to the given output stream.
virtual std::ostream & writeTeXName (std::ostream &out) const =0
 Writes the name of this triangulation in TeX format to the given output stream.
virtual void writeTextShort (std::ostream &out) const
 Writes this object in short text format to the given output stream.

Static Public Member Functions

static NStandardTriangulationisStandardTriangulation (NComponent *component)
 Determines whether the given component represents one of the standard triangulations understood by Regina.
static NStandardTriangulationisStandardTriangulation (NTriangulation *tri)
 Determines whether the given triangulation represents one of the standard triangulations understood by Regina.


Detailed Description

Describes a triangulation or subcomplex of a triangulation whose structure is well-understood.

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 do not need to override writeTextShort() since this routine is properly implemented in the base class NStandardTriangulation.


Constructor & Destructor Documentation

regina::NStandardTriangulation::~NStandardTriangulation (  )  [inline, virtual]

A destructor that does nothing.


Member Function Documentation

std::string regina::NStandardTriangulation::getName (  )  const

Returns the name of this specific triangulation as a human-readable string.

Returns:
the name of this triangulation.

std::string regina::NStandardTriangulation::getTeXName (  )  const

Returns the name of this specific triangulation in TeX format.

No leading or trailing dollar signs will be included.

Warning:
The behaviour of this routine has changed as of Regina 4.3; in earlier versions, leading and trailing dollar signs were provided.
Returns:
the name of this triangulation in TeX format.

NManifold * regina::NStandardTriangulation::getManifold (  )  const [inline, virtual]

Returns the 3-manifold represented by this triangulation, if such a recognition routine has been implemented.

If the 3-manifold cannot be recognised then this routine will return 0.

The details of which standard triangulations have 3-manifold 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 3-manifolds can be recognised will grow between releases.

The 3-manifold will be newly allocated and must be destroyed by the caller of this routine.

Returns:
the underlying 3-manifold.

Reimplemented in regina::NAugTriSolidTorus, regina::NBlockedSFS, regina::NBlockedSFSLoop, regina::NBlockedSFSPair, regina::NBlockedSFSTriple, regina::NL31Pillow, regina::NLayeredChain, regina::NLayeredChainPair, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NLayeredSolidTorus, regina::NLayeredTorusBundle, regina::NPluggedTorusBundle, regina::NPlugTriSolidTorus, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NSpiralSolidTorus, regina::NTriSolidTorus, and regina::NTrivialTri.

NAbelianGroup * regina::NStandardTriangulation::getHomologyH1 (  )  const [inline, virtual]

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::getHomologyH1() 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::getHomologyH1() upon the associated real triangulation.

Returns:
the first homology group of this triangulation, or 0 if the appropriate calculation routine has not yet been implemented.

Reimplemented in regina::NL31Pillow, regina::NLayeredChain, regina::NLayeredChainPair, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NLayeredSolidTorus, regina::NLayeredTorusBundle, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NSpiralSolidTorus, regina::NTriSolidTorus, and regina::NTrivialTri.

virtual std::ostream& regina::NStandardTriangulation::writeName ( std::ostream &  out  )  const [pure virtual]

Writes the name of this triangulation as a human-readable string to the given output stream.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.
Returns:
a reference to the given output stream.

Implemented in regina::NAugTriSolidTorus, regina::NBlockedSFS, regina::NBlockedSFSLoop, regina::NBlockedSFSPair, regina::NBlockedSFSTriple, regina::NL31Pillow, regina::NLayeredChain, regina::NLayeredChainPair, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NLayeredSolidTorus, regina::NLayeredTorusBundle, regina::NPluggedTorusBundle, regina::NPlugTriSolidTorus, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NSpiralSolidTorus, regina::NTriSolidTorus, and regina::NTrivialTri.

virtual std::ostream& regina::NStandardTriangulation::writeTeXName ( std::ostream &  out  )  const [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.

Warning:
The behaviour of this routine has changed as of Regina 4.3; in earlier versions, leading and trailing dollar signs were provided.
Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.
Returns:
a reference to the given output stream.

Implemented in regina::NAugTriSolidTorus, regina::NBlockedSFS, regina::NBlockedSFSLoop, regina::NBlockedSFSPair, regina::NBlockedSFSTriple, regina::NL31Pillow, regina::NLayeredChain, regina::NLayeredChainPair, regina::NLayeredLensSpace, regina::NLayeredLoop, regina::NLayeredSolidTorus, regina::NLayeredTorusBundle, regina::NPluggedTorusBundle, regina::NPlugTriSolidTorus, regina::NSnapPeaCensusTri, regina::NSnappedBall, regina::NSpiralSolidTorus, regina::NTriSolidTorus, and regina::NTrivialTri.

void regina::NStandardTriangulation::writeTextShort ( std::ostream &  out  )  const [inline, virtual]

Writes this object in short text format to the given output stream.

The output should fit on a single line and no newline should be written.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.

Implements regina::ShareableObject.

static NStandardTriangulation* regina::NStandardTriangulation::isStandardTriangulation ( NComponent component  )  [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 faces then the given component must have the same corresponding boundary faces, i.e., the component cannot have any further identifications of these boundary faces with each other.

Note that the triangulation-based routine isStandardTriangulation(NTriangulation*) may recognise more triangulations than this routine, since passing an entire triangulation allows access to more information.

Parameters:
component the triangulation component under examination.
Returns:
the details of the standard triangulation if the given component is recognised, or 0 otherwise.

static NStandardTriangulation* regina::NStandardTriangulation::isStandardTriangulation ( NTriangulation tri  )  [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 faces then the given triangulation must have the same corresponding boundary faces, i.e., the triangulation cannot have any further identifications of these boundary faces with each other.

This routine may recognise more triangulations than the component-based isStandardTriangulation(NComponent*), since passing an entire triangulation allows access to more information.

Parameters:
tri the triangulation under examination.
Returns:
the details of the standard triangualation if the given triangulation is recognised, or 0 otherwise.


The documentation for this class was generated from the following file:
Copyright © 1999-2007, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).