Provides core functionality for facet pairings (that is, dual graphs) of dim-dimensional triangulations. More...

#include <triangulation/detail/facetpairing.h>

Inheritance diagram for regina::detail::FacetPairingBase< dim >:

Public Types
using	IsoList = std::list< Isomorphism< dim > >
	A list of isomorphisms on facet pairings. More...

Public Member Functions
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...

Constructors, Destructors and Assignment
	FacetPairingBase (const FacetPairingBase &src)
	Creates a new copy of the given facet pairing. More...

	FacetPairingBase (FacetPairingBase &&src) noexcept
	Moves the given facet pairing into this facet pairing. More...

	FacetPairingBase (const Triangulation< dim > &tri)
	Creates the facet pairing of given triangulation. More...

	FacetPairingBase (std::istream &in)
	Reads a new facet pairing from the given input stream. More...

	~FacetPairingBase ()
	Deallocates any memory used by this structure. More...

FacetPairingBase &	operator= (const FacetPairingBase &src)
	Copies the given facet pairing into this facet pairing. More...

FacetPairingBase &	operator= (FacetPairingBase &&src) noexcept
	Moves the given facet pairing into this facet pairing. More...

void	swap (FacetPairingBase &other) noexcept
	Swaps the contents of this and the given facet pairing. More...

Basic Queries
size_t	size () const
	Returns the number of simplices whose facets are described by this facet pairing. More...

const FacetSpec< dim > &	dest (const FacetSpec< dim > &source) const
	Returns the other facet to which the given simplex facet is paired. More...

const FacetSpec< dim > &	dest (size_t simp, unsigned facet) const
	Returns the other facet to which the given simplex facet is paired. More...

const FacetSpec< dim > &	operator[] (const FacetSpec< dim > &source) const
	Returns the other facet to which the given simplex facet is paired. More...

bool	isUnmatched (const FacetSpec< dim > &source) const
	Determines whether the given simplex facet has been left deliberately unmatched. More...

bool	isUnmatched (size_t simp, unsigned facet) const
	Determines whether the given simplex facet has been left deliberately unmatched. More...

bool	isClosed () const
	Determines whether this facet pairing is closed. More...

bool	operator== (const FacetPairing< dim > &other) const
	Determines if this and the given facet pairing are identical. More...

bool	operator!= (const FacetPairing< dim > &other) const
	Determines if this and the given facet pairing are not identical. More...

Isomorphic Representations
bool	isCanonical () const
	Determines whether this facet pairing is in canonical form, i.e., is a lexicographically minimal representative of its isomorphism class. More...

IsoList	findAutomorphisms () const
	Returns the set of all combinatorial automorphisms of this facet pairing. More...

Protected Attributes
size_t	size_
	The number of simplices under consideration. More...

FacetSpec< dim > *	pairs_
	The other facet to which each simplex facet is paired. More...

Input and Output
void	writeTextShort (std::ostream &out) const
	Writes a human-readable representation of this facet pairing to the given output stream. More...

std::string	toTextRep () const
	Returns a text-based representation of this facet pairing that can be used to reconstruct the facet pairing. More...

void	writeDot (std::ostream &out, const char *prefix=nullptr, bool subgraph=false, bool labels=false) const
	Writes the graph corresponding to this facet pairing in the Graphviz DOT language. More...

std::string	dot (const char *prefix=nullptr, bool subgraph=false, bool labels=false) const
	Returns a Graphviz DOT representation of the graph that describes this facet pairing. More...

static FacetPairing< dim >	fromTextRep (const std::string &rep)
	Reconstructs a facet pairing from a text-based representation. More...

static void	writeDotHeader (std::ostream &out, const char *graphName=nullptr)
	Writes header information for a Graphviz DOT file that will describe the graphs for one or more facet pairings. More...

static std::string	dotHeader (const char *graphName=nullptr)
	Returns header information for a Graphviz DOT file that will describe the graphs for one or more facet pairings. More...

template<typename Action , typename... Args>
static void	findAllPairings (size_t nSimplices, BoolSet boundary, int nBdryFacets, Action &&action, Args &&... args)
	Generates all possible facet pairings satisfying the given constraints. More...

	FacetPairingBase (size_t size)
	Creates a new facet pairing. More...

