Represents a tetrahedron within a 2-manifold triangulation. More...

#include <triangulation/dim2.h>

Inheritance diagram for regina::Face< 2, 2 >:

Public Types
typedef IntOfMinSize<(dim/8)+1 >::utype	FacetMask
	An unsigned integer type with at least dim+1 bits. More...

Public Member Functions
Simplex< 2 > *	adjacentTriangle (int edge) const
	A dimension-specific alias for adjacentSimplex(). More...

int	adjacentEdge (int edge) const
	A dimension-specific alias for adjacentFacet(). More...

const std::string &	description () const
	Returns the description associated with this simplex. More...

void	setDescription (const std::string &desc)
	Sets the description associated with this simplex. More...

size_t	index () const
	Returns the index of this simplex in the underlying triangulation. More...

Simplex< dim > *	adjacentSimplex (int facet) const
	Returns the adjacent simplex that is glued to the given facet of this simplex. More...

Perm< dim+1 >	adjacentGluing (int facet) const
	Returns a permutation that indicates precisely how this simplex is glued to the adjacent simplex across the given facet. More...

int	adjacentFacet (int facet) const
	If the given facet of this simplex is glued to facet f of some adjacent simplex, then this routine returns the adjacent facet number f. More...

bool	hasBoundary () const
	Determines if this simplex has any facets that lie on the triangulation boundary. More...

void	join (int myFacet, Simplex< dim > *you, Perm< dim+1 > gluing)
	Joins the given facet of this simplex to some facet of another simplex. More...

Simplex< dim > *	unjoin (int myFacet)
	Unglues the given facet of this simplex from whatever it is joined to. More...

void	isolate ()
	Unglues this simplex from any adjacent simplices. More...

Triangulation< dim > *	triangulation () const
	Returns the triangulation to which this simplex belongs. More...

Component< dim > *	component () const
	Returns the connected component of the triangulation to which this simplex belongs. More...

template<int subdim>
Face< dim, subdim > *	face (int face) const
	Returns the subdim-face of the underlying triangulation that appears as the given subdim-face of this simplex. More...

template<int subdim>
Perm< dim+1 >	faceMapping (int face) const
	Examines the given subdim-face of this simplex, and returns the mapping between the underlying subdim-face of the triangulation and the individual vertices of this simplex. More...

int	orientation () const
	Returns the orientation of this simplex in the dim-dimensional triangulation. More...

bool	facetInMaximalForest (int facet) const
	Determines whether the given facet of this simplex belongs to the maximal forest that has been chosen for the dual 1-skeleton of the underlying triangulation. 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...

size_t	markedIndex () const
	Returns the index at which this object is stored in an MarkedVector. 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...

Protected Member Functions
bool	sameDegrees (const SimplexFacesSuite< dim, subdim > &other, Perm< dim+1 > p) const
	Tests whether the k-face degrees of this and the given simplex are identical, under the given relabelling, for all faces of all dimensions k ≤ subdim. More...

bool	sameDegrees (const SimplexFaces< dim, subdim > &other, Perm< dim+1 > p) const
	Tests whether the subdim-face degrees of this and the given simplex are identical, under the given relabelling. More...

void	clear ()
	Resets all face pointers to null. More...

Protected Attributes
Face< dim, subdim > *	face_ [FaceNumbering< dim, subdim >::nFaces]
	The faces of the underlying triangulation that form the individual subdim-faces of this simplex. More...

Perm< dim+1 >	mapping_ [FaceNumbering< dim, subdim >::nFaces]
	For each subdim-face of this simplex, maps vertices (0,1,...,subdim) of the underlying subdim-face of the triangulation to the corresponding vertices of this simplex, as described by faceMapping(). More...

Friends
class	Triangulation< 2 >

class	detail::TriangulationBase< 2 >
	Allow access to private members. More...

Detailed Description

template<>
class regina::Face< 2, 2 >

Represents a tetrahedron within a 2-manifold triangulation.

This class is typically referred to by the aliases Simplex<2> or Triangle<2> (or, for Python users, Simplex2 and Triangle2).

The class template Face<dim, dim> specialises the generic Face class template in order to work with top-dimensional simplices in a triangulation. This class Face<2, 2> specialises it further to add dimension-specific aliases for dimension 2.

See the documentation for the partial specialisation Face<dim, dim> for an overview of how a top-dimensional simplex class works.

Member Function Documentation

◆ detail()

std::string regina::Output< SimplexBase< 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.

◆ sameDegrees()

bool regina::detail::SimplexFacesSuite< dim >::sameDegrees	(	const SimplexFacesSuite< dim, subdim > &	other,
		Perm< dim+1 >	p
	)		const

inlineprotectedinherited

Tests whether the k-face degrees of this and the given simplex are identical, under the given relabelling, for all faces of all dimensions k ≤ subdim.

Parameters

other	the simplex to compare against this.
p	a mapping from the vertices of this simplex to the vertices of other.

Returns: true if and only if, for every i and every facial dimension k ≤ subdim, k-face number i of this simplex has the same degree as its image in other under the relabelling p.

◆ str()

std::string regina::Output< SimplexBase< 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:\n 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< SimplexBase< 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.

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

triangulation/dim2/triangle2.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<> class regina::Face< 2, 2 >

Member Function Documentation

◆ detail()

◆ sameDegrees()

◆ str()

◆ utf8()

template<>
class regina::Face< 2, 2 >