Regina Calculation Engine
|
Represents a vertex in the skeleton of a 2-manifold triangulation. More...
#include <dim2/dim2vertex.h>
Public Member Functions | |
unsigned long | index () const |
Returns the index of this vertex in the underlying triangulation. More... | |
const std::deque < Dim2VertexEmbedding > & | getEmbeddings () const |
Returns the list of descriptors detailing how this vertex forms a part of various triangles in the triangulation. More... | |
unsigned long | getNumberOfEmbeddings () const |
Returns the number of descriptors in the list returned by getEmbeddings(). More... | |
const Dim2VertexEmbedding & | getEmbedding (unsigned long index) const |
Returns the requested descriptor from the list returned by getEmbeddings(). More... | |
Dim2Triangulation * | getTriangulation () const |
Returns the triangulation to which this vertex belongs. More... | |
Dim2Component * | getComponent () const |
Returns the component of the triangulation to which this vertex belongs. More... | |
Dim2BoundaryComponent * | getBoundaryComponent () const |
Returns the boundary component of the triangulation to which this vertex belongs. More... | |
unsigned long | getDegree () const |
Returns the degree of this vertex. More... | |
bool | isBoundary () const |
Determines if this vertex lies on the boundary of the triangulation. More... | |
void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. More... | |
void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. More... | |
long | markedIndex () const |
Returns the index at which this object is stored in an NMarkedVector. More... | |
Input and Output | |
std::string | str () const |
Returns the output from writeTextShort() as a string. More... | |
std::string | toString () const |
A deprecated alias for str(), which returns the output from writeTextShort() as a string. More... | |
std::string | detail () const |
Returns the output from writeTextLong() as a string. More... | |
std::string | toStringLong () const |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More... | |
Friends | |
class | Dim2Triangulation |
Allow access to private members. More... | |
Represents a vertex in the skeleton of a 2-manifold triangulation.
Vertices are highly temporary; once a triangulation changes, all its vertex objects will be deleted and new ones will be created.
|
inherited |
Returns the output from writeTextLong() as a string.
|
inline |
Returns the boundary component of the triangulation to which this vertex belongs.
|
inline |
Returns the component of the triangulation to which this vertex belongs.
|
inline |
Returns the degree of this vertex.
Note that this is identical to getNumberOfEmbeddings().
|
inline |
Returns the requested descriptor from the list returned by getEmbeddings().
index | the index of the requested descriptor. This should be between 0 and getNumberOfEmbeddings()-1 inclusive. |
|
inline |
Returns the list of descriptors detailing how this vertex forms a part of various triangles in the triangulation.
Note that if this vertex represents multiple vertices of a particular triangle, then there will be multiple embedding descriptors in the list regarding that triangle.
|
inline |
Returns the number of descriptors in the list returned by getEmbeddings().
Note that this is identical to getDegree().
|
inline |
Returns the triangulation to which this vertex belongs.
|
inline |
Returns the index of this vertex in the underlying triangulation.
This is identical to calling getTriangulation()->vertexIndex(this)
.
|
inline |
Determines if this vertex lies on the boundary of the triangulation.
true
if and only if this vertex lies on the boundary.
|
inlineinherited |
Returns the index at which this object is stored in an NMarkedVector.
If this object does not belong to an NMarkedVector, the return value is undefined.
|
inherited |
Returns the output from writeTextShort() as a string.
__str__()
function.
|
inlineinherited |
A deprecated alias for str(), which returns the output from writeTextShort() as a string.
|
inlineinherited |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string.
|
virtual |
Writes this object in long text format to the given output stream.
The output should provide the user with all the information they could want. The output should be human-readable, should not contain extremely long lines (so users can read the output in a terminal), and should end with a final newline.
The default implementation of this routine merely calls writeTextShort() and adds a newline.
out | the output stream to which to write. |
Reimplemented from regina::ShareableObject.
|
inlinevirtual |
Writes this object in short text format to the given output stream.
The output should be human-readable, should fit on a single line, and should not end with a newline.
out | the output stream to which to write. |
Implements regina::ShareableObject.
|
friend |
Allow access to private members.