Regina Calculation Engine
|
Represents a snapped 3-ball in a triangulation. More...
#include <subcomplex/nsnappedball.h>
Public Member Functions | |
NSnappedBall * | clone () const |
Returns a newly created clone of this structure. More... | |
NTetrahedron * | getTetrahedron () const |
Returns the tetrahedron that forms this snapped ball. More... | |
int | getBoundaryFace (int index) const |
Returns one of the two tetrahedron faces that forms the boundary of this snapped ball. More... | |
int | getInternalFace (int index) const |
Returns one of the two tetrahedron faces internal to this snapped ball. More... | |
int | getEquatorEdge () const |
Returns the edge that forms the equator of the boundary sphere of this ball. More... | |
int | getInternalEdge () const |
Returns the edge internal to this snapped ball. More... | |
NManifold * | getManifold () const |
Returns the 3-manifold represented by this triangulation, if such a recognition routine has been implemented. More... | |
NAbelianGroup * | getHomologyH1 () const |
Returns the expected first homology group of this triangulation, if such a routine has been implemented. More... | |
std::ostream & | writeName (std::ostream &out) const |
Writes the name of this triangulation as a human-readable string to the given output stream. More... | |
std::ostream & | writeTeXName (std::ostream &out) const |
Writes the name of this triangulation in TeX format to the given output stream. More... | |
void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. More... | |
std::string | getName () const |
Returns the name of this specific triangulation as a human-readable string. More... | |
std::string | getTeXName () const |
Returns the name of this specific triangulation in TeX format. More... | |
virtual void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. More... | |
Input and Output | |
std::string | str () const |
Returns the output from writeTextShort() as a string. More... | |
std::string | toString () const |
A deprecated alias for str(), which returns the output from writeTextShort() as a string. More... | |
std::string | detail () const |
Returns the output from writeTextLong() as a string. More... | |
std::string | toStringLong () const |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More... | |
Static Public Member Functions | |
static NSnappedBall * | formsSnappedBall (NTetrahedron *tet) |
Determines if the given tetrahedron forms a snapped 3-ball within a triangulation. More... | |
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... | |
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 NStandardTriangulation routines are implemented for this class.
NSnappedBall* regina::NSnappedBall::clone | ( | ) | const |
Returns a newly created clone of this structure.
|
inherited |
Returns the output from writeTextLong() as a string.
|
static |
Determines if the given tetrahedron forms a snapped 3-ball within a triangulation.
The ball need not be the entire triangulation; the boundary triangles may be glued to something else (or to each other).
Note that the two boundary triangles of the snapped 3-ball need not be boundary triangles within the overall triangulation, i.e., they may be identified with each other or with triangles of other tetrahedra.
tet | the tetrahedron to examine as a potential 3-ball. |
null
if the given tetrahedron is not a snapped 3-ball.
|
inline |
Returns one of the two tetrahedron faces that forms the boundary of this snapped ball.
You are guaranteed that index 0 will return a smaller face number than index 1.
index | specifies which of the two boundary faces to return; this must be either 0 or 1. |
|
inline |
Returns the edge that forms the equator of the boundary sphere of this ball.
|
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.
Reimplemented from regina::NStandardTriangulation.
|
inline |
Returns the edge internal to this snapped ball.
|
inline |
Returns one of the two tetrahedron faces internal to this snapped ball.
You are guaranteed that index 0 will return a smaller face number than index 1.
index | specifies which of the two internal faces to return; this must be either 0 or 1. |
|
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.
Reimplemented from regina::NStandardTriangulation.
|
inherited |
Returns the name of this specific triangulation as a human-readable string.
|
inline |
Returns the tetrahedron that forms this snapped ball.
|
inherited |
Returns the name of this specific triangulation in TeX format.
No leading or trailing dollar signs will be included.
|
staticinherited |
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 triangulation-based 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. |
|
staticinherited |
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 component-based isStandardTriangulation(NComponent*), since passing an entire triangulation allows access to more information.
tri | the triangulation under examination. |
|
inherited |
Returns the output from writeTextShort() as a string.
__str__()
function.
|
inlineinherited |
A deprecated alias for str(), which returns the output from writeTextShort() as a string.
|
inlineinherited |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string.
|
inlinevirtual |
Writes the name of this triangulation as a human-readable string to the given output stream.
out | the output stream to which to write. |
Implements regina::NStandardTriangulation.
|
inlinevirtual |
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. |
Implements regina::NStandardTriangulation.
|
inlinevirtual |
Writes this object in long text format to the given output stream.
The output should provide the user with all the information they could want. The output should be human-readable, should not contain extremely long lines (so users can read the output in a terminal), and should end with a final newline.
The default implementation of this routine merely calls writeTextShort() and adds a newline.
out | the output stream to which to write. |
Reimplemented from regina::ShareableObject.
|
inlinevirtualinherited |
Writes this object in short text format to the given output stream.
The output should be human-readable, should fit on a single line, and should not end with a newline.
out | the output stream to which to write. |
Implements regina::ShareableObject.