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

Represents a 2-sphere made from two triangles glued together along their three edges. More...

#include <subcomplex/npillowtwosphere.h>

Inheritance diagram for regina::NPillowTwoSphere:
regina::ShortOutput< NPillowTwoSphere > regina::Output< NPillowTwoSphere, false >

Public Member Functions

NPillowTwoSphereclone () const
 Returns a newly created clone of this structure. More...
 
NTriangletriangle (int index) const
 Returns one of the two triangles whose boundaries are joined. More...
 
REGINA_DEPRECATED NTrianglegetTriangle (int index) const
 Deprecated routine that returns one of the two triangles whose boundaries are joined. More...
 
REGINA_DEPRECATED NTrianglegetFace (int index) const
 A deprecated alias for triangle(). More...
 
NPerm4 triangleMapping () const
 Returns a permutation describing how the boundaries of the two triangles are joined. More...
 
REGINA_DEPRECATED NPerm4 getTriangleMapping () const
 Deprecated routine that returns a permutation describing how the boundaries of the two triangles are joined. More...
 
REGINA_DEPRECATED NPerm4 getFaceMapping () const
 A deprecated alias for triangleMapping(). More...
 
void writeTextShort (std::ostream &out) const
 Writes a short text representation of this object to the given output stream. More...
 
void writeTextLong (std::ostream &out) const
 A default implementation for detailed output. 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 NPillowTwoSphereformsPillowTwoSphere (NTriangle *tri1, NTriangle *tri2)
 Determines if the two given triangles together form a pillow 2-sphere. More...
 

Detailed Description

Represents a 2-sphere made from two triangles glued together along their three edges.

The two triangles must be distinct and the three edges of each triangle must also be distinct. Neither of the triangles may be boundary triangles. These two triangless together form an embedded 2-sphere in the triangulation (with the exception that two or three points of the sphere corresponding to the triangles vertices may be identified).

This 2-sphere can be cut along and the two resulting 2-sphere boundaries filled in with 3-balls, and the resulting triangulation has the same number of tetrahedra as the original. If the original 2-sphere was separating, the resulting triangulation will contain the two terms of the corresponding connected sum.

Member Function Documentation

§ clone()

NPillowTwoSphere* regina::NPillowTwoSphere::clone ( ) const

Returns a newly created clone of this structure.

Returns
a newly created clone.

§ detail()

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

§ formsPillowTwoSphere()

static NPillowTwoSphere* regina::NPillowTwoSphere::formsPillowTwoSphere ( NTriangle tri1,
NTriangle tri2 
)
static

Determines if the two given triangles together form a pillow 2-sphere.

Precondition
The two given triangles are distinct.
Parameters
tri1the first triangle to examine.
tri2the second triangle to examine.
Returns
a newly created structure containing details of the pillow 2-sphere, or null if the given triangles do not form a pillow 2-sphere.

§ getFace()

NTriangle * regina::NPillowTwoSphere::getFace ( int  index) const
inline

A deprecated alias for triangle().

This routine returns one of the two triangles whose boundaries are joined. See triangle() for further details.

Deprecated:
This routine will be removed in a future version of Regina. Please use triangle() instead.
Parameters
indexspecifies which of the two triangles to return; this must be either 0 or 1.
Returns
the corresponding triangle.

§ getFaceMapping()

NPerm4 regina::NPillowTwoSphere::getFaceMapping ( ) const
inline

A deprecated alias for triangleMapping().

This routine returns a permutation describing how the boundaries of the two triangles are joined. See triangleMapping() for further details.

Deprecated:
This routine will be removed in a future version of Regina. Please use triangleMapping() instead.
Returns
a permutation describing how the triangle boundaries are joined.

§ getTriangle()

NTriangle * regina::NPillowTwoSphere::getTriangle ( int  index) const
inline

Deprecated routine that returns one of the two triangles whose boundaries are joined.

Deprecated:
This routine has been renamed to triangle(). See the triangle() documentation for further details.

§ getTriangleMapping()

NPerm4 regina::NPillowTwoSphere::getTriangleMapping ( ) const
inline

Deprecated routine that returns a permutation describing how the boundaries of the two triangles are joined.

Deprecated:
This routine has been renamed to triangleMapping(). See the triangleMapping() documentation for further details.

§ str()

std::string regina::Output< NPillowTwoSphere , supportsUtf8 >::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:
In addition to str(), this is also used as the Python "stringification" function __str__().
Returns
a short text representation of this object.

§ toString()

REGINA_DEPRECATED std::string regina::Output< NPillowTwoSphere , supportsUtf8 >::toString ( ) const
inherited

A deprecated alias for str().

Deprecated:
This routine has (at long last) been deprecated; use the simpler-to-type str() instead.
Returns
a short text representation of this object.

§ toStringLong()

REGINA_DEPRECATED std::string regina::Output< NPillowTwoSphere , supportsUtf8 >::toStringLong ( ) const
inherited

A deprecated alias for detail().

Deprecated:
This routine has (at long last) been deprecated; use the simpler-to-type detail() instead.
Returns
a long text representation of this object.

§ triangle()

NTriangle * regina::NPillowTwoSphere::triangle ( int  index) const
inline

Returns one of the two triangles whose boundaries are joined.

Parameters
indexspecifies which of the two triangles to return; this must be either 0 or 1.
Returns
the corresponding triangle.

§ triangleMapping()

NPerm4 regina::NPillowTwoSphere::triangleMapping ( ) const
inline

Returns a permutation describing how the boundaries of the two triangles are joined.

The permutation will map vertices (0,1,2) of triangle(0) to vertices (0,1,2) of triangle(1). The map will represent how the vertices of the triangles are identified by the three edge gluings.

Returns
a permutation describing how the triangle boundaries are joined.

§ utf8()

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

§ writeTextLong()

void regina::ShortOutput< NPillowTwoSphere , false >::writeTextLong ( std::ostream &  out) const
inlineinherited

A default implementation for detailed output.

This routine simply calls T::writeTextShort() and appends a final newline.

Python:
Not present.
Parameters
outthe output stream to which to write.

§ writeTextShort()

void regina::NPillowTwoSphere::writeTextShort ( std::ostream &  out) const
inline

Writes a short text representation of this object to the given output stream.

Python:
Not present.
Parameters
outthe output stream to which to write.

The documentation for this class was generated from the following file:

Copyright © 1999-2016, 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).