Regina Calculation Engine
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
regina::GluingPermSearcher< 2 > Class Reference

A utility class for searching through all possible gluing permutation sets that correspond to a given triangle edge pairing. More...

#include <census/gluingpermsearcher2.h>

Inheritance diagram for regina::GluingPermSearcher< 2 >:
regina::GluingPerms< 2 >

Public Types

typedef void(* Use) (const GluingPermSearcher< 2 > *, void *)
 A routine that can do arbitrary processing upon a set of gluing permutations. More...
 

Public Member Functions

 GluingPermSearcher (const FacetPairing< 2 > *pairing, const FacetPairing< 2 >::IsoList *autos, bool orientableOnly, GluingPermSearcher< 2 >::Use use, void *useArgs=0)
 Initialises a new search for gluing permutation sets. More...
 
 GluingPermSearcher (std::istream &in, GluingPermSearcher< 2 >::Use use, void *useArgs=0)
 Initialises a new search manager based on data read from the given input stream. More...
 
virtual ~GluingPermSearcher ()
 Destroys this search manager and all supporting data structures. More...
 
virtual void runSearch (long maxDepth=-1)
 Generates all possible gluing permutation sets that satisfy the current search criteria. More...
 
bool completePermSet () const
 Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state. More...
 
void dumpTaggedData (std::ostream &out) const
 Dumps all internal data in a plain text format, along with a marker to signify which precise class the data belongs to. More...
 
virtual void dumpData (std::ostream &out) const override
 Dumps all internal data in a plain text format to the given output stream. More...
 
 GluingPermSearcher (const GluingPermSearcher &)=delete
 
bool inputError () const
 Was an error found during construction from an input stream? More...
 
unsigned size () const
 Returns the total number of simplices under consideration. More...
 
const FacetPairing< dim > * facetPairing () const
 Returns the specific pairing of simplex facets that this set of gluing permutations complements. More...
 
Perm< dim+1 > gluingPerm (const FacetSpec< dim > &source) const
 Returns the gluing permutation associated with the given simplex facet. More...
 
Perm< dim+1 > gluingPerm (unsigned simp, unsigned facet) const
 Returns the gluing permutation associated with the given simplex facet. More...
 
Triangulation< dim > * triangulate () const
 Returns a newly created triangulation as modelled by this set of gluing permutations and the associated simplex facet pairing. More...
 

Static Public Member Functions

static void findAllPerms (const FacetPairing< 2 > *pairing, const FacetPairing< 2 >::IsoList *autos, bool orientableOnly, GluingPermSearcher< 2 >::Use use, void *useArgs=0)
 The main entry routine for running a search for all gluing permutation sets that complement a given edge pairing. More...
 
static GluingPermSearcher< 2 > * bestSearcher (const FacetPairing< 2 > *pairing, const FacetPairing< 2 >::IsoList *autos, bool orientableOnly, GluingPermSearcher< 2 >::Use use, void *useArgs=0)
 Constructs a search manager of the best possible class for the given search parameters. More...
 
static GluingPermSearcher< 2 > * readTaggedData (std::istream &in, GluingPermSearcher< 2 >::Use use, void *useArgs=0)
 Creates a new search manager based on tagged data read from the given input stream. More...
 

Static Public Attributes

static const char dataTag_
 A character used to identify this class when reading and writing tagged data in text format. More...
 

Protected Member Functions

bool isCanonical () const
 Compares the current set of gluing permutations with its preimage under each automorphism of the underlying edge pairing, in order to see whether the current set is in canonical form (i.e., is lexicographically smallest). More...
 
virtual char dataTag () const
 Returns the character used to identify this class when storing tagged data in text format. More...
 
int & permIndex (const FacetSpec< dim > &source)
 Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner. More...
 
int & permIndex (unsigned simp, unsigned facet)
 Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner. More...
 
const int & permIndex (const FacetSpec< dim > &source) const
 Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner. More...
 
const int & permIndex (unsigned simp, unsigned facet) const
 Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner. More...
 
int gluingToIndex (const FacetSpec< dim > &source, const Perm< dim+1 > &gluing) const
 Returns the index into array Perm<dim+1>::Sn_1 corresponding to the given gluing permutation from the given facet to its partner. More...
 
