Regina Calculation Engine
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
regina::NTxICore Class Referenceabstract

Provides a triangulation of the product T x I (the product of the torus and the interval). More...

#include <subcomplex/ntxicore.h>

Inheritance diagram for regina::NTxICore:
regina::Output< NTxICore > regina::NTxIDiagonalCore regina::NTxIParallelCore

Public Member Functions

virtual ~NTxICore ()
 Destroys this object. More...
 
const NTriangulationcore () const
 Returns a full copy of the T x I triangulation that this object describes. More...
 
unsigned bdryTet (unsigned whichBdry, unsigned whichTri) const
 Determines which tetrahedron provides the requested boundary triangle. More...
 
NPerm4 bdryRoles (unsigned whichBdry, unsigned whichTri) const
 Describes which tetrahedron vertices play which roles in the upper and lower boundary triangles. More...
 
const NMatrix2bdryReln (unsigned whichBdry) const
 Returns a 2-by-2 matrix describing the alpha and beta curves on a torus boundary in terms of specific tetrahedron edges. More...
 
const NMatrix2parallelReln () const
 Returns a 2-by-2 matrix describing the parallel relationship between the upper and lower boundary curves. More...
 
std::string name () const
 Returns the name of this specific triangulation of T x I as a human-readable string. More...
 
REGINA_DEPRECATED std::string getName () const
 Deprecated routine that returns the name of this specific triangulation of T x I as a human-readable string. More...
 
std::string TeXName () const
 Returns the name of this specific triangulation of T x I in TeX format. More...
 
REGINA_DEPRECATED std::string getTeXName () const
 Deprecated routine that returns the name of this specific triangulation of T x I in TeX format. More...
 
virtual std::ostream & writeName (std::ostream &out) const =0
 Writes the name of this specific triangulation of T x I to the given output stream. More...
 
virtual std::ostream & writeTeXName (std::ostream &out) const =0
 Writes the name of this specific triangulation of T x I in TeX format to the given output stream. 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
 Writes a detailed 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...
 
REGINA_DEPRECATED std::string toString () const
 A deprecated alias for str(). More...
 
REGINA_DEPRECATED std::string toStringLong () const
 A deprecated alias for detail(). More...
 

Protected Member Functions

 NTxICore ()
 Default constructor that performs no initialisation. More...
 

Protected Attributes

NTriangulation core_
 A full copy of the T x I triangulation that is described. More...
 
unsigned bdryTet_ [2][2]
 The tetrahedra that provide the upper and lower boundary triangles. More...
 
NPerm4 bdryRoles_ [2][2]
 Describes which tetrahedron vertices play which roles in the upper and lower boundary triangles. More...
 
NMatrix2 bdryReln_ [2]
 Expresses the alpha and beta curves for each torus boundary in terms of specific tetrahedron edges and vertices. More...
 
NMatrix2 parallelReln_
 Expresses the lower alpha and beta curves in terms of the upper alpha and beta curves. More...
 

Detailed Description

Provides a triangulation of the product T x I (the product of the torus and the interval).

Generally these triangulations are only one tetrahedron thick (i.e., a "thin I-bundle"), though this is not a strict requirement of this class. Triangulations of this type are generally used as components of larger triangulations (such as layered surface bundles).

This product has two torus boundaries, called the upper and lower boundaries. Each of these boundary tori must be formed from precisely two triangles. This class tracks the mappings between parallel curves on the upper and lower boundaries, as well as mappings from boundary curves to specific tetrahedron edges.

For each of the two torus boundaries, two curves are chosen as generators of the fundamental group; these curves are called alpha and beta. Note that there is no requirement that the upper alpha and beta be parallel to the lower alpha and beta. The parallelReln() routine can be called to establish the precise relationship between these upper and lower curves.

Every object of this class contains a full copy of the triangulation that it describes (so you should not create excessive objects of this class without reason). This triangulation can be accessed through the core() routine.

Constructor & Destructor Documentation

regina::NTxICore::~NTxICore ( )
inlinevirtual

