Regina Calculation Engine
Public Member Functions | Protected Attributes | Friends | List of all members
regina::BoundaryComponent< 3 > Class Reference

A component of the boundary of a 3-manifold triangulation. More...

#include <triangulation/dim3.h>

Inheritance diagram for regina::BoundaryComponent< 3 >:
regina::detail::BoundaryComponentBase< 3 > regina::Output< BoundaryComponentBase< dim > > regina::MarkedElement

Public Member Functions

long eulerChar () const
 Returns the Euler characteristic of this boundary component. More...
 
size_t index () const
 Returns the index of this boundary component in the underlying triangulation. More...
 
bool isOrientable () const
 Determines if this boundary component is orientable. 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...
 
size_t markedIndex () const
 Returns the index at which this object is stored in an MarkedVector. More...
 

Protected Attributes

bool orientable_
 Is this boundary component orientable? More...
 

Friends

class Triangulation< 3 >
 
class detail::TriangulationBase< 3 >
 

Detailed Description

A component of the boundary of a 3-manifold triangulation.

This is a specialisation of the generic BoundaryComponent class template; see the BoundaryComponent documentation for an overview of how this class works.

This 3-dimensional specialisation contains some extra functionality. In particular, it allows you to query the Euler characteristic and orientability of a boundary component, without the heavyweight process of triangulating the boundary component first.

Member Function Documentation

◆ detail()

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

◆ index()

size_t regina::detail::BoundaryComponentBase< dim >::index ( ) const
inlineinherited

Returns the index of this boundary component in the underlying triangulation.

Returns
the index of this boundary component.

◆ isOrientable()

bool regina::detail::BoundaryComponentBase< dim >::isOrientable ( ) const
inlineinherited

Determines if this boundary component is orientable.

If this is an ideal or invalid vertex boundary component, then the orientability of the corresponding vertex link is returned.

This routine is fast; in particular, it is pre-computed and does not build a full triangulation of the boundary component.

Returns
true if and only if this boundary component is orientable.

◆ str()

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

◆ utf8()

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

Member Data Documentation

◆ orientable_

bool regina::detail::BoundaryComponentBase< dim >::orientable_
protectedinherited

Is this boundary component orientable?


The documentation for this class was generated from the following file:

Copyright © 1999-2021, 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).