int gluingToIndex (unsigned simp, unsigned facet, const Perm< dim+1 > &gluing) const
 Returns the index into array Perm<dim+1>::Sn_1 corresponding to the given gluing permutation from the given facet to its partner. More...
 
Perm< dim+1 > indexToGluing (const FacetSpec< dim > &source, int index) const
 Returns the gluing permutation from the given facet to its partner that corresponds to the given index into array Perm<dim+1>::Sn_1. More...
 
Perm< dim+1 > indexToGluing (unsigned simp, unsigned facet, int index) const
 Returns the gluing permutation from the given facet to its partner that corresponds to the given index into array Perm<dim+1>::Sn_1. More...
 

Protected Attributes

const FacetPairing< 2 >::IsoList * autos_
 The set of isomorphisms that define equivalence of gluing permutation sets. More...
 
bool autosNew
 Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)? More...
 
bool orientableOnly_
 Are we only searching for gluing permutations that correspond to orientable triangulations? More...
 
GluingPermSearcher< 2 >::Use use_
 A routine to call each time a gluing permutation set is found during the search. More...
 
void * useArgs_
 Additional user-supplied data to be passed as the second argument to the use_ routine. More...
 
bool started
 Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search. More...
 
int * orientation
 Keeps track of the orientation of each triangle in the underlying triangulation. More...
 
FacetSpec< 2 > * order
 Describes the order in which gluing permutations are assigned to edges. More...
 
int orderSize
 The total number of edges in the edge pairing graph, i.e., the number of elements of interest in the order[] array. More...
 
int orderElt
 Marks which element of order[] we are currently examining at this stage of the search. More...
 
const FacetPairing< dim > * pairing_
 The facet pairing that this permutation set complements. More...
 
int * permIndices_
 The index into array Perm<dim+1>::Sn_1 describing how each simplex facet is glued to its partner. More...
 
bool inputError_
 Has an error occurred during construction from an input stream? More...
 

Detailed Description

A utility class for searching through all possible gluing permutation sets that correspond to a given triangle edge pairing.

In the future, there may be subclasses of GluingPermSearcher<2> that correspond to specialised search algorithms for use in certain scenarios. The main class GluingPermSearcher<2> offers a default search algorithm that may be used in a general context.

The simplest way of performing a search through all possible gluing permutations is by calling the static method findAllPerms(). This will examine the search parameters and ensure that the best possible algorithm is used. For finer control over the program flow, the static method bestSearcher() can be used to create a search manager of the most suitable class and then runSearch() can be called on this object directly. For absolute control, a specific algorithm can be forced by explicitly constructing an object of the corresponding class (and again calling runSearch() on that object directly).

Note that this class derives from GluingPerms<2>. The search will involve building and repeatedly modifying the inherited GluingPerms<2> data in-place.

Python
Not present.

Member Function Documentation

◆ facetPairing()

const FacetPairing< dim > * regina::GluingPerms< dim >::facetPairing
inlineinherited

Returns the specific pairing of simplex facets that this set of gluing permutations complements.

Returns
the corresponding simplex facet pairing.

◆ gluingPerm() [1/2]

Perm< dim+1 > regina::GluingPerms< dim >::gluingPerm ( const FacetSpec< dim > &  source) const
inlineinherited

Returns the gluing permutation associated with the given simplex facet.

Precondition
The given facet is actually paired with some other facet in the underlying pairwise matching (see routine facetPairing()).
The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).
Parameters
sourcethe simplex facet under investigation.
Returns
the associated gluing permutation.

◆ gluingPerm() [2/2]

Perm< dim+1 > regina::GluingPerms< dim >::gluingPerm ( unsigned  simp,
unsigned  facet 
) const
inlineinherited

Returns the gluing permutation associated with the given simplex facet.

Precondition
The given facet is actually paired with some other facet in the underlying pairwise matching (see routine facetPairing()).
Parameters
simpthe simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facetthe facet of the given simplex under investigation (between 0 and dim inclusive).
Returns
the associated gluing permutation.

◆ gluingToIndex() [1/2]

int regina::GluingPerms< dim >::gluingToIndex ( const FacetSpec< dim > &  source,
const Perm< dim+1 > &  gluing 
) const
protectedinherited