FacetSpec< dim > &	dest (const FacetSpec< dim > &source)
	Returns the other facet to which the given simplex facet is paired. More...

FacetSpec< dim > &	dest (size_t simp, unsigned facet)
	Returns the other facet to which the given simplex facet is paired. More...

FacetSpec< dim > &	operator[] (const FacetSpec< dim > &source)
	Returns the other facet to which the given simplex facet is paired. More...

bool	noDest (const FacetSpec< dim > &source) const
	Determines whether the matching for the given simplex facet has not yet been determined. More...

bool	noDest (size_t simp, unsigned facet) const
	Determines whether the matching for the given simplex facet has not yet been determined. More...

bool	isCanonicalInternal (IsoList &list) const
	Determines whether this facet pairing is in canonical (smallest lexicographical) form, given a small set of assumptions. More...

Detailed Description

template<int dim>
class regina::detail::FacetPairingBase< dim >

Provides core functionality for facet pairings (that is, dual graphs) of dim-dimensional triangulations.

Such a facet pairing is represented by the class FacetPairing<dim>, which uses this as a base class. End users should not need to refer to FacetPairingBase directly.

See the FacetPairing class notes for further information.

Both this class and the "end user" class FacetPairing<dim> implement C++ move semantics, and FacetPairing<dim> also adheres to the C++ Swappable requirement. These classes are designed to avoid deep copies wherever possible, even when passing or returning objects by value.

Python: This base class is not present, but the "end user" class FacetPairing<dim> is.

Template Parameters

dim	the dimension of the triangulation. This must be between 2 and 15 inclusive.

Member Typedef Documentation

◆ IsoList

template<int dim>

using regina::detail::FacetPairingBase< dim >::IsoList = std::list<Isomorphism<dim> >

A list of isomorphisms on facet pairings.

Such an isomorphism can be used to convert one facet pairing into another.

This type is used to store all automorphisms of a facet pairing; that is, all isomorphisms that map the facet pairing to itself.

Constructor & Destructor Documentation

◆ FacetPairingBase() [1/5]

template<int dim>

regina::detail::FacetPairingBase< dim >::FacetPairingBase ( const FacetPairingBase< dim > & src )

inline

Creates a new copy of the given facet pairing.

Parameters

src	the facet pairing to clone.

◆ FacetPairingBase() [2/5]

template<int dim>

regina::detail::FacetPairingBase< dim >::FacetPairingBase ( FacetPairingBase< dim > && src )

inlinenoexcept

Moves the given facet pairing into this facet pairing.

This is a fast (constant time) operation.

The facet pairing that is passed (src) will no longer be usable.

Parameters

src	the facet pairing to move.

◆ FacetPairingBase() [3/5]

template<int dim>

regina::detail::FacetPairingBase< dim >::FacetPairingBase ( const Triangulation< dim > & tri )

Creates the facet pairing of given triangulation.

This is the facet pairing that describes how the facets of simplices in the given triangulation are joined together, as described in the class notes.

Precondition: The given triangulation is not empty.

Parameters

tri	the triangulation whose facet pairing should be constructed.

◆ FacetPairingBase() [4/5]

template<int dim>

regina::detail::FacetPairingBase< dim >::FacetPairingBase ( std::istream & in )

Reads a new facet pairing from the given input stream.

This routine reads data in the format written by toTextRep().

This routine will skip any initial whitespace in the given input stream. Once it finds its first non-whitespace character, it will read the entire line from the input stream and expect that line to containin the text representation of a facet pairing.

Exceptions

InvalidInput the data found in the input stream is invalid, incomplete, or incorrectly formatted.

Parameters

in	the input stream from which to read.

◆ ~FacetPairingBase()

template<int dim>

regina::detail::FacetPairingBase< dim >::~FacetPairingBase

inline

Deallocates any memory used by this structure.

◆ FacetPairingBase() [5/5]

template<int dim>

regina::detail::FacetPairingBase< dim >::FacetPairingBase ( size_t size )

inlineprotected

Creates a new facet pairing.

All internal arrays will be allocated but not initialised.

Precondition: size is at least 1.

Parameters

size	the number of simplices under consideration in this new facet pairing.

Member Function Documentation

◆ dest() [1/4]

template<int dim>

FacetSpec< dim > & regina::detail::FacetPairingBase< dim >::dest ( const FacetSpec< dim > & source )

inlineprotected

Returns the other facet to which the given simplex facet is paired.

If the given facet is left deliberately unmatched, the value returned will be boundary (as returned by FacetSpec<dim>::isBoundary()).

Precondition: The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).

Parameters

source the facet under investigation.

Returns: the other facet to which the given facet is paired.

◆ dest() [2/4]

template<int dim>

const FacetSpec< dim > & regina::detail::FacetPairingBase< dim >::dest ( const FacetSpec< dim > & source ) const

inline

Returns the other facet to which the given simplex facet is paired.

If the given facet is left deliberately unmatched, the value returned will be boundary (as returned by FacetSpec<dim>::isBoundary()).

Precondition: The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).

Python: This routine returns by value, not by reference, since Python cannot enforce constness otherwise.

Parameters

source the facet under investigation.

Returns: the other facet to which the given facet is paired.

◆ dest() [3/4]

template<int dim>

FacetSpec< dim > & regina::detail::FacetPairingBase< dim >::dest	(	size_t	simp,
		unsigned	facet
	)

inlineprotected

Returns the other facet to which the given simplex facet is paired.

If the given facet is left deliberately unmatched, the value returned will be boundary (as returned by FacetSpec<dim>::isBoundary()).

Parameters

simp	the simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facet	the facet of the given simplex under investigation (between 0 and dim inclusive).

Returns: the other facet to which the given facet is paired.

◆ dest() [4/4]

template<int dim>

const FacetSpec< dim > & regina::detail::FacetPairingBase< dim >::dest	(	size_t	simp,
		unsigned	facet
	)		const

inline

Returns the other facet to which the given simplex facet is paired.

If the given facet is left deliberately unmatched, the value returned will be boundary (as returned by FacetSpec<dim>::isBoundary()).

Python: This routine returns by value, not by reference, since Python cannot enforce constness otherwise.

Parameters

simp	the simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facet	the facet of the given simplex under investigation (between 0 and dim inclusive).

Returns: the other facet to which the given facet is paired.

◆ detail()

template<class T , bool supportsUtf8 = false>

std::string regina::Output< T, supportsUtf8 >::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.

◆ dot()

template<int dim>

std::string regina::detail::FacetPairingBase< dim >::dot	(	const char *	prefix = `nullptr`,
		bool	subgraph = `false`,
		bool	labels = `false`
	)		const

Returns a Graphviz DOT representation of the graph that describes this facet pairing.

This routine simply returns the output of writeDot() as a string, instead of dumping it to an output stream.

All arguments are the same as for writeDot(); see the writeDot() notes for further details.

Returns: the output of writeDot(), as outlined above.

◆ dotHeader()

template<int dim>

static std::string regina::detail::FacetPairingBase< dim >::dotHeader ( const char * graphName = nullptr )

static

Returns header information for a Graphviz DOT file that will describe the graphs for one or more facet pairings.

This routine simply returns the output of writeDotHeader() as a string, instead of dumping it to an output stream.

All arguments are the same as for writeDotHeader(); see the writeDotHeader() notes for further details.

Returns: the output of writeDotHeader(), as outlined above.

◆ findAllPairings()

template<int dim>

template<typename Action , typename... Args>

void regina::detail::FacetPairingBase< dim >::findAllPairings	(	size_t	nSimplices,
		BoolSet	boundary,
		int	nBdryFacets,
		Action &&	action,
		Args &&...	args
	)

inlinestatic

Generates all possible facet pairings satisfying the given constraints.

Only connected facet pairings (pairings in which each simplex can be reached from each other via a series of individual matched facets) will be produced.

Each facet pairing will be produced precisely once up to isomorphism. Facet pairings are considered isomorphic if they are related by a relabelling of the simplices and/or a renumbering of the (dim + 1) facets of each simplex. Each facet pairing that is generated will be a lexicographically minimal representative of its isomorphism class, i.e., will be in canonical form as described by isCanonical().

For each facet pairing that is generated, this routine will call action (which must be a function or some other callable object).

The first argument to action must be a const reference to a FacetPairing<dim>. This will be the facet pairing that was found. If action wishes to keep the facet pairing, it should take a deep copy (not a reference), since the facet pairing may be changed and reused after action returns.
The second argument to action must be a FacetPairing<dim>::IsoList (this will be passed by value using move semantics). This will be the list of all automorphisms of the facet pairing that was found.
If there are any additional arguments supplied in the list args, then these will be passed as subsequent arguments to action.
action must return void.

Because this class cannot represent an empty facet pairing, if the argument nSimplices is zero then no facet pairings will be generated at all.

Todo:

Optimise (long-term): When generating facet pairings, do some checking to eliminate cases in which simplex (k > 0) can be swapped with simplex 0 to produce a smaller representation of the same pairing.

Feature: Allow cancellation of facet pairing generation.

Python: This function is available, and action may be a pure Python function. However, action cannot take any additional arguments beyond the facet pairing and its automorphisms (and therefore the additional args list is omitted here).

Parameters

nSimplices	the number of simplices whose facets should be (potentially) matched.
boundary	determines whether any facets may be left unmatched. This set should contain `true` if pairings with at least one unmatched facet are to be generated, and should contain `false` if pairings with no unmatched facets are to be generated.
nBdryFacets	specifies the precise number of facets that should be left unmatched. If this parameter is negative, it is ignored and no additional restriction is imposed. If parameter boundary does not contain `true`, this parameter is likewise ignored. If parameter boundary does contain true and this parameter is non-negative, only pairings with precisely this many unmatched facets will be generated. In particular, if this parameter is positive then pairings with no unmatched facets will not be produced irrespective of whether `false` is contained in parameter boundary. Note that, in order to produce any pairings at all, this parameter must be of the same parity as `nSimplices * (dim+1)`, and can be at most `(dim-1) * nSimplices + 2`.
action	a function (or other callable object) to call for each facet pairing that is found.
args	any additional arguments that should be passed to action, following the initial facet pairing and automorphism arguments.

◆ findAutomorphisms()

template<int dim>

FacetPairingBase< dim >::IsoList regina::detail::FacetPairingBase< dim >::findAutomorphisms

inline

Returns the set of all combinatorial automorphisms of this facet pairing.

An automorphism is a relabelling of the simplices and/or a renumbering of the (dim + 1) facets of each simplex resulting in precisely the same facet pairing.

This routine uses optimisations that can cause unpredictable breakages if this facet pairing is not in canonical form.

Precondition: This facet pairing is connected, i.e., it is possible to reach any simplex from any other simplex via a series of matched facet pairs.; This facet pairing is in canonical form as described by isCanonical().

Returns: the list of all automorphisms.

◆ fromTextRep()

template<int dim>

static FacetPairing< dim > regina::detail::FacetPairingBase< dim >::fromTextRep ( const std::string & rep )

static

Reconstructs a facet pairing from a text-based representation.

This text-based representation must be in the format produced by routine toTextRep().

Exceptions

InvalidArgument the given string was not a valid text-based representation of a facet pairing on a positive number of simplices.

Parameters

rep	a text-based representation of a facet pairing, as produced by routine toTextRep().

Returns: the corresponding facet pairing.

◆ isCanonical()

template<int dim>

bool regina::detail::FacetPairingBase< dim >::isCanonical ( ) const

Determines whether this facet pairing is in canonical form, i.e., is a lexicographically minimal representative of its isomorphism class.

Isomorphisms of facet pairings correspond to relabellings of simplices and relabellings of the (dim + 1) facets within each simplex.

Facet pairings are ordered by lexicographical comparison of dest(0,0), dest(0,1), ..., dest(size()-1,dim).

Precondition: This facet pairing is connected, i.e., it is possible to reach any simplex from any other simplex via a series of matched facet pairs.

Returns: true if and only if this facet pairing is in canonical form.

◆ isCanonicalInternal()

template<int dim>

bool regina::detail::FacetPairingBase< dim >::isCanonicalInternal ( IsoList & list ) const

protected

Determines whether this facet pairing is in canonical (smallest lexicographical) form, given a small set of assumptions.

If this facet pairing is in canonical form, the given list will be filled with the set of all combinatorial automorphisms of this facet pairing. If not, the given list will be left empty.

Precondition: The given list is empty.; For each simplex t, the only case in which dest(t,i) is greater than dest(t,i+1) is where facets (t,i) and (t,i+1) are paired together.; For each simplex t > 0, it is true that dest(t,0).simp < t.; The sequence dest(1,0), dest(2,0), ..., dest(n-1,0) is strictly increasing, where n is the total number of simplices under investigation.

Parameters

list	the list into which automorphisms will be placed if appropriate.

Returns: true if and only if this facet pairing is in canonical form.

◆ isClosed()

template<int dim>

bool regina::detail::FacetPairingBase< dim >::isClosed ( ) const

Determines whether this facet pairing is closed.

A closed facet pairing has no unmatched facets.

◆ isUnmatched() [1/2]

template<int dim>

bool regina::detail::FacetPairingBase< dim >::isUnmatched ( const FacetSpec< dim > & source ) const

inline

Determines whether the given simplex facet has been left deliberately unmatched.

Precondition: The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).

Parameters

source the facet under investigation.

Returns: true if the given facet has been left unmatched, or false if the given facet is paired with some other facet.

◆ isUnmatched() [2/2]

template<int dim>

bool regina::detail::FacetPairingBase< dim >::isUnmatched	(	size_t	simp,
		unsigned	facet
	)		const

inline

Determines whether the given simplex facet has been left deliberately unmatched.

Parameters

simp	the simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facet	the facet of the given simplex under investigation (between 0 and dim inclusive).

Returns: true if the given facet has been left unmatched, or false if the given facet is paired with some other facet.

◆ noDest() [1/2]

template<int dim>

bool regina::detail::FacetPairingBase< dim >::noDest ( const FacetSpec< dim > & source ) const

inlineprotected

Determines whether the matching for the given simplex facet has not yet been determined.

This is signalled by a facet matched to itself.

Precondition: The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).

Parameters

source the facet under investigation.

Returns: true if the matching for the given facet has not yet been determined, or false otherwise.

◆ noDest() [2/2]

template<int dim>

bool regina::detail::FacetPairingBase< dim >::noDest	(	size_t	simp,
		unsigned	facet
	)		const

inlineprotected

Determines whether the matching for the given simplex facet has not yet been determined.

This is signalled by a facet matched to itself.

Parameters

simp	the simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facet	the facet of the given simplex under investigation (between 0 and dim inclusive).

Returns: true if the matching for the given facet has not yet been determined, or false otherwise.

◆ operator!=()

template<int dim>

bool regina::detail::FacetPairingBase< dim >::operator!= ( const FacetPairing< dim > & other ) const

Determines if this and the given facet pairing are not identical.

Parameters

other the facet pairing to compare with this.

Returns: true if and only if this and the given facet pairing are not identical.

◆ operator=() [1/2]

template<int dim>

FacetPairingBase< dim > & regina::detail::FacetPairingBase< dim >::operator= ( const FacetPairingBase< dim > & src )

inline

Copies the given facet pairing into this facet pairing.

It does not matter if this and the given facet pairing use different numbers of top-dimensional simpilices; if they do then this facet pairing will be resized accordingly.

This operator induces a deep copy of src.

Parameters

src	the facet pairing to copy.

Returns: a reference to this facet pairing.

◆ operator=() [2/2]

template<int dim>

FacetPairingBase< dim > & regina::detail::FacetPairingBase< dim >::operator= ( FacetPairingBase< dim > && src )

inlinenoexcept

Moves the given facet pairing into this facet pairing.

This is a fast (constant time) operation.

It does not matter if this and the given facet pairing use different numbers of top-dimensional simpilices; if they do then this facet pairing will be resized accordingly.

The facet pairing that is passed (src) will no longer be usable.

Parameters

src	the facet pairing to move.

Returns: a reference to this facet pairing.

◆ operator==()

template<int dim>

bool regina::detail::FacetPairingBase< dim >::operator== ( const FacetPairing< dim > & other ) const

Determines if this and the given facet pairing are identical.

Parameters

other the facet pairing to compare with this.

Returns: true if and only if this and the given facet pairing are identical.

◆ operator[]() [1/2]

template<int dim>

FacetSpec< dim > & regina::detail::FacetPairingBase< dim >::operator[] ( const FacetSpec< dim > & source )

inlineprotected

Returns the other facet to which the given simplex facet is paired.

This is a convenience operator whose behaviour is identical to that of dest(const FacetSpec<dim>&).

If the given facet is left deliberately unmatched, the value returned will be boundary (as returned by FacetSpec<dim>::isBoundary()).

Precondition: The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).

Parameters

source the facet under investigation.

Returns: the other facet to which the given facet is paired.

◆ operator[]() [2/2]

template<int dim>

const FacetSpec< dim > & regina::detail::FacetPairingBase< dim >::operator[] ( const FacetSpec< dim > & source ) const

inline

Returns the other facet to which the given simplex facet is paired.

This is a convenience operator whose behaviour is identical to that of dest(const FacetSpec<dim>&).

If the given facet is left deliberately unmatched, the value returned will be boundary (as returned by FacetSpec<dim>::isBoundary()).

Precondition: The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).

Python: This routine returns by value, not by reference, since Python cannot enforce constness otherwise.

Parameters

source the facet under investigation.

Returns: the other facet to which the given facet is paired.

◆ size()

template<int dim>

size_t regina::detail::FacetPairingBase< dim >::size

inline

Returns the number of simplices whose facets are described by this facet pairing.

Returns: the number of simplices under consideration.

◆ str()

template<class T , bool supportsUtf8 = false>

std::string regina::Output< T, supportsUtf8 >::str ( ) const

inherited

Returns a short text representation of this object.

This text should be human-readable, should use plain ASCII characters where possible, and should not contain any newlines.

Within these limits, this short text ouptut should be as information-rich as possible, since in most cases this forms the basis for the Python str() and repr() functions.

Python: The Python "stringification" function str() will use precisely this function, and for most classes the Python repr() function will incorporate this into its output.

Returns: a short text representation of this object.

◆ swap()

template<int dim>

void regina::detail::FacetPairingBase< dim >::swap ( FacetPairingBase< dim > & other )

inlinenoexcept

Swaps the contents of this and the given facet pairing.

Parameters

other the facet pairing whose contents are to be swapped with this.

◆ toTextRep()

template<int dim>

std::string regina::detail::FacetPairingBase< dim >::toTextRep ( ) const

Returns a text-based representation of this facet pairing that can be used to reconstruct the facet pairing.

This reconstruction is done through routine fromTextRep().

The text produced is not particularly readable; for a human-readable text representation, see routine str() instead.

The string returned will contain no newlines.

Returns: a text-based representation of this facet pairing.

◆ utf8()

template<class T , bool supportsUtf8 = false>

std::string regina::Output< T, supportsUtf8 >::utf8 ( ) const

inherited

Returns a short text representation of this object using unicode characters.

Like str(), this text should be human-readable, should not contain any newlines, and (within these constraints) should be as information-rich as is reasonable.

Unlike str(), this function may use unicode characters to make the output more pleasant to read. The string that is returned will be encoded in UTF-8.

Returns: a short text representation of this object.

◆ writeDot()

template<int dim>

void regina::detail::FacetPairingBase< dim >::writeDot	(	std::ostream &	out,
		const char *	prefix = `nullptr`,
		bool	subgraph = `false`,
		bool	labels = `false`
	)		const

Writes the graph corresponding to this facet pairing in the Graphviz DOT language.

Every vertex of this graph represents a simplex, and every edge represents a pair of simplex facets that are joined together. Note that for a closed triangulation this graph will be entirely (dim + 1)-valent; for triangulations with boundary facets, some graph vertices will have degree dim or less.

The graph can either be written as a complete DOT graph, or as a clustered subgraph within some larger DOT graph (according to whether the argument subgraph is passed as false or true).

If a complete DOT graph is being written, the output may be used as a standalone DOT file ready for use with Graphviz.

If a subgraph is being written, the output will contain a single subgraph section that should be inserted into some larger DOT file. Note that the output generated by writeDotHeader(), followed by one or more subgraphs and then a closing curly brace will suffice. The subgraph name will begin with the string pairing_.

The argument prefix will be prepended to the name of each graph vertex, and will also be used in the name of the graph or subgraph. Using unique prefixes becomes important if you are calling writeDot() several times to generate several subgraphs for use in a single DOT file. If the prefix argument is null or empty then a default prefix will be used.

Note that this routine generates undirected graphs, not directed graphs. The final DOT file should be used with either the neato or fdp programs shipped with Graphviz.

Python: Not present; instead use the variant dot() that returns a string.

Parameters

out	the output stream to which to write.
prefix	a string to prepend to the name of each graph vertex, and to include in the graph or subgraph name; see above for details.
subgraph	`false` if a complete standalone DOT graph should be output, or `true` if a clustered subgraph should be output for use in some larger DOT file.
labels	indicates whether graph vertices will be labelled with the corresponding simplex numbers. This feature is currently experimental, and the default is `false`.

See also: http://www.graphviz.org/

◆ writeDotHeader()

template<int dim>

static void regina::detail::FacetPairingBase< dim >::writeDotHeader	(	std::ostream &	out,
		const char *	graphName = `nullptr`
	)

static

Writes header information for a Graphviz DOT file that will describe the graphs for one or more facet pairings.

See the writeDot() documentation for further information on such graphs.

The output will be in the Graphviz DOT language, and will include appropriate display settings for graphs, edges and nodes. The opening brace for a graph section of the DOT file is included.

This routine may be used with writeDot() to generate a single DOT file containing the graphs for several different facet pairings. A complete DOT file can be produced by calling this routine, then calling writeDot() in subgraph mode for each facet pairing, then outputting a final closing curly brace.

Note that if you require a DOT file containing the graph for only a single facet pairing, this routine is unnecessary; you may simply call writeDot() in full graph mode instead.

This routine is suitable for generating undirected graphs, not directed graphs. The final DOT file should be used with either the neato or fdp programs shipped with Graphviz.

Python: Not present; instead use the variant dotHeader() that returns a string.

Parameters

out	the output stream to which to write.
graphName	the name of the graph in the DOT file. If this is null or empty then a default graph name will be used.

See also: http://www.graphviz.org/

◆ writeTextLong()

void regina::ShortOutput< FacetPairingBase< dim > , false >::writeTextLong ( std::ostream & out ) const

inlineinherited

A default implementation for detailed output.

This routine simply calls T::writeTextShort() and appends a final newline.

Python: Not present; instead you can call detail() from the subclass T, which returns this output as a string.

Parameters

out	the output stream to which to write.

◆ writeTextShort()

template<int dim>

void regina::detail::FacetPairingBase< dim >::writeTextShort ( std::ostream & out ) const

Writes a human-readable representation of this facet pairing to the given output stream.

The string returned will contain no newlines.

Python: Not present; use str() instead.

Parameters

out	the output stream to which to write.

Member Data Documentation

◆ pairs_

template<int dim>

FacetSpec<dim>* regina::detail::FacetPairingBase< dim >::pairs_

protected

The other facet to which each simplex facet is paired.

If a simplex facet is left unmatched, the corresponding element of this array will be boundary (as returned by FacetSpec<dim>::isBoundary()). If the destination for a particular facet has not yet been decided, the facet will be paired to itself.

◆ size_

template<int dim>

size_t regina::detail::FacetPairingBase< dim >::size_

protected

The number of simplices under consideration.

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

triangulation/detail/facetpairing.h

Public Types

Public Member Functions

Protected Attributes

Input and Output

Detailed Description

Member Typedef Documentation

◆ IsoList

Constructor & Destructor Documentation

◆ FacetPairingBase() [1/5]

◆ FacetPairingBase() [2/5]

◆ FacetPairingBase() [3/5]

◆ FacetPairingBase() [4/5]

◆ ~FacetPairingBase()

◆ FacetPairingBase() [5/5]

Member Function Documentation

◆ dest() [1/4]

◆ dest() [2/4]

◆ dest() [3/4]

◆ dest() [4/4]

◆ detail()

◆ dot()

◆ dotHeader()

◆ findAllPairings()

◆ findAutomorphisms()

◆ fromTextRep()

◆ isCanonical()

◆ isCanonicalInternal()

◆ isClosed()

◆ isUnmatched() [1/2]

◆ isUnmatched() [2/2]

◆ noDest() [1/2]

◆ noDest() [2/2]

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

◆ str()

◆ swap()

◆ toTextRep()

◆ utf8()

◆ writeDot()

◆ writeDotHeader()

◆ writeTextLong()

◆ writeTextShort()

Member Data Documentation

◆ pairs_

◆ size_