Regina Calculation Engine
Public Member Functions | List of all members
regina::FaceEmbedding< dim, subdim > Class Template Reference

Details how a subdim-face of a dim-dimensional triangulation appears within each top-dimensional simplex. More...

#include <triangulation/generic.h>

Public Member Functions

 FaceEmbedding ()=default
 Default constructor. More...
 
 FaceEmbedding (Simplex< dim > *simplex, int face)
 Creates a new object containing the given data. More...
 
 FaceEmbedding (const FaceEmbedding &cloneMe)=default
 Creates a new copy of the given object. More...
 
FaceEmbeddingoperator= (const FaceEmbedding &cloneMe)=default
 Sets this to be a copy of the given object. More...
 

Detailed Description

template<int dim, int subdim>
class regina::FaceEmbedding< dim, subdim >

Details how a subdim-face of a dim-dimensional triangulation appears within each top-dimensional simplex.

For small-dimensional faces, this class is typically described using dimension-specific type aliases: VertexEmbedding<dim>, EdgeEmbedding<dim>, TriangleEmbedding<dim>, TetrahedronEmbedding<dim> and PentachoronEmbedding<dim> refer to the cases subdim = 0, 1, 2, 3 and 4 respectively.

For a dim-dimensional triangulation T, each subdim-face F typically belongs to many top-dimensional simplices of T, and therefore has many associated FaceEmbedding objects. These individual FaceEmbedding objects correspond to the top-dimensional simplices of the link of F (which is a (dim - subdim - 1)-dimensional triangulation).

If dim is one of Regina's standard dimensions, then this template is specialised to offer additional dimension-specific aliases. In order to use these specialised classes, you will need to include the corresponding triangulation headers (e.g., triangulation/dim2.h for dim = 2, or triangulation/dim3.h for dim = 3).

Python:\n Python does not support templates. Instead this class
can be used by appending dimensions dim and subdim as suffices (e.g., FaceEmbedding2_1 and FaceEmbedding3_0 for the two examples above).
Template Parameters
dimthe dimension of the underlying triangulation. This must be between 2 and 15 inclusive.
subdimthe dimension of the faces of the underlying triangulation. This must be between 0 and dim-1 inclusive.

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

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