Regina Calculation Engine
|
Helper class that provides core functionality for describing how a subdim-face of a dim-dimensional triangulation appears within each top-dimensional simplex. More...
#include <triangulation/detail/face.h>
Public Member Functions | |
FaceEmbeddingBase () | |
Default constructor. More... | |
FaceEmbeddingBase (Simplex< dim > *simplex, int face) | |
Creates a new object containing the given data. More... | |
FaceEmbeddingBase (const FaceEmbeddingBase &cloneMe) | |
Creates a new copy of the given object. More... | |
FaceEmbeddingBase & | operator= (const FaceEmbeddingBase &cloneMe) |
Makes this a copy of the given object. More... | |
Simplex< dim > * | simplex () const |
Returns the top-dimensional simplex in which the underlying subdim-face of the triangulation is contained. More... | |
int | face () const |
Returns the corresponding face number of simplex(). More... | |
Perm< dim+1 > | vertices () const |
Maps vertices (0,...,subdim) of the underlying subdim-face of the triangulation to the corresponding vertex numbers of simplex(). More... | |
bool | operator== (const FaceEmbeddingBase &rhs) const |
Tests whether this and the given object are identical. More... | |
bool | operator!= (const FaceEmbeddingBase &rhs) const |
Tests whether this and the given object are different. 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 |
A default implementation for detailed output. 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... | |
Helper class that provides core functionality for describing how a subdim-face of a dim-dimensional triangulation appears within each top-dimensional simplex.
Each such appearance is described by a FaceEmbedding<dim, subdim> object, which uses this as a base class. End users should not need to refer to FaceEmbeddingBase directly.
See the FaceEmbedding template class notes for further information.
dim | the dimension of the underlying triangulation. This must be between 2 and 15 inclusive. |
subdim | the dimension of the faces of the underlying triangulation. This must be between 0 and dim-1 inclusive. |
|
inline |
Default constructor.
This object is unusable until it has some data assigned to it using operator =
.
|
inline |
Creates a new object containing the given data.
simplex | the top-dimensional simplex in which the underlying subdim-face of the triangulation is contained. |
face | the corresponding face number of simplex. This must be between 0 and (dim+1 choose subdim+1)-1 inclusive. |
|
inline |
Creates a new copy of the given object.
cloneMe | the object to copy. |
|
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.
|
inline |
Returns the corresponding face number of simplex().
This identifies which face of the top-dimensional simplex simplex() refers to the underlying subdim-face of the triangulation.
|
inline |
Tests whether this and the given object are different.
Here "different" means that they do not refer to the same face of the same top-dimensional simplex.
rhs | the object to compare with this. |
true
if and only if both object are identical.
|
inline |
Makes this a copy of the given object.
cloneMe | the object to copy. |
|
inline |
Tests whether this and the given object are identical.
Here "identical" means that they refer to the same face of the same top-dimensional simplex.
rhs | the object to compare with this. |
true
if and only if both object are identical.
|
inline |
Returns the top-dimensional simplex in which the underlying subdim-face of the triangulation is contained.
|
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.
|
inline |
Maps vertices (0,...,subdim) of the underlying subdim-face of the triangulation to the corresponding vertex numbers of simplex().
If the link of the underlying subdim-face is orientable, then this permutation also maps (subdim+1, ..., dim) to the remaining vertex numbers of simplex() in a manner that preserves orientation as you walk through the many different FaceEmbedding objects for the same underlying subdim-face.
This routine returns the same permutation as simplex().faceMapping<subdim>(face())
. See Simplex<dim>::faceMapping() for details.
|
inlineinherited |
A default implementation for detailed output.
This routine simply calls T::writeTextShort() and appends a final newline.
out | the output stream to which to write. |
|
inline |
Writes a short text representation of this object to the given output stream.
out | the output stream to which to write. |