Regina Calculation Engine
Public Member Functions | Friends | List of all members
regina::Cusp Class Reference

Represents a single cusp of a SnapPea triangulation. More...

#include <snappea/snappeatriangulation.h>

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

Public Member Functions

Vertex< 3 > * vertex () const
 Returns the corresponding vertex of the Regina triangulation (i.e., of the Triangulation<3> structure that is inherited by SnapPeaTriangulation). More...
 
bool complete () const
 Returns whether this cusp is complete. More...
 
int m () const
 Returns the first (meridian) filling coefficient on this cusp, or 0 if this cusp is complete. More...
 
int l () const
 Returns the second (longitude) filling coefficient on this cusp, or 0 if this cusp is complete. 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...
 

Friends

class SnapPeaTriangulation
 Allow access to private members. More...
 

Detailed Description

Represents a single cusp of a SnapPea triangulation.

See the SnapPeaTriangulation class for further details.

Cusp objects should be considered temporary only. They are preserved if you change the fillings (via SnapPeaTriangulation::fill() or SnapPeaTriangulation::unfill()). However, if you change the SnapPea triangulation itself (e.g., via randomize()), then all cusp objects will be deleted and replaced with new ones (using fresh data re-fetched from the SnapPea kernel).

Member Function Documentation

◆ complete()

bool regina::Cusp::complete ( ) const
inline

Returns whether this cusp is complete.

SnapPy:
In SnapPy, this field corresponds to querying Manifold.cusp_info('is_complete')[cusp_number].
Returns
true if this cusp is complete, or false if it is filled.

◆ detail()

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

◆ l()

int regina::Cusp::l ( ) const
inline

Returns the second (longitude) filling coefficient on this cusp, or 0 if this cusp is complete.

SnapPy:
In SnapPy, this field corresponds to querying Manifold.cusp_info('filling')[cusp_number][1].
Returns
the second filling coefficient.

◆ m()

int regina::Cusp::m ( ) const
inline

Returns the first (meridian) filling coefficient on this cusp, or 0 if this cusp is complete.

SnapPy:
In SnapPy, this field corresponds to querying Manifold.cusp_info('filling')[cusp_number][0].
Returns
the first filling coefficient.

◆ str()

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

◆ utf8()

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

◆ vertex()

Vertex< 3 > * regina::Cusp::vertex ( ) const
inline

Returns the corresponding vertex of the Regina triangulation (i.e., of the Triangulation<3> structure that is inherited by SnapPeaTriangulation).

Note that cusp and vertex indexing might not be in sync; that is, SnapPea's cusp(i) need not correspond to Regina's vertex(i).

This routine can be used to detect if/when cusp numbering and vertex numbering fall out of sync, and to translate between them if/when this happens.

◆ writeTextLong()

void regina::ShortOutput< Cusp , 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::Cusp::writeTextShort ( std::ostream &  out) const

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

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

Friends And Related Function Documentation

◆ SnapPeaTriangulation

friend class SnapPeaTriangulation
friend

Allow access to private members.


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