Represents a single cusp of a SnapPea triangulation.
More...
#include <snappea/nsnappeatriangulation.h>
Represents a single cusp of a SnapPea triangulation.
See the NSnapPeaTriangulation class for further details.
NCusp objects should be considered temporary only. They are preserved if you change the fillings (via NSnapPeaTriangulation::fill() or NSnapPeaTriangulation::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).
§ complete()
bool regina::NCusp::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()
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::NCusp::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::NCusp::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()
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()
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()
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.
§ utf8()
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()
NVertex * regina::NCusp::vertex |
( |
| ) |
const |
|
inline |
Returns the corresponding vertex of the Regina triangulation (i.e., of the NTriangulation structure that is inherited by NSnapPeaTriangulation).
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()
A default implementation for detailed output.
This routine simply calls T::writeTextShort() and appends a final newline.
- Python:
- Not present.
- Parameters
-
out | the output stream to which to write. |
§ writeTextShort()
void regina::NCusp::writeTextShort |
( |
std::ostream & |
out | ) |
const |
Writes a short text representation of this object to the given output stream.
- Python:
- Not present.
- Parameters
-
out | the output stream to which to write. |
§ NSnapPeaTriangulation
Allow access to private members.
The documentation for this class was generated from the following file: