Regina Calculation Engine
Public Member Functions | Static Public Member Functions | List of all members
regina::SnappedBall Class Reference

Represents a snapped 3-ball in a triangulation. More...

#include <subcomplex/snappedball.h>

Inheritance diagram for regina::SnappedBall:
regina::StandardTriangulation regina::Output< StandardTriangulation >

Public Member Functions

SnappedBallclone () const
 Returns a newly created clone of this structure. More...
 
Tetrahedron< 3 > * tetrahedron () const
 Returns the tetrahedron that forms this snapped ball. More...
 
int boundaryFace (int index) const
 Returns one of the two tetrahedron faces that forms the boundary of this snapped ball. More...
 
int internalFace (int index) const
 Returns one of the two tetrahedron faces internal to this snapped ball. More...
 
int equatorEdge () const
 Returns the edge that forms the equator of the boundary sphere of this ball. More...
 
int internalEdge () const
 Returns the edge internal to this snapped ball. More...
 
Manifoldmanifold () const override
 Returns the 3-manifold represented by this triangulation, if such a recognition routine has been implemented. More...
 
AbelianGrouphomology () const override
 Returns the expected first homology group of this triangulation, if such a routine has been implemented. More...
 
std::ostream & writeName (std::ostream &out) const override
 Writes the name of this triangulation as a human-readable string to the given output stream. More...
 
std::ostream & writeTeXName (std::ostream &out) const override
 Writes the name of this triangulation in TeX format to the given output stream. More...
 
void writeTextLong (std::ostream &out) const override
 Writes a detailed text representation of this object to the given output stream. More...
 
std::string name () const
 Returns the name of this specific triangulation as a human-readable string. More...
 
std::string TeXName () const
 Returns the name of this specific triangulation in TeX format. More...
 
AbelianGrouphomologyH1 () const
 Returns the expected first homology group of this triangulation, if such a routine has been implemented. More...
 
virtual void writeTextShort (std::ostream &out) const
 Writes a short 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...
 

Static Public Member Functions

static SnappedBallformsSnappedBall (Tetrahedron< 3 > *tet)
 Determines if the given tetrahedron forms a snapped 3-ball within a triangulation. More...
 
static StandardTriangulationisStandardTriangulation (Component< 3 > *component)
 Determines whether the given component represents one of the standard triangulations understood by Regina. More...
 
static StandardTriangulationisStandardTriangulation (Triangulation< 3 > *tri)
 Determines whether the given triangulation represents one of the standard triangulations understood by Regina. More...
 

Detailed Description

Represents a snapped 3-ball in a triangulation.

A snapped 3-ball is a single tetrahedron with two faces glued to each other to form a 3-ball with a two triangle boundary.

All optional StandardTriangulation routines are implemented for this class.

Member Function Documentation

◆ detail()

std::string regina::Output< StandardTriangulation , 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.

◆ str()

std::string regina::Output< StandardTriangulation , 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< StandardTriangulation , 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).