Regina Calculation Engine
|
Represents a component of the boundary of a 2-manifold triangulation. More...
#include <dim2/dim2boundarycomponent.h>
Public Member Functions | |
size_t | index () const |
Returns the index of this boundary component in the underlying triangulation. More... | |
template<int subdim> | |
size_t | countFaces () const |
Returns the number of subdim-faces in this boundary component. More... | |
template<int subdim> | |
Face< 2, subdim > * | face (size_t index) const |
Returns the requested subdim-face in this boundary component. More... | |
Dim2Component * | component () const |
Returns the component of the triangulation to which this boundary component belongs. More... | |
REGINA_DEPRECATED Dim2Component * | getComponent () const |
Deprecated routine that returns the component of the triangulation to which this boundary component belongs. 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... | |
size_t | markedIndex () const |
Returns the index at which this object is stored in an NMarkedVector. More... | |
Friends | |
class | Triangulation< 2 > |
Allow access to private members. More... | |
Represents a component of the boundary of a 2-manifold triangulation.
Boundary components are highly temporary; once a triangulation changes, all its boundary component objects will be deleted and new ones will be created.
|
inline |
Returns the component of the triangulation to which this boundary component belongs.
size_t regina::Dim2BoundaryComponent::countFaces | ( | ) | const |
Returns the number of subdim-faces in this boundary component.
countFaces(subdim)
; that is, the template parameter subdim becomes the first argument of the function.
|
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.
Face<2, subdim>* regina::Dim2BoundaryComponent::face | ( | size_t | index | ) | const |
Returns the requested subdim-face in this boundary component.
Note that the index of a face in the boundary component need not be the index of the same face in the overall triangulation.
face(subdim, index)
; that is, the template parameter subdim becomes the first argument of the function.index | the index of the desired face, ranging from 0 to countFaces<subdim>()-1 inclusive. |
|
inline |
Deprecated routine that returns the component of the triangulation to which this boundary component belongs.
|
inline |
Returns the index of this boundary component in the underlying triangulation.
This is identical to calling the deprecated function boundaryComponentIndex(this)
on the underlying triangulation.
|
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 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.
__str__()
.
|
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 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.
void regina::Dim2BoundaryComponent::writeTextLong | ( | std::ostream & | out | ) | const |
Writes a detailed text representation of this object to the given output stream.
out | the output stream to which to write. |
|
inline |
Writes a short text representation of this object to the given output stream.
out | the output stream to which to write. |
|
friend |
Allow access to private members.