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

Represents a component of the boundary of a 2-manifold triangulation. More...

#include <dim2/dim2boundarycomponent.h>

Inheritance diagram for regina::Dim2BoundaryComponent:
regina::Output< Dim2BoundaryComponent > regina::alias::FaceOfTriangulation< Dim2BoundaryComponent, 2 > regina::NMarkedElement

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...
 
Dim2Componentcomponent () const
 Returns the component of the triangulation to which this boundary component belongs. More...
 
REGINA_DEPRECATED Dim2ComponentgetComponent () 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...
 

Detailed Description

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.

Member Function Documentation

§ component()

Dim2Component * regina::Dim2BoundaryComponent::component ( ) const
inline

Returns the component of the triangulation to which this boundary component belongs.

Returns
the component containing this boundary component.

§ countFaces()

template<int subdim>
size_t regina::Dim2BoundaryComponent::countFaces ( ) const

Returns the number of subdim-faces in this boundary component.

Precondition
The template argument subdim is either 0 or 1.
Python:
Python does not support templates. Instead, Python users should call this function in the form countFaces(subdim); that is, the template parameter subdim becomes the first argument of the function.
Returns
the number of subdim-faces.

§ detail()

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

§ face()

template<int subdim>
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.

Precondition
The template argument subdim is either 0 or 1.
Python:
Python does not support templates. Instead, Python users should call this function in the form face(subdim, index); that is, the template parameter subdim becomes the first argument of the function.
Parameters
indexthe index of the desired face, ranging from 0 to countFaces<subdim>()-1 inclusive.
Returns
the requested face.

§ getComponent()

Dim2Component * regina::Dim2BoundaryComponent::getComponent ( ) const
inline

Deprecated routine that returns the component of the triangulation to which this boundary component belongs.

Deprecated:
This routine has been renamed to component(). See the component() documentation for further details.

§ index()

size_t regina::Dim2BoundaryComponent::index ( ) const
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.

Returns
the index of this boundary component.

§ markedIndex()

size_t regina::NMarkedElement::markedIndex ( ) const
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.

Returns
the index at which this object is stored.

§ str()

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

§ toString()

REGINA_DEPRECATED std::string regina::Output< Dim2BoundaryComponent , false >::toString ( ) const
inherited

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

REGINA_DEPRECATED std::string regina::Output< Dim2BoundaryComponent , false >::toStringLong ( ) const
inherited

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

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

§ writeTextLong()

void regina::Dim2BoundaryComponent::writeTextLong ( std::ostream &  out) const

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

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

§ writeTextShort()

void regina::Dim2BoundaryComponent::writeTextShort ( std::ostream &  out) const
inline

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

§ Triangulation< 2 >

friend class Triangulation< 2 >
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).