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

This class offers routines for constructing sample 2-manifold triangulations of various types. More...

#include <dim2/dim2exampletriangulation.h>

Static Public Member Functions

static Dim2Triangulationorientable (unsigned genus, unsigned punctures)
 Returns a triangulation of the given orientable surface. More...
 
static Dim2TriangulationnonOrientable (unsigned genus, unsigned punctures)
 Returns a triangulation of the given non-orientable surface. More...
 
static Dim2Triangulationsphere ()
 Returns a two-triangle 2-sphere. More...
 
static Dim2TriangulationsphereTetrahedron ()
 Returns the four-triangle 2-sphere formed from the boundary of a tetrahedron. More...
 
static Dim2TriangulationsphereOctahedron ()
 Returns the eight-triangle 2-sphere formed from the boundary of an octahedron. More...
 
static Dim2Triangulationdisc ()
 Returns a one-triangle disc. More...
 
static Dim2Triangulationannulus ()
 Returns a two-triangle annulus. More...
 
static Dim2Triangulationmobius ()
 Returns a one-triangle Mobius band. More...
 
static Dim2Triangulationtorus ()
 Returns a two-triangle torus. More...
 
static Dim2Triangulationrp2 ()
 Returns a two-triangle projective plane. More...
 
static Dim2Triangulationkb ()
 Returns a two-triangle Klein bottle. More...
 

Detailed Description

This class offers routines for constructing sample 2-manifold triangulations of various types.

These triangulations may be useful for testing new code, or for simply getting a feel for how Regina works.

The sample triangulations offered here may prove especially useful in Regina's scripting interface, where working with pre-existing files is more complicated than in the GUI.

All of the methods in this class will assign an appropriate packet label to the triangulation that they return.

Note that each of these routines constructs a new triangulation from scratch. It is up to the caller of each routine to destroy the triangulation that is returned.

Member Function Documentation

§ annulus()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::annulus ( )
static

Returns a two-triangle annulus.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ disc()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::disc ( )
static

Returns a one-triangle disc.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ kb()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::kb ( )
static

Returns a two-triangle Klein bottle.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ mobius()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::mobius ( )
static

Returns a one-triangle Mobius band.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ nonOrientable()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::nonOrientable ( unsigned  genus,
unsigned  punctures 
)
static

Returns a triangulation of the given non-orientable surface.

Parameters
genusthe non-orientable genus of the surface, i.e., the number of crosscaps that it contains; this must be greater than or equal to one.
puncturesthe number of punctures in the surface; this must be greater than or equal to zero.
Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ orientable()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::orientable ( unsigned  genus,
unsigned  punctures 
)
static

Returns a triangulation of the given orientable surface.

Parameters
genusthe genus of the surface; this must be greater than or equal to zero.
puncturesthe number of punctures in the surface; this must be greater than or equal to zero.
Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ rp2()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::rp2 ( )
static

Returns a two-triangle projective plane.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ sphere()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::sphere ( )
static

Returns a two-triangle 2-sphere.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ sphereOctahedron()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::sphereOctahedron ( )
static

Returns the eight-triangle 2-sphere formed from the boundary of an octahedron.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ sphereTetrahedron()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::sphereTetrahedron ( )
static

Returns the four-triangle 2-sphere formed from the boundary of a tetrahedron.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

§ torus()

static Dim2Triangulation* regina::Dim2ExampleTriangulation::torus ( )
static

Returns a two-triangle torus.

Returns
a newly constructed triangulation, which must be destroyed by the caller of this routine.

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).