Regina Calculation Engine
|
Represents a connected component of a 2-manifold triangulation. More...
#include <triangulation/dim2.h>
Public Member Functions | |
template<int subdim> | |
size_t | countFaces () const |
Returns the number of subdim-faces in this component. More... | |
template<int subdim> | |
const std::vector< Face< 2, subdim > * > & | faces () const |
Returns a reference to the list of all subdim-faces in this component. More... | |
template<int subdim> | |
Face< 2, subdim > * | face (size_t index) const |
Returns the requested subdim-face in this component. More... | |
bool | isClosed () const |
Determines if this component is closed. More... | |
size_t | index () const |
Returns the index of this component within the underlying triangulation. More... | |
size_t | size () const |
Returns the number of top-dimensional simplices in this component. More... | |
const std::vector< Simplex< dim > *> & | simplices () const |
Returns all top-dimensional simplices in this component. More... | |
Simplex< dim > * | simplex (size_t index) const |
Returns the top-dimensional simplex at the given index in this component. More... | |
size_t | countBoundaryComponents () const |
Returns the number of boundary components in this component. More... | |
const std::vector< BoundaryComponent< dim > *> & | boundaryComponents () const |
Returns all boundary components in this component. More... | |
BoundaryComponent< dim > * | boundaryComponent (size_t index) const |
Returns the boundary component at the given index in this component. More... | |
bool | isValid () const |
Determines if this component is valid. More... | |
bool | isOrientable () const |
Determines if this component is orientable. More... | |
bool | hasBoundaryFacets () const |
Determines if this component has any boundary facets. More... | |
size_t | countBoundaryFacets () const |
Returns the number of boundary facets in this component. 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... | |
size_t | markedIndex () const |
Returns the index at which this object is stored in an MarkedVector. More... | |
Protected Attributes | |
bool | valid_ |
Is this component valid? See Triangulation<dim>::isValid() for details on what this means. More... | |
Friends | |
class | Triangulation< 2 > |
class | detail::TriangulationBase< 2 > |
Represents a connected component of a 2-manifold triangulation.
This is a specialisation of the generic Component class template; see the Component documentation for an overview of how this class works.
This 2-dimensional specialisation contains some extra functionality. In particular, each 2-dimensional component also stores details on lower-dimensional faces (i.e., vertices and edges).
|
inlineinherited |
Returns the boundary component at the given index in this component.
Note that the index of a boundary component within this component may not be the same as its index within the overall triangulation.
index | specifies which boundary component to return; this should be between 0 and countBoundaryComponents()-1 inclusive. |
|
inherited |
Returns all boundary components in this component.
The reference that is returned will remain valid only for as long as this component object exists. In particular, the reference will become invalid any time that the triangulation changes (since all component objects will be destroyed and others rebuilt in their place).
|
inlineinherited |
Returns the number of boundary components in this component.
|
inlineinherited |
Returns the number of boundary facets in this component.
A boundary facet is a (dim-1)-dimensional facet of a top-dimensional simplex that is not joined to any adjacent simplex.
This routine runs in constant time (since the result is computed in advance, when the component is first created).
size_t regina::Component< 2 >::countFaces | ( | ) | const |
Returns the number of subdim-faces in this 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::Component< 2 >::face | ( | size_t | index | ) | const |
Returns the requested subdim-face in this component.
Note that the index of a face in the 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. |
const std::vector<Face<2, subdim>*>& regina::Component< 2 >::faces | ( | ) | const |
Returns a reference to the list of all subdim-faces in this component.
faces(subdim)
. It will then return a Python list containing all the subdim-faces of the triangulation.
|
inlineinherited |
Determines if this component has any boundary facets.
This routine returns true
if and only if this component contains some top-dimensional simplex with at least one facet that is not glued to an adjacent simplex.
true
if and only if this component has boundary facet(s).
|
inlineinherited |
Returns the index of this component within the underlying triangulation.
|
inline |
Determines if this component is closed.
This is the case if and only if it has no boundary.
true
if and only if this component is closed.
|
inlineinherited |
Determines if this component is orientable.
This routine runs in constant time (since orientability is determined in advance, when the component is first created).
true
if and only if this component is orientable.
|
inlineinherited |
Determines if this component is valid.
This uses the same criteria as Triangulation<dim>::isValid(); see the Triangulation<dim>::isValid() documentation for details.
As with Triangulation<dim>, this tests for bad self-identifications in all dimensions, but only tests for bad links in Regina's standard dimensions.
true
if and only if this component is valid.
|
inlineinherited |
Returns the index at which this object is stored in an MarkedVector.
If this object does not belong to an MarkedVector, the return value is undefined.
|
inlineinherited |
Returns the top-dimensional simplex at the given index in this component.
Note that the index within this component may not be the same as the index within the overall triangulation.
index | specifies which simplex to return; this value should be between 0 and size()-1 inclusive. |
|
inlineinherited |
Returns all top-dimensional simplices in this component.
The reference that is returned will remain valid only for as long as this component object exists. In particular, the reference will become invalid any time that the triangulation changes (since all component objects will be destroyed and others rebuilt in their place).
|
inlineinherited |
Returns the number of top-dimensional simplices in this component.
|
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 |
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.
|
inherited |
Writes a detailed text representation of this object to the given output stream.
out | the output stream to which to write. |
|
inherited |
Writes a short text representation of this object to the given output stream.
out | the output stream to which to write. |
|
protectedinherited |
Is this component valid? See Triangulation<dim>::isValid() for details on what this means.