Regina Calculation Engine

Represents a layered loop component of a triangulation. More...
#include <subcomplex/nlayeredloop.h>
Public Member Functions  
virtual  ~NLayeredLoop () 
Destroys this layered loop. More...  
NLayeredLoop *  clone () const 
Returns a newly created clone of this structure. More...  
unsigned long  length () const 
Returns the length of this layered loop. More...  
REGINA_DEPRECATED unsigned long  getLength () const 
Deprecated routine that returns the length of this layered loop. More...  
REGINA_DEPRECATED unsigned long  getIndex () const 
Returns the length of this layered loop. More...  
bool  isTwisted () const 
Determines if this layered loop contains a twist. More...  
NEdge *  hinge (int which) const 
Returns the requested hinge edge of this layered loop. More...  
REGINA_DEPRECATED NEdge *  getHinge (int which) const 
Deprecated routine that returns the requested hinge edge of this layered loop. More...  
NManifold *  manifold () const 
Returns the 3manifold represented by this triangulation, if such a recognition routine has been implemented. More...  
NAbelianGroup *  homology () 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 humanreadable 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 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 humanreadable string. More...  
REGINA_DEPRECATED std::string  getName () const 
Deprecated routine that returns the name of this specific triangulation as a humanreadable string. More...  
std::string  TeXName () const 
Returns the name of this specific triangulation in TeX format. More...  
REGINA_DEPRECATED std::string  getTeXName () const 
Deprecated routine that returns the name of this specific triangulation in TeX format. More...  
REGINA_DEPRECATED NManifold *  getManifold () const 
Deprecated routine that returns the 3manifold represented by this triangulation,. More...  
NAbelianGroup *  homologyH1 () const 
Returns the expected first homology group of this triangulation, if such a routine has been implemented. More...  
REGINA_DEPRECATED NAbelianGroup *  getHomologyH1 () const 
Deprecated routine that 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...  
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 NLayeredLoop *  isLayeredLoop (const NComponent *comp) 
Determines if the given triangulation component is a layered loop. 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 layered loop component of a triangulation.
A layered loop is a layered chain of n tetrahedra whose bottom tetrahedron is layered onto its top tetrahedron to form a complete loop. See the NLayeredChain class notes for a description of a layered chain.
To make a layered chain into a layered loop, the bottom faces of the first tetrahedron will be layered upon the top faces of the last tetrahedron, completing the loop. At this stage there is a choice. The layering can be done in the usual fashion, or there may be a twist in which the upper square (the bottom faces of the first tetrahedron) is rotated 180 degrees before being layered on the lower annulus (the top faces of the last tetrahedron).
If there is a twist, the two hinge edges become identified and the entire component has a single vertex. If there is no twist, the two hinge edges remain distinct (and disjoint) and the entire component has two vertices.
The length of the layered loop is the number of tetrahedra it contains. A layered loop must contain at least one tetrahedron.
All optional NStandardTriangulation routines are implemented for this class.

inlinevirtual 
Destroys this layered loop.
NLayeredLoop* regina::NLayeredLoop::clone  (  )  const 
Returns a newly created clone of this structure.

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 humanreadable, 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.

inline 
Deprecated routine that returns the requested hinge edge of this layered loop.

inlineinherited 
Deprecated routine that returns the expected first homology group of this triangulation, if such a routine has been implemented.

inline 
Returns the length of this layered loop.
See the general class notes for further details.

inline 
Deprecated routine that returns the length of this layered loop.

inlineinherited 
Deprecated routine that returns the 3manifold represented by this triangulation,.

inlineinherited 
Deprecated routine that returns the name of this specific triangulation as a humanreadable string.

inlineinherited 
Deprecated routine that returns the name of this specific triangulation in TeX format.

inline 
Returns the requested hinge edge of this layered loop.
See the general class notes for further details. If there is only one hinge but parameter which is 1, null
will be returned.
which  specifies which hinge to return; this must be 0 or 1. 

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::homology() 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::homology() upon the associated real triangulation.
This routine can also be accessed via the alias homologyH1() (a name that is more specific, but a little longer to type).
Reimplemented from regina::NStandardTriangulation.

inlineinherited 
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::homology() 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::homology() upon the associated real triangulation.
This routine can also be accessed via the alias homology() (a name that is less specific, but a little easier to type).

static 
Determines if the given triangulation component is a layered loop.
comp  the triangulation component to examine. 
null
if the given component is not a layered loop.

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 triangulationbased 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 componentbased isStandardTriangulation(NComponent*), since passing an entire triangulation allows access to more information.
tri  the triangulation under examination. 

inline 
Determines if this layered loop contains a twist.
See the general class notes for further details.
true
if and only if this layered loop contains a twist.

inline 
Returns the length of this layered loop.
See the general class notes for further details.

virtual 
Returns the 3manifold represented by this triangulation, if such a recognition routine has been implemented.
If the 3manifold cannot be recognised then this routine will return 0.
The details of which standard triangulations have 3manifold 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 3manifolds can be recognised will grow between releases.
The 3manifold 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 humanreadable string.

inherited 
Returns a short text representation of this object.
This text should be humanreadable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.
__str__()
.

inherited 
Returns the name of this specific triangulation in TeX format.
No leading or trailing dollar signs will be included.

inherited 
A deprecated alias for str().

inherited 
A deprecated alias for detail().

inherited 
Returns a short text representation of this object using unicode characters.
Like str(), this text should be humanreadable, 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 UTF8.

inlinevirtual 
Writes the name of this triangulation as a humanreadable 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 a detailed text representation of this object to the given output stream.
This may be reimplemented by subclasses, but the parent NStandardTriangulation class offers a reasonable default implementation based on writeName().
out  the output stream to which to write. 
Reimplemented from regina::NStandardTriangulation.

inlinevirtualinherited 
Writes a short text representation of this object to the given output stream.
This may be reimplemented by subclasses, but the parent NStandardTriangulation class offers a reasonable default implementation based on writeName().
out  the output stream to which to write. 