Regina Calculation Engine
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
regina::detail::BoundaryComponentFaceStorage< dim, allFaces_ > Class Template Reference

Helper class for storing the necessary faces of a boundary component of a dim-dimensional triangulation. More...

#include <triangulation/detail/boundarycomponent.h>

Public Member Functions

size_t size () const
 Returns the number of (dim-1)-faces in this boundary component. More...
 
size_t countRidges () const
 Returns the number of (dim-2)-faces in this boundary component. More...
 
template<int subdim>
size_t countFaces () const
 Returns the number of subdim-faces in this boundary component. More...
 
const std::vector< Face< dim, dim-1 > * > & facets () const
 Returns all (dim-1)-faces in this boundary component. More...
 
template<int subdim>
const std::vector< Face< dim, subdim > * > & faces () const
 Returns all subdim-faces in this boundary component. More...
 
Face< dim, dim-1 > * facet (size_t index) const
 Returns the requested (dim-1)-face in this boundary component. More...
 
template<int subdim>
Face< dim, subdim > * face (size_t index) const
 Returns the requested subdim-face in this boundary component. More...
 
Triangulation< dim > * triangulation () const
 Returns the triangulation to which this boundary component belongs. More...
 
Component< dim > * component () const
 Returns the connected component of the triangulation to which this boundary component belongs. More...
 

Static Public Attributes

static constexpr bool allFaces = true
 A compile-time constant indicating whether this boundary component class stores all lower-dimensional faces (true), or only faces of dimension dim-1 (false). More...
 

Protected Member Functions

template<int subdim>
void push_back (Face< dim, subdim > *face)
 Pushes the given face onto the end of the list of subdim-faces of this boundary component. More...
 
void reorderAndRelabelFaces (Triangulation< dim-1 > *tri) const
 Reorders all lower-dimensional faces of the given triangulation so that they appear in the same order as the corresponding faces of this boundary component, and relabels these faces so that their vertices are numbered in a corresponding way. More...
 

Detailed Description

template<int dim, bool allFaces_>
class regina::detail::BoundaryComponentFaceStorage< dim, allFaces_ >

Helper class for storing the necessary faces of a boundary component of a dim-dimensional triangulation.

Every class BoundaryComponent<dim> inherits from this template.

Python:\n This base class is not present, but the "end user" class
BoundaryComponent<dim> is.
Template Parameters
dimthe dimension of the underlying triangulation. This must be between 2 and 15 inclusive.
allFaces_true if this class should store all faces of all dimensions 0,1,...,dim-1, or false if this class should only store faces of dimension dim-1.

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

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