Returns the index into array Perm<dim+1>::Sn_1 corresponding to the given gluing permutation from the given facet to its partner.

This need not be the index into Perm<dim+1>::Sn_1 that is currently stored for the given facet.

Indices into array Perm<dim+1>::Sn_1 are stored internally in the array permIndices_. Full gluing permutations on the other hand are used in constructing triangulations.

Precondition
The given simplex facet has a partner according to the underlying facet pairing, i.e., is not a boundary facet.
If the given simplex facet and its partner are facets x and y of their respective simplices, then the given gluing permutation maps x to y.
Parameters
sourcethe simplex facet under investigation.
gluinga possible gluing permutation from the given simplex facet to its partner according to the underlying facet pairing.
Returns
the index into Perm<dim+1>::Sn_1 corresponding to the given gluing permutation; this will be between 0 and dim!-1 inclusive.

◆ gluingToIndex() [2/2]

int regina::GluingPerms< dim >::gluingToIndex ( unsigned  simp,
unsigned  facet,
const Perm< dim+1 > &  gluing 
) const
protectedinherited

Returns the index into array Perm<dim+1>::Sn_1 corresponding to the given gluing permutation from the given facet to its partner.

This need not be the index into Perm<dim+1>::Sn_1 that is currently stored for the given facet.

Indices into array Perm<dim+1>::Sn_1 are stored internally in the array permIndices_. Full gluing permutations on the other hand are used in constructing triangulations.

Precondition
The given simplex facet has a partner according to the underlying facet pairing, i.e., is not a boundary facet.
If the given simplex facet and its partner are facets x and y of their respective simplices, then the given gluing permutation maps x to y.
Parameters
simpthe simplex under investigation; this must be strictly less than the total number of simplices under consideration.
facetthe facet of the given simplex under investigation; this must be between 0 and dim inclusive.
gluinga possible gluing permutation from the given simplex facet to its partner according to the underlying facet pairing.
Returns
the index into Perm<dim+1>::Sn_1 corresponding to the given gluing permutation; this will be between 0 and dim!-1 inclusive.

◆ indexToGluing() [1/2]

Perm< dim+1 > regina::GluingPerms< dim >::indexToGluing ( const FacetSpec< dim > &  source,
int  index 
) const
inlineprotectedinherited

Returns the gluing permutation from the given facet to its partner that corresponds to the given index into array Perm<dim+1>::Sn_1.

This index into Perm<dim+1>::Sn_1 need not be the index that is currently stored for the given facet.

Indices into array Perm<dim+1>::Sn_1 are stored internally in the array permIndices_. Full gluing permutations on the other hand are used in constructing triangulations.

If the given simplex facet and its partner according to the underlying facet pairing are facets x and y of their respective simplices, then the resulting gluing permutation will map x to y.

Precondition
The given simplex facet has a partner according to the underlying facet pairing, i.e., is not a boundary facet.
Parameters
sourcethe simplex facet under investigation.
indexan index into Perm<dim+1>::Sn_1; this must be between 0 and dim!-1 inclusive.
Returns
the gluing permutation corresponding to the given index into Perm<dim+1>::Sn_1.

◆ indexToGluing() [2/2]

Perm< dim+1 > regina::GluingPerms< dim >::indexToGluing ( unsigned  simp,
unsigned  facet,
int  index 
) const
inlineprotectedinherited

Returns the gluing permutation from the given facet to its partner that corresponds to the given index into array Perm<dim+1>::Sn_1.

This index into Perm<dim+1>::Sn_1 need not be the index that is currently stored for the given facet.

Indices into array Perm<dim+1>::Sn_1 are stored internally in the array permIndices_. Full gluing permutations on the other hand are used in constructing triangulations.

If the given simplex facet and its partner according to the underlying facet pairing are facets x and y of their respective simplices, then the resulting gluing permutation will map x to y.

Precondition
The given simplex facet has a partner according to the underlying facet pairing, i.e., is not a boundary facet.
Parameters
simpthe simplex under investigation; this must be strictly less than the total number of simplices under consideration.
facetthe facet of the given simplex under investigation; this must be between 0 and dim inclusive.
indexan index into Perm<dim+1>::Sn_1; this must be between 0 and dim!-1 inclusive.
Returns
the gluing permutation corresponding to the given index into Perm<dim+1>::Sn_1.