Destroys this object.

regina::NTxICore::NTxICore ( )
inlineprotected

Default constructor that performs no initialisation.

Member Function Documentation

const NMatrix2 & regina::NTxICore::bdryReln ( unsigned  whichBdry) const
inline

Returns a 2-by-2 matrix describing the alpha and beta curves on a torus boundary in terms of specific tetrahedron edges.

Consider the first triangle of the given boundary. Let t be the tetrahedron returned by bdryTet(whichBdry, 0) and let p be the permutation returned by bdryRoles(whichBdry, 0).

Let edge01 be the directed edge from vertex p[0] to p[1] of tetrahedron t, and let edge02 be the directed edge from vertex p[0] to p[2] of tetrahedron t. Then the matrix returned by this routine describes how the directed edges edge01 and edge02 relate to the alpha and beta curves on the given boundary. Specifically:

    [ alpha ]                  [ edge01 ]
    [       ]  =  bdryReln() * [        ] .
    [ beta  ]                  [ edge02 ]

It is guaranteed that this matrix has determinant +1 or -1.

Parameters
whichBdry0 if the upper boundary should be examined, or 1 if the lower boundary should be examined.
Returns
the relationship between the boundary curves and tetrahedron edges.
NPerm4 regina::NTxICore::bdryRoles ( unsigned  whichBdry,
unsigned  whichTri 
) const
inline

Describes which tetrahedron vertices play which roles in the upper and lower boundary triangles.

Each boundary torus contains two triangles, whose vertices can be numbered 0, 1 and 2 according to the following diagram. This diagram is completely symmetric, in that edges 1-2 are no more special than edges 0-2 or 0-1. The important observations are that edges 1-2 and 2-1 of each triangle are identified, edges 0-2 and 2-0 of each triangle are identified and edges 0-1 and 1-0 of each triangle are identified.

          *--->>--*
          |0  2 / |
  First   |    / 1|  Second
 triangle v   /   v triangle
          |1 /    |
          | / 2  0|
          *--->>--*

This routine returns a permutation that maps these integers 0,1,2 to real tetrahedron vertices. Let t be the tetrahedron returned by bdryTet(whichBdry, whichTri) and let p be the permutation returned by bdryRoles(whichBdry, whichTri). Then vertices p[0], p[1] and p[2] of tetrahedron t correspond to the markings 0, 1 and 2 respectively in the diagram above (and therefore the boundary triangle is face p[3] of the tetrahedron).

The arguments to this routine affect whether we examine the upper or lower boundary and whether we examine the first or second triangle of this boundary

Parameters
whichBdry0 if the upper boundary should be examined, or 1 if the lower boundary should be examined.
whichTri0 if the first boundary triangle should be examined, or 1 if the second boundary triangle should be examined.
Returns
the permutation mapping roles 0, 1 and 2 in the diagram above to real tetrahedron vertex numbers.
unsigned regina::NTxICore::bdryTet ( unsigned  whichBdry,
unsigned  whichTri 
) const
inline

Determines which tetrahedron provides the requested boundary triangle.

Recall that the T x I triangulation has two torus boundaries, each consisting of two boundary triangles. This routine returns the specific tetrahedron that provides the given triangle of the given torus boundary.

What is returned is the index number of the tetrahedron within the triangulation. To access the tetrahedron itself, you may call core().tetrahedron(bdryTet(...)).

Note that the same tetrahedron may provide more than one boundary triangle.

Parameters
whichBdry0 if the upper boundary should be examined, or 1 if the lower boundary should be examined.
whichTri0 if the first boundary triangle should be examined, or 1 if the second boundary triangle should be examined.
const NTriangulation & regina::NTxICore::core ( ) const
inline

Returns a full copy of the T x I triangulation that this object describes.

Successive calls to this routine will returns the same triangulation (i.e., it is not recreated each time). The triangulation that is returned may not be modified or destroyed.

Returns
the full triangulation.
std::string regina::Output< NTxICore , 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.
std::string regina::NTxICore::getName ( ) const
inline

Deprecated routine that returns the name of this specific triangulation of T x I as a human-readable string.

Deprecated:
This routine has been renamed to name(). See the name() documentation for further details.
std::string regina::NTxICore::getTeXName ( ) const
inline

Deprecated routine that returns the name of this specific triangulation of T x I in TeX format.

Deprecated:
This routine has been renamed to TeXName(). See the TeXName() documentation for further details.
std::string regina::NTxICore::name ( ) const

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

Returns
the name of this triangulation.
const NMatrix2 & regina::NTxICore::parallelReln ( ) const
inline

Returns a 2-by-2 matrix describing the parallel relationship between the upper and lower boundary curves.

Let a_u and b_u be the upper alpha and beta boundary curves. Suppose that the lower alpha is parallel to w.a_u + x.b_u, and that the lower beta is parallel to y.a_u + z.b_u. Then the matrix returned will be

    [ w  x ]
    [      ] .
    [ y  z ]

In other words, if a_l and b_l are the lower alpha and beta curves respectively, we have

    [ a_l ]                      [ a_u ]
    [     ]  =  parallelReln() * [     ] .
    [ b_l ]                      [ b_u ]
Returns
the relationship between the upper and lower boundary curves.
std::string regina::Output< NTxICore , 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:
In addition to str(), this is also used as the Python "stringification" function __str__().
Returns
a short text representation of this object.
std::string regina::NTxICore::TeXName ( ) const

Returns the name of this specific triangulation of T x I in TeX format.

No leading or trailing dollar signs will be included.

Returns
the name of this triangulation in TeX format.
REGINA_DEPRECATED std::string regina::Output< NTxICore , false >::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.
REGINA_DEPRECATED std::string regina::Output< NTxICore , false >::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.
std::string regina::Output< NTxICore , 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.
virtual std::ostream& regina::NTxICore::writeName ( std::ostream &  out) const
pure virtual

Writes the name of this specific triangulation of T x I to the given output stream.

The name will be written as a human-readable string.

Python:
The parameter out does not exist; instead standard output will always be used. Moreover, this routine returns None.
Parameters
outthe output stream to which to write.
Returns
a reference to the given output stream.

Implemented in regina::NTxIParallelCore, and regina::NTxIDiagonalCore.

virtual std::ostream& regina::NTxICore::writeTeXName ( std::ostream &  out) const
pure virtual

Writes the name of this specific triangulation of T x I in TeX format to the given output stream.

No leading or trailing dollar signs will be written.

Python:
The parameter out does not exist; instead standard output will always be used. Moreover, this routine returns None.
Parameters
outthe output stream to which to write.
Returns
a reference to the given output stream.

Implemented in regina::NTxIParallelCore, and regina::NTxIDiagonalCore.

void regina::NTxICore::writeTextLong ( std::ostream &  out) const
inline

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

Python:
Not present.
Parameters
outthe output stream to which to write.
void regina::NTxICore::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.

Member Data Documentation

NMatrix2 regina::NTxICore::bdryReln_[2]
protected

Expresses the alpha and beta curves for each torus boundary in terms of specific tetrahedron edges and vertices.

The elements bdryReln_[0] and bdryReln_[1] refer to the upper and lower boundaries respectively, and each of these matrices must have determinant +1 or -1. See bdryReln() for further details.

NPerm4 regina::NTxICore::bdryRoles_[2][2]
protected

Describes which tetrahedron vertices play which roles in the upper and lower boundary triangles.

See bdryRoles() for details.

unsigned regina::NTxICore::bdryTet_[2][2]
protected

The tetrahedra that provide the upper and lower boundary triangles.

See bdryTet() for details.

NTriangulation regina::NTxICore::core_
protected

A full copy of the T x I triangulation that is described.

NMatrix2 regina::NTxICore::parallelReln_
protected

Expresses the lower alpha and beta curves in terms of the upper alpha and beta curves.

See parallelReln() for details.


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