◆ inputError()

bool regina::GluingPerms< dim >::inputError
inlineinherited

Was an error found during construction from an input stream?

This routine returns true if an input stream constructor was used to create this object but the data in the input stream was invalid or incorrectly formatted.

If a different constructor was called (i.e., no input stream was used), then this routine will always return false.

Returns
true if an error occurred during construction from an input stream, or false otherwise.

◆ permIndex() [1/4]

int & regina::GluingPerms< dim >::permIndex ( const FacetSpec< dim > &  source)
inlineprotectedinherited

Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner.

Note that this permutation is not a gluing permutation as such, but rather a permutation of 0,...,dim-1 only. For a real facet gluing permutation, see routine gluingPerm().

Precondition
The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).
Parameters
sourcethe simplex facet under investigation.
Returns
a reference to the corresponding array index.

◆ permIndex() [2/4]

const int & regina::GluingPerms< dim >::permIndex ( const FacetSpec< dim > &  source) const
inlineprotectedinherited

Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner.

Note that this permutation is not a gluing permutation as such, but rather a permutation of 0,...,dim-1 only. For a real facet gluing permutation, see routine gluingPerm().

Precondition
The given facet is a real simplex facet (not boundary, before-the-start or past-the-end).
Parameters
sourcethe simplex facet under investigation.
Returns
a reference to the corresponding array index.

◆ permIndex() [3/4]

int & regina::GluingPerms< dim >::permIndex ( unsigned  simp,
unsigned  facet 
)
inlineprotectedinherited

Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner.

Note that this permutation is not a gluing permutation as such, but rather a permutation of 0,...,dim-1 only. For a real facet gluing permutation, see routine gluingPerm().

Parameters
simpthe simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facetthe facet of the given simplex under investigation (between 0 and dim inclusive).
Returns
a reference to the corresponding array index.

◆ permIndex() [4/4]

const int & regina::GluingPerms< dim >::permIndex ( unsigned  simp,
unsigned  facet 
) const
inlineprotectedinherited

Returns the index into array Perm<dim+1>::Sn_1 describing how the the given facet is joined to its partner.

Note that this permutation is not a gluing permutation as such, but rather a permutation of 0,...,dim-1 only. For a real facet gluing permutation, see routine gluingPerm().

Parameters
simpthe simplex under investigation (this must be strictly less than the total number of simplices under consideration).
facetthe facet of the given simplex under investigation (between 0 and dim inclusive).
Returns
a reference to the corresponding array index.

◆ size()

unsigned regina::GluingPerms< dim >::size
inlineinherited

Returns the total number of simplices under consideration.

Returns
the number of simplices under consideration.

◆ triangulate()

Triangulation<dim>* regina::GluingPerms< dim >::triangulate ( ) const
inherited

Returns a newly created triangulation as modelled by this set of gluing permutations and the associated simplex facet pairing.

Each matched pair of facets and their associated permutations will be realised as two simplex facets in the triangulation glued together with the corresponding gluing permutation. Each unmatched facet will be realised as a boundary facet in the triangulation.

It is the responsibility of the caller of this routine to delete this triangulation once it is no longer required.

Returns
a newly created triangulation modelled by this structure.

Member Data Documentation

◆ inputError_

bool regina::GluingPerms< dim >::inputError_
protectedinherited

Has an error occurred during construction from an input stream?

◆ pairing_

const FacetPairing<dim>* regina::GluingPerms< dim >::pairing_
protectedinherited

The facet pairing that this permutation set complements.

This is guaranteed to be the minimal representative of its facet pairing isomorphism class.

◆ permIndices_

int* regina::GluingPerms< dim >::permIndices_
protectedinherited

The index into array Perm<dim+1>::Sn_1 describing how each simplex facet is glued to its partner.

Note that this is not a gluing permutation as such but rather a permutation of 0,...,dim-1 only (see the routines gluingToIndex() and indexToGluing() for conversions). If a permutation has not yet been selected (e.g., if this permutation set is still under construction) then this index is -1.


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

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