Census of Triangulations

## Classes

class | regina::CensusDB
| Stores the location and description of one of Regina's in-built census databases. More...
class | regina::CensusHit
| Stores a single "hit" indicating that some given triangulation has been located in one of Regina's in-built census databases. More...
class | regina::CensusHits
| Stores a list of "hits" indicating all the places in which a given triangulation has been located in Regina's various in-built census databases. More...
class | regina::Census
| A utility class used to search for triangulations across one or more 3-manifold census databases. More...
class | regina::GluingPerms< dim >
| Represents a specific set of gluing permutations to complement a particular pairwise matching of simplex facets. More...
class | regina::GluingPermSearcher< dim >
| A utility class used to build a census of triangulations, by searching through all possible sets of gluing permutations to match a given facet pairing. More...
class | regina::GluingPermSearcher< 2 >
| A utility class for searching through all possible gluing permutation sets that correspond to a given triangle edge pairing. More...
class | regina::GluingPermSearcher< 3 >
| A utility class for searching through all possible gluing permutation sets that correspond to a given tetrahedron face pairing. More...
struct | regina::EulerSearcher::TetVertexState
| A structure used to track equivalence classes of tetrahedron vertices as the gluing permutation set is constructed. More...
struct | regina::EulerSearcher::TetEdgeState
| A structure used to track equivalence classes of tetrahedron edges as the gluing permutation set is constructed. More...
class | regina::EulerSearcher
| A gluing permutation search class that offers a specialised search algorithm for when all vertex links must all have a given fixed Euler characteristic. More...
struct | regina::CompactSearcher::TetVertexState
| A structure used to track equivalence classes of tetrahedron vertices as the gluing permutation set is constructed. More...
struct | regina::CompactSearcher::TetEdgeState
| A structure used to track equivalence classes of tetrahedron edges as the gluing permutation set is constructed. More...
class | regina::CompactSearcher
| A gluing permutation search class that offers a specialised search algorithm for when only compact (finite) 3-manifold triangulations are required. More...
class | regina::ClosedPrimeMinSearcher
| A gluing permutation search class that offers a specialised search algorithm for when (i) only closed prime minimal P2-irreducible triangulations are required, and (ii) the given face pairing has order at least three. More...
class | regina::HyperbolicMinSearcher
| A gluing permutation search class that offers a specialised search algorithm for when only minimal ideal triangulations of cusped finite-volume hyperbolic 3-manifolds are required. More...
struct | regina::GluingPermSearcher< 4 >::PentEdgeState
| A structure used to track equivalence classes of pentachoron edges as the gluing permutation set is constructed. More...
struct | regina::GluingPermSearcher< 4 >::PentTriangleState
| A structure used to track equivalence classes of pentachoron triangles as the gluing permutation set is constructed. More...
class | regina::GluingPermSearcher< 4 >
| A utility class for searching through all possible gluing permutation sets that correspond to a given pentachoron facet pairing. More...

## Typedefs

typedef CensusDB | regina::NCensusDB
| Deprecated typedef for backward compatibility. More...
typedef CensusHit | regina::NCensusHit
| Deprecated typedef for backward compatibility. More...
typedef CensusHits | regina::NCensusHits
| Deprecated typedef for backward compatibility. More...
typedef Census | regina::NCensus
| Deprecated typedef for backward compatibility. More...
template<int dim>
using | regina::NGenericGluingPerms = GluingPerms< dim >
| Deprecated typedef for backward compatibility. More...
typedef GluingPerms< 2 > | regina::Dim2GluingPerms
| Deprecated typedef for backward compatibility. More...
typedef GluingPerms< 3 > | regina::NGluingPerms
| Deprecated typedef for backward compatibility. More...
typedef GluingPerms< 4 > | regina::Dim4GluingPerms
| Deprecated typedef for backward compatibility. More...
typedef void(* | regina::GluingPermSearcher< 2 >::Use) (const GluingPermSearcher< 2 > *, void *)
| A routine that can do arbitrary processing upon a set of gluing permutations. More...
typedef GluingPermSearcher< 2 > | regina::Dim2GluingPermSearcher
| Deprecated typedef for backward compatibility. More...
typedef GluingPermSearcher< 2 >::Use | regina::UseDim2GluingPerms
| Deprecated typedef for backward compatibility. More...
typedef void(* | regina::GluingPermSearcher< 3 >::Use) (const GluingPermSearcher< 3 > *, void *)
| A routine that can do arbitrary processing upon a set of gluing permutations. More...
typedef GluingPermSearcher< 3 > | regina::NGluingPermSearcher
| Deprecated typedef for backward compatibility. More...
typedef GluingPermSearcher< 3 >::Use | regina::UseGluingPerms
| Deprecated typedef for backward compatibility. More...
typedef EulerSearcher | regina::NEulerSearcher
| Deprecated typedef for backward compatibility. More...
typedef CompactSearcher | regina::NCompactSearcher
| Deprecated typedef for backward compatibility. More...
typedef ClosedPrimeMinSearcher | regina::NClosedPrimeMinSearcher
| Deprecated typedef for backward compatibility. More...
typedef HyperbolicMinSearcher | regina::NHyperbolicMinSearcher
| Deprecated typedef for backward compatibility. More...
typedef void(* | regina::GluingPermSearcher< 4 >::Use) (const GluingPermSearcher< 4 > *, void *)
| A routine that can do arbitrary processing upon a set of gluing permutations. More...
typedef GluingPermSearcher< 4 > | regina::Dim4GluingPermSearcher
| Deprecated typedef for backward compatibility. More...
typedef GluingPermSearcher< 4 >::Use | regina::UseDim4GluingPerms
| Deprecated typedef for backward compatibility. More...

## Enumerations

enum | regina::GluingPermSearcher< 3 >::PurgeFlags { regina::GluingPermSearcher< 3 >::PURGE_NONE = 0, regina::GluingPermSearcher< 3 >::PURGE_NON_MINIMAL = 1, regina::GluingPermSearcher< 3 >::PURGE_NON_PRIME = 2, regina::GluingPermSearcher< 3 >::PURGE_NON_MINIMAL_PRIME = 3, regina::GluingPermSearcher< 3 >::PURGE_NON_MINIMAL_HYP = 9, regina::GluingPermSearcher< 3 >::PURGE_P2_REDUCIBLE = 4 }
| Flags to indicate that our enumeration may (at the discretion of the enumeration algorithm) ignore certain classes of triangulations. More...
enum | { regina::EulerSearcher::VLINK_JOIN_INIT = -1, regina::EulerSearcher::VLINK_JOIN_HANDLE = -2, regina::EulerSearcher::VLINK_JOIN_BRIDGE = -3, regina::EulerSearcher::VLINK_JOIN_TWIST = -4 }
| Constants used in the vertexStateChanged array to indicate how a partial vertex link becomes glued to itself along two of its boundary edges. More...

## Functions

| regina::CensusDB::CensusDB (const std::string &filename, const std::string &desc)
| Creates a new reference to one of Regina's census databases. More...
const std::string & | regina::CensusDB::filename () const
| Returns the filename where this database is stored. More...
const std::string & | regina::CensusDB::desc () const
| Returns a human-readable description of this database. More...
bool | regina::CensusDB::lookup (const std::string &isoSig, CensusHits *hits) const
| Searches for the given isomorphism signature in this database. More...
const std::string & | regina::CensusHit::name () const
| Returns the human-readable name associated with the triangulation in the database. More...
const CensusDB * | regina::CensusHit::db () const
| Returns details of the census database in which the triangulation was found. More...
const CensusHit * | regina::CensusHit::next () const
| Returns the next hit for the same triangulation, or 0 if there are no more hits. More...
| regina::CensusHits::CensusHits ()
| Constructs an empty set of hits. More...
| regina::CensusHits::~CensusHits ()
| Destroys this object and all of the individual CensusHit objects that it contains. More...
CensusHit * | regina::CensusHits::first () const
| Returns the first hit in this list. More...
size_t | regina::CensusHits::count () const
| Returns the total number of hits in this list. More...
bool | regina::CensusHits::empty () const
| Returns whether there are any hits at all. More...
void | regina::CensusHits::append (CensusHit *hit)
| Appends a new hit to the end of this list. More...
static CensusHits * | regina::Census::lookup (const Triangulation< 3 > &tri)
| Searches for the given triangulation through all of Regina's in-built census databases. More...
static CensusHits * | regina::Census::lookup (const std::string &isoSig)
| Searches for the given triangulation through all of Regina's in-built census databases. More...
| regina::GluingPerms< dim >::GluingPerms (const GluingPerms< dim > &cloneMe)
| Creates a new set of gluing permutations that is a clone of the given permutation set. More...
| regina::GluingPerms< dim >::GluingPerms (std::istream &in)
| Reads a new set of gluing permutations from the given input stream. More...
virtual | regina::GluingPerms< dim >::~GluingPerms ()
| Deallocates any memory used by this structure. More...
bool | regina::GluingPerms< dim >::inputError () const
| Was an error found during construction from an input stream? More...
unsigned | regina::GluingPerms< dim >::size () const
| Returns the total number of simplices under consideration. More...
const FacetPairing< dim > * | regina::GluingPerms< dim >::facetPairing () const
| Returns the specific pairing of simplex facets that this set of gluing permutations complements. More...
Perm< dim+1 > | regina::GluingPerms< dim >::gluingPerm (const FacetSpec< dim > &source) const
| Returns the gluing permutation associated with the given simplex facet. More...
Perm< dim+1 > | regina::GluingPerms< dim >::gluingPerm (unsigned simp, unsigned facet) const
| Returns the gluing permutation associated with the given simplex facet. More...
Triangulation< dim > * | regina::GluingPerms< dim >::triangulate () const
| Returns a newly created triangulation as modelled by this set of gluing permutations and the associated simplex facet pairing. More...
virtual void | regina::GluingPerms< dim >::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
| regina::GluingPerms< dim >::GluingPerms (const FacetPairing< dim > *pairing)
| Creates a new permutation set. More...
int & | regina::GluingPerms< dim >::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 & | regina::GluingPerms< dim >::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 & | regina::GluingPerms< dim >::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 & | regina::GluingPerms< dim >::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 | regina::GluingPerms< dim >::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 | regina::GluingPerms< dim >::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 > | regina::GluingPerms< dim >::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 > | regina::GluingPerms< dim >::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...
| regina::GluingPermSearcher< 2 >::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...
| regina::GluingPermSearcher< 2 >::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 | regina::GluingPermSearcher< 2 >::~GluingPermSearcher ()
| Destroys this search manager and all supporting data structures. More...
virtual void | regina::GluingPermSearcher< 2 >::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
bool | regina::GluingPermSearcher< 2 >::completePermSet () const
| Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state. More...
void | regina::GluingPermSearcher< 2 >::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 | regina::GluingPermSearcher< 2 >::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
static void | regina::GluingPermSearcher< 2 >::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 > * | regina::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 > * | regina::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...
bool | regina::GluingPermSearcher< 2 >::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 | regina::GluingPermSearcher< 2 >::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
| regina::GluingPermSearcher< 3 >::GluingPermSearcher (const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, bool finiteOnly, int whichPurge, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Initialises a new search for gluing permutation sets. More...
| regina::GluingPermSearcher< 3 >::GluingPermSearcher (std::istream &in, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Initialises a new search manager based on data read from the given input stream. More...
virtual | regina::GluingPermSearcher< 3 >::~GluingPermSearcher ()
| Destroys this search manager and all supporting data structures. More...
virtual void | regina::GluingPermSearcher< 3 >::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
bool | regina::GluingPermSearcher< 3 >::completePermSet () const
| Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state. More...
void | regina::GluingPermSearcher< 3 >::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 | regina::GluingPermSearcher< 3 >::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
static void | regina::GluingPermSearcher< 3 >::findAllPerms (const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, bool finiteOnly, int whichPurge, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| The main entry routine for running a search for all gluing permutation sets that complement a given face pairing. More...
static GluingPermSearcher< 3 > * | regina::GluingPermSearcher< 3 >::bestSearcher (const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, bool finiteOnly, int whichPurge, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Constructs a search manager of the best possible class for the given search parameters. More...
static GluingPermSearcher< 3 > * | regina::GluingPermSearcher< 3 >::readTaggedData (std::istream &in, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Creates a new search manager based on tagged data read from the given input stream. More...
bool | regina::GluingPermSearcher< 3 >::isCanonical () const
| Compares the current set of gluing permutations with its preimage under each automorphism of the underlying face pairing, in order to see whether the current set is in canonical form (i.e., is lexicographically smallest). More...
bool | regina::GluingPermSearcher< 3 >::badEdgeLink (const FacetSpec< 3 > &face) const
| Determines whether the permutations already constructed model a triangulation with an edge identified with itself in reverse. More...
bool | regina::GluingPermSearcher< 3 >::lowDegreeEdge (const FacetSpec< 3 > &face, bool testDegree12, bool testDegree3) const
| Determines whether the permutations already constructed model a triangulation with a low degree edge. More...
virtual char | regina::GluingPermSearcher< 3 >::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
| regina::EulerSearcher::TetVertexState::TetVertexState ()
| Constructor for a standalone tetrahedron vertex in an equivalence class all of its own. More...
void | regina::EulerSearcher::TetVertexState::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
bool | regina::EulerSearcher::TetVertexState::readData (std::istream &in, unsigned long nStates)
| Fills this state with data read from the given input stream. More...
| regina::EulerSearcher::TetEdgeState::TetEdgeState ()
| Constructor for a standalone tetrahedron edge in an equivalence class all of its own. More...
void | regina::EulerSearcher::TetEdgeState::dumpData (std::ostream &out, unsigned nTets) const
| Dumps all internal data in a plain text format to the given output stream. More...
bool | regina::EulerSearcher::TetEdgeState::readData (std::istream &in, unsigned nTets)
| Fills this state with data read from the given input stream. More...
| regina::EulerSearcher::EulerSearcher (int useEuler, const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, int whichPurge, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Creates a new search manager that restricts Euler characteristic on the vertex links, as described in the class overview. More...
| regina::EulerSearcher::EulerSearcher (std::istream &in, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Initialises a new search manager based on data read from the given input stream. More...
virtual | regina::EulerSearcher::~EulerSearcher ()
| Destroys this search manager and all supporting data structures. More...
virtual void | regina::EulerSearcher::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
virtual void | regina::EulerSearcher::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
virtual char | regina::EulerSearcher::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
int | regina::EulerSearcher::findEdgeClass (int edgeID) const
| Returns the representative of the equivalence class containing the given tetrahedron edge. More...
int | regina::EulerSearcher::findEdgeClass (int edgeID, char &twisted) const
| Returns the representative of the equivalence class containing the given tetrahedron edge. More...
int | regina::EulerSearcher::mergeVertexClasses ()
| Merge the classes of tetrahedron vertices as required by the new gluing made at stage orderElt of the search. More...
bool | regina::EulerSearcher::mergeEdgeClasses ()
| Merge the classes of tetrahedron edges as required by the new gluing made at stage orderElt of the search. More...
void | regina::EulerSearcher::splitVertexClasses ()
| Split the classes of tetrahedron vertices to mirror the undoing of the gluing at stage orderElt of the search. More...
void | regina::EulerSearcher::splitEdgeClasses ()
| Split the classes of tetrahedron edges to mirror the undoing of the gluing at stage orderElt of the search. More...
void | regina::EulerSearcher::vtxBdryJoin (int vertexID, char end, int adjVertexID, char twist)
| Signifies that the boundary edges supplied by the vertex linking triangles for the two given tetrahedron vertices should be marked as adjacent. More...
void | regina::EulerSearcher::vtxBdryFixAdj (int vertexID)
| Adjusts the bdryNext and bdryTwist arrays for nearby tetrahedron vertices, to ensure that these arrays are consistent with the bdryNext and bdryTwist arrays stored with the given vertex. More...
void | regina::EulerSearcher::vtxBdryBackup (int vertexID)
| Copies the bdryNext and bdryTwist arrays to the bdryNextOld and bdryTwistOld arrays for the given tetrahedron vertex. More...
void | regina::EulerSearcher::vtxBdryRestore (int vertexID)
| Copies the bdryNextOld and bdryTwistOld arrays to the bdryNext and bdryTwist arrays for the given tetrahedron vertex. More...
void | regina::EulerSearcher::vtxBdryNext (int vertexID, int tet, int vertex, int bdryFace, int next[2], char twist[2])
| Assuming the given edge of the vertex linking triangle for the given tetrahedron vertex lies on the boundary of the vertex link, this routine identifies the adjacent boundary edges of the vertex link in each direction. More...
bool | regina::EulerSearcher::vtxBdryLength1 (int vertexID)
| Determines whether one of the edges of the vertex linking triangle for the given tetrahedron vertex in fact forms an entire one-edge boundary component of the overall vertex link. More...
bool | regina::EulerSearcher::vtxBdryLength2 (int vertexID1, int vertexID2)
| Determines whether edges of the vertex linking triangles for each of the given tetrahedron vertices combine to form an entire two-edge boundary component of the overall vertex link, with one edge from each triangle. More...
void | regina::EulerSearcher::vtxBdryConsistencyCheck ()
| Runs a number of tests on all tetrahedron vertices to locate consistency errors in the bdryEdges, bdryNext and bdryTwist members of the TetVertexState class. More...
void | regina::EulerSearcher::vtxBdryDump (std::ostream &out)
| Dumps a summary of bdryNext, bdryTwist and bdryEdges for every vertex of every tetrahedron to the given output stream. More...
| regina::CompactSearcher::TetVertexState::TetVertexState ()
| Constructor for a standalone tetrahedron vertex in an equivalence class all of its own. More...
void | regina::CompactSearcher::TetVertexState::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
bool | regina::CompactSearcher::TetVertexState::readData (std::istream &in, unsigned long nStates)
| Fills this state with data read from the given input stream. More...
| regina::CompactSearcher::TetEdgeState::TetEdgeState ()
| Constructor for a standalone tetrahedron edge in an equivalence class all of its own. More...
void | regina::CompactSearcher::TetEdgeState::dumpData (std::ostream &out, unsigned nTets) const
| Dumps all internal data in a plain text format to the given output stream. More...
bool | regina::CompactSearcher::TetEdgeState::readData (std::istream &in, unsigned nTets)
| Fills this state with data read from the given input stream. More...
| regina::CompactSearcher::CompactSearcher (const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, int whichPurge, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Creates a new search manager for use when only compact 3-manifold triangulations are required. More...
| regina::CompactSearcher::CompactSearcher (std::istream &in, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Initialises a new search manager based on data read from the given input stream. More...
virtual | regina::CompactSearcher::~CompactSearcher ()
| Destroys this search manager and all supporting data structures. More...
virtual void | regina::CompactSearcher::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
virtual void | regina::CompactSearcher::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
virtual char | regina::CompactSearcher::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
int | regina::CompactSearcher::findEdgeClass (int edgeID) const
| Returns the representative of the equivalence class containing the given tetrahedron edge. More...
int | regina::CompactSearcher::findEdgeClass (int edgeID, char &twisted) const
| Returns the representative of the equivalence class containing the given tetrahedron edge. More...
int | regina::CompactSearcher::mergeVertexClasses ()
| Merge the classes of tetrahedron vertices as required by the new gluing made at stage orderElt of the search. More...
bool | regina::CompactSearcher::mergeEdgeClasses ()
| Merge the classes of tetrahedron edges as required by the new gluing made at stage orderElt of the search. More...
void | regina::CompactSearcher::splitVertexClasses ()
| Split the classes of tetrahedron vertices to mirror the undoing of the gluing at stage orderElt of the search. More...
void | regina::CompactSearcher::splitEdgeClasses ()
| Split the classes of tetrahedron edges to mirror the undoing of the gluing at stage orderElt of the search. More...
void | regina::CompactSearcher::vtxBdryJoin (int vertexID, char end, int adjVertexID, char twist)
| Signifies that the boundary edges supplied by the vertex linking triangles for the two given tetrahedron vertices should be marked as adjacent. More...
void | regina::CompactSearcher::vtxBdryFixAdj (int vertexID)
| Adjusts the bdryNext and bdryTwist arrays for nearby tetrahedron vertices, to ensure that these arrays are consistent with the bdryNext and bdryTwist arrays stored with the given vertex. More...
void | regina::CompactSearcher::vtxBdryBackup (int vertexID)
| Copies the bdryNext and bdryTwist arrays to the bdryNextOld and bdryTwistOld arrays for the given tetrahedron vertex. More...
void | regina::CompactSearcher::vtxBdryRestore (int vertexID)
| Copies the bdryNextOld and bdryTwistOld arrays to the bdryNext and bdryTwist arrays for the given tetrahedron vertex. More...
void | regina::CompactSearcher::vtxBdryNext (int vertexID, int tet, int vertex, int bdryFace, int next[2], char twist[2])
| Assuming the given edge of the vertex linking triangle for the given tetrahedron vertex lies on the boundary of the vertex link, this routine identifies the adjacent boundary edges of the vertex link in each direction. More...
bool | regina::CompactSearcher::vtxBdryLength1 (int vertexID)
| Determines whether one of the edges of the vertex linking triangle for the given tetrahedron vertex in fact forms an entire one-edge boundary component of the overall vertex link. More...
bool | regina::CompactSearcher::vtxBdryLength2 (int vertexID1, int vertexID2)
| Determines whether edges of the vertex linking triangles for each of the given tetrahedron vertices combine to form an entire two-edge boundary component of the overall vertex link, with one edge from each triangle. More...
void | regina::CompactSearcher::vtxBdryConsistencyCheck ()
| Runs a number of tests on all tetrahedron vertices to locate consistency errors in the bdryEdges, bdryNext and bdryTwist members of the TetVertexState class. More...
void | regina::CompactSearcher::vtxBdryDump (std::ostream &out)
| Dumps a summary of bdryNext, bdryTwist and bdryEdges for every vertex of every tetrahedron to the given output stream. More...
| regina::ClosedPrimeMinSearcher::ClosedPrimeMinSearcher (const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Creates a new search manager for use when (i) only closed prime minimal P2-irreducible triangulations are required, and (ii) the given face pairing has order at least three. More...
| regina::ClosedPrimeMinSearcher::ClosedPrimeMinSearcher (std::istream &in, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Initialises a new search manager based on data read from the given input stream. More...
virtual | regina::ClosedPrimeMinSearcher::~ClosedPrimeMinSearcher ()
| Destroys this search manager and all supporting data structures. More...
virtual void | regina::ClosedPrimeMinSearcher::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
virtual void | regina::ClosedPrimeMinSearcher::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
virtual char | regina::ClosedPrimeMinSearcher::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
| regina::HyperbolicMinSearcher::HyperbolicMinSearcher (const FacetPairing< 3 > *pairing, const FacetPairing< 3 >::IsoList *autos, bool orientableOnly, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Creates a new search manager for use when only minimal ideal triangulations of cusped finite-volume hyperbolic 3-manifolds are required. More...
| regina::HyperbolicMinSearcher::HyperbolicMinSearcher (std::istream &in, GluingPermSearcher< 3 >::Use use, void *useArgs=0)
| Initialises a new search manager based on data read from the given input stream. More...
virtual void | regina::HyperbolicMinSearcher::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
virtual void | regina::HyperbolicMinSearcher::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
virtual char | regina::HyperbolicMinSearcher::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
| regina::GluingPermSearcher< 4 >::PentEdgeState::PentEdgeState ()
| Constructor for a standalone pentachoron edge in an equivalence class all of its own. More...
void | regina::GluingPermSearcher< 4 >::PentEdgeState::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
bool | regina::GluingPermSearcher< 4 >::PentEdgeState::readData (std::istream &in, unsigned long nStates)
| Fills this state with data read from the given input stream. More...
| regina::GluingPermSearcher< 4 >::PentTriangleState::PentTriangleState ()
| Constructor for a standalone pentachoron triangle in an equivalence class all of its own. More...
void | regina::GluingPermSearcher< 4 >::PentTriangleState::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
bool | regina::GluingPermSearcher< 4 >::PentTriangleState::readData (std::istream &in, unsigned long nStates)
| Fills this state with data read from the given input stream. More...
| regina::GluingPermSearcher< 4 >::GluingPermSearcher (const FacetPairing< 4 > *pairing, const FacetPairing< 4 >::IsoList *autos, bool orientableOnly, bool finiteOnly, GluingPermSearcher< 4 >::Use use, void *useArgs=0)
| Initialises a new search for gluing permutation sets. More...
| regina::GluingPermSearcher< 4 >::GluingPermSearcher (std::istream &in, GluingPermSearcher< 4 >::Use use, void *useArgs=0)
| Initialises a new search manager based on data read from the given input stream. More...
virtual | regina::GluingPermSearcher< 4 >::~GluingPermSearcher ()
| Destroys this search manager and all supporting data structures. More...
virtual void | regina::GluingPermSearcher< 4 >::runSearch (long maxDepth=-1)
| Generates all possible gluing permutation sets that satisfy the current search criteria. More...
bool | regina::GluingPermSearcher< 4 >::completePermSet () const
| Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state. More...
void | regina::GluingPermSearcher< 4 >::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 | regina::GluingPermSearcher< 4 >::dumpData (std::ostream &out) const
| Dumps all internal data in a plain text format to the given output stream. More...
static void | regina::GluingPermSearcher< 4 >::findAllPerms (const FacetPairing< 4 > *pairing, const FacetPairing< 4 >::IsoList *autos, bool orientableOnly, bool finiteOnly, GluingPermSearcher< 4 >::Use use, void *useArgs=0)
| The main entry routine for running a search for all gluing permutation sets that complement a given pentachoron facet pairing. More...
static GluingPermSearcher< 4 > * | regina::GluingPermSearcher< 4 >::bestSearcher (const FacetPairing< 4 > *pairing, const FacetPairing< 4 >::IsoList *autos, bool orientableOnly, bool finiteOnly, GluingPermSearcher< 4 >::Use use, void *useArgs=0)
| Constructs a search manager of the best possible class for the given search parameters. More...
static GluingPermSearcher< 4 > * | regina::GluingPermSearcher< 4 >::readTaggedData (std::istream &in, GluingPermSearcher< 4 >::Use use, void *useArgs=0)
| Creates a new search manager based on tagged data read from the given input stream. More...
bool | regina::GluingPermSearcher< 4 >::isCanonical () const
| Compares the current set of gluing permutations with its preimage under each automorphism of the underlying facet pairing, in order to see whether the current set is in canonical form (i.e., is lexicographically smallest). More...
bool | regina::GluingPermSearcher< 4 >::badTriangleLink (const FacetSpec< 4 > &facet) const
| Determines whether the permutations already constructed model a 4-manifold triangulation with a (2-dimensional) triangle identified with itself using a non-trivial rotation or reflection. More...
virtual char | regina::GluingPermSearcher< 4 >::dataTag () const
| Returns the character used to identify this class when storing tagged data in text format. More...
int | regina::GluingPermSearcher< 4 >::findTriangleClass (int triID) const
| Returns the representative of the equivalence class containing the given pentachoron triangle. More...
int | regina::GluingPermSearcher< 4 >::findTriangleClass (int triID, Perm< 3 > &twist) const
| Returns the representative of the equivalence class containing the given pentachoron triangle. More...
bool | regina::GluingPermSearcher< 4 >::mergeEdgeClasses ()
| Merges the classes of pentachoron edges as required by the new gluing made at stage orderElt of the search. More...
bool | regina::GluingPermSearcher< 4 >::mergeTriangleClasses ()
| Merges the classes of pentachoron triangles as required by the new gluing made at stage orderElt of the search. More...
void | regina::GluingPermSearcher< 4 >::splitEdgeClasses ()
| Splits the classes of pentachoron edges to mirror the undoing of the gluing at stage orderElt of the search. More...
void | regina::GluingPermSearcher< 4 >::splitTriangleClasses ()
| Splits the classes of pentachoron triangles to mirror the undoing of the gluing at stage orderElt of the search. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryJoin (int edgeID, char end, int adjEdgeID, char twist)
| Signifies that the boundary edges supplied by the linking triangles for the two given pentachoron edges should be marked as adjacent. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryFixAdj (int edgeID)
| Adjusts the bdryNext and bdryTwist arrays for nearby pentachoron edges, to ensure that these arrays are consistent with the bdryNext and bdryTwist arrays stored with the given pentachoron edge. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryBackup (int edgeID)
| Copies the bdryNext and bdryTwist arrays to the bdryNextOld and bdryTwistOld arrays for the given pentachoron edge. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryRestore (int edgeID)
| Copies the bdryNextOld and bdryTwistOld arrays to the bdryNext and bdryTwist arrays for the given pentachoron edge. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryNext (int edgeID, int pent, int edge, int bdryFacet, int next[2], char twist[2])
| Assuming the given edge of the linking triangle for the given pentachoron edge lies on the boundary of the link, this routine identifies the adjacent boundary edges of the link in each direction. More...
bool | regina::GluingPermSearcher< 4 >::edgeBdryLength1 (int edgeID)
| Determines whether one of the edges of the linking triangle for the given pentachoron edge in fact forms an entire one-edge boundary component of the overall 4-manifold edge link. More...
bool | regina::GluingPermSearcher< 4 >::edgeBdryLength2 (int edgeID1, int edgeID2)
| Determines whether edges of the linking triangles for each of the given pentachoron edges combine to form an entire two-edge boundary component of the overall 4-manifold edge link, with one edge from each triangle. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryConsistencyCheck ()
| Runs a number of tests on all pentachoron edges to locate consistency errors in the bdryEdges, bdryNext and bdryTwist members of the PentEdgeState class. More...
void | regina::GluingPermSearcher< 4 >::edgeBdryDump (std::ostream &out)
| Dumps a summary of bdryNext, bdryTwist and bdryEdges for every edge of every pentachoron to the given output stream. More...

## Variables

const FacetPairing< dim > * | regina::GluingPerms< dim >::pairing_
| The facet pairing that this permutation set complements. More...
int * | regina::GluingPerms< dim >::permIndices_
| The index into array Perm<dim+1>::Sn_1 describing how each simplex facet is glued to its partner. More...
bool | regina::GluingPerms< dim >::inputError_
| Has an error occurred during construction from an input stream? More...
static const char | regina::GluingPermSearcher< 2 >::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
const FacetPairing< 2 >::IsoList * | regina::GluingPermSearcher< 2 >::autos_
| The set of isomorphisms that define equivalence of gluing permutation sets. More...
bool | regina::GluingPermSearcher< 2 >::autosNew
| Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)? More...
bool | regina::GluingPermSearcher< 2 >::orientableOnly_
| Are we only searching for gluing permutations that correspond to orientable triangulations? More...
GluingPermSearcher< 2 >::Use | regina::GluingPermSearcher< 2 >::use_
| A routine to call each time a gluing permutation set is found during the search. More...
void * | regina::GluingPermSearcher< 2 >::useArgs_
| Additional user-supplied data to be passed as the second argument to the use_ routine. More...
bool | regina::GluingPermSearcher< 2 >::started
| Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search. More...
int * | regina::GluingPermSearcher< 2 >::orientation
| Keeps track of the orientation of each triangle in the underlying triangulation. More...
FacetSpec< 2 > * | regina::GluingPermSearcher< 2 >::order
| Describes the order in which gluing permutations are assigned to edges. More...
int | regina::GluingPermSearcher< 2 >::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 | regina::GluingPermSearcher< 2 >::orderElt
| Marks which element of order[] we are currently examining at this stage of the search. More...
static const char | regina::GluingPermSearcher< 3 >::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
const FacetPairing< 3 >::IsoList * | regina::GluingPermSearcher< 3 >::autos_
| The set of isomorphisms that define equivalence of gluing permutation sets. More...
bool | regina::GluingPermSearcher< 3 >::autosNew
| Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)? More...
bool | regina::GluingPermSearcher< 3 >::orientableOnly_
| Are we only searching for gluing permutations that correspond to orientable triangulations? More...
bool | regina::GluingPermSearcher< 3 >::finiteOnly_
| Are we only searching for gluing permutations that correspond to finite triangulations? More...
int | regina::GluingPermSearcher< 3 >::whichPurge_
| Are there any types of triangulation that we may optionally avoid constructing? This should be a bitwise OR of constants from the PurgeFlags enumeration. More...
GluingPermSearcher< 3 >::Use | regina::GluingPermSearcher< 3 >::use_
| A routine to call each time a gluing permutation set is found during the search. More...
void * | regina::GluingPermSearcher< 3 >::useArgs_
| Additional user-supplied data to be passed as the second argument to the use_ routine. More...
bool | regina::GluingPermSearcher< 3 >::started
| Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search. More...
int * | regina::GluingPermSearcher< 3 >::orientation
| Keeps track of the orientation of each tetrahedron in the underlying triangulation. More...
FacetSpec< 3 > * | regina::GluingPermSearcher< 3 >::order
| Describes the order in which gluing permutations are assigned to faces. More...
int | regina::GluingPermSearcher< 3 >::orderSize
| The total number of edges in the face pairing graph, i.e., the number of elements of interest in the order[] array. More...
int | regina::GluingPermSearcher< 3 >::orderElt
| Marks which element of order[] we are currently examining at this stage of the search. More...
static const char | regina::EulerSearcher::VLINK_CLOSED
| Signifies that a vertex link has been closed off (i.e., the link has no remaining boundary edges). More...
static const char | regina::EulerSearcher::VLINK_BAD_EULER
| Signifies that a vertex link has either (i) accumulated too high a genus (so when its punctures are filled the Euler characteristic will be too low), or has (ii) been closed off with too low a genus (so its final Euler characteristic is too high). More...
static const int | regina::EulerSearcher::vertexLinkNextFace [4][4]
| Maintains an ordering of the three tetrahedron faces surrounding a vertex in a tetrahedron. More...
static const int | regina::EulerSearcher::vertexLinkPrevFace [4][4]
| Provides backwards links for the ordering described by vertexLinkNextFace. More...
int | regina::EulerSearcher::TetVertexState::parent
| The index of the parent object in the current tree, or -1 if this object is the root of the tree. More...
unsigned | regina::EulerSearcher::TetVertexState::rank
| The depth of the subtree beneath this object (where a leaf node has depth zero). More...
unsigned | regina::EulerSearcher::TetVertexState::bdry
| The number of boundary edges in the vertex link for this equivalence class of vertices. More...
int | regina::EulerSearcher::TetVertexState::euler
| The Euler characteristic that the vertex link would have if its punctures were all filled. More...
char | regina::EulerSearcher::TetVertexState::twistUp
| The identification of this object and its parent in the tree corresponds to a gluing of two triangles in the vertex link. More...
bool | regina::EulerSearcher::TetVertexState::hadEqualRank
| Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone. More...
unsigned char | regina::EulerSearcher::TetVertexState::bdryEdges
| The number of edges of the triangular piece of vertex link that are in fact boundary edges of the vertex link. More...
int | regina::EulerSearcher::TetVertexState::bdryNext [2]
| If the corresponding triangular piece of vertex link has any boundary edges, bdryNext stores the indices of the tetrahedron vertices that provide the boundary edges following on from either end of this boundary segment. More...
char | regina::EulerSearcher::TetVertexState::bdryTwist [2]
| Describes whether the orientation of this boundary segment of the vertex link is consistent with the orientation of the adjacent segments on either side. More...
int | regina::EulerSearcher::TetVertexState::bdryNextOld [2]
| Stores a snapshot of the values in the bdryNext array from the last point in the search when bdryEdges was precisely two. More...
char | regina::EulerSearcher::TetVertexState::bdryTwistOld [2]
| Stores a snapshot of the values in the bdryTwist array from the last point in the search when bdryEdges was precisely two. More...
int | regina::EulerSearcher::TetEdgeState::parent
| The index of the parent object in the current tree, or -1 if this object is the root of the tree. More...
unsigned | regina::EulerSearcher::TetEdgeState::rank
| The depth of the subtree beneath this object (where a leaf node has depth zero). More...
unsigned | regina::EulerSearcher::TetEdgeState::size
| The total number of objects in the subtree descending from this object (where this object is counted also). More...
bool | regina::EulerSearcher::TetEdgeState::bounded
| Does this equivalence class of tetrahedron edges represent a boundary edge? More...
char | regina::EulerSearcher::TetEdgeState::twistUp
| Each tetrahedron edge can be assigned an orientation pointing from the lower numbered tetrahedron vertex to the higher. More...
bool | regina::EulerSearcher::TetEdgeState::hadEqualRank
| Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone. More...
QitmaskLen64 | regina::EulerSearcher::TetEdgeState::facesPos
| Indicates how many times this edge runs along the boundary of each tetrahedron face in the positive direction. More...
QitmaskLen64 | regina::EulerSearcher::TetEdgeState::facesNeg
| Indicates how many times this edge runs along the boundary of each tetrahedron face in the negative direction. More...
static const char | regina::EulerSearcher::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
int | regina::EulerSearcher::euler_
| The Euler characteristic that vertex links must have. More...
unsigned | regina::EulerSearcher::nVertexClasses
| The number of equivalence classes of identified tetrahedron vertices. More...
TetVertexState * | regina::EulerSearcher::vertexState
| Used for tracking equivalence classes of identified tetrahedron vertices. More...
int * | regina::EulerSearcher::vertexStateChanged
| Tracks the way in which the vertexState[] array has been updated over time. More...
unsigned | regina::EulerSearcher::nEdgeClasses
| The number of equivalence classes of identified tetrahedron edges. More...
TetEdgeState * | regina::EulerSearcher::edgeState
| Used for tracking equivalence classes of identified tetrahedron edges. More...
int * | regina::EulerSearcher::edgeStateChanged
| Tracks the way in which the edgeState[] array has been updated over time. More...
static const char | regina::CompactSearcher::VLINK_CLOSED
| Signifies that a vertex link has been closed off (i.e., the link has no remaining boundary edges). More...
static const char | regina::CompactSearcher::VLINK_NON_SPHERE
| Signifies that a vertex link has been made into something other than a 2-sphere with zero or more punctures. More...
static const int | regina::CompactSearcher::vertexLinkNextFace [4][4]
| Maintains an ordering of the three tetrahedron faces surrounding a vertex in a tetrahedron. More...
static const int | regina::CompactSearcher::vertexLinkPrevFace [4][4]
| Provides backwards links for the ordering described by vertexLinkNextFace. More...
int | regina::CompactSearcher::TetVertexState::parent
| The index of the parent object in the current tree, or -1 if this object is the root of the tree. More...
unsigned | regina::CompactSearcher::TetVertexState::rank
| The depth of the subtree beneath this object (where a leaf node has depth zero). More...
unsigned | regina::CompactSearcher::TetVertexState::bdry
| The number of boundary edges in the vertex link for this equivalence class of vertices. More...
char | regina::CompactSearcher::TetVertexState::twistUp
| The identification of this object and its parent in the tree corresponds to a gluing of two triangles in the vertex link. More...
bool | regina::CompactSearcher::TetVertexState::hadEqualRank
| Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone. More...
unsigned char | regina::CompactSearcher::TetVertexState::bdryEdges
| The number of edges of the triangular piece of vertex link that are in fact boundary edges of the vertex link. More...
int | regina::CompactSearcher::TetVertexState::bdryNext [2]
| If the corresponding triangular piece of vertex link has any boundary edges, bdryNext stores the indices of the tetrahedron vertices that provide the boundary edges following on from either end of this boundary segment. More...
char | regina::CompactSearcher::TetVertexState::bdryTwist [2]
| Describes whether the orientation of this boundary segment of the vertex link is consistent with the orientation of the adjacent segments on either side. More...
int | regina::CompactSearcher::TetVertexState::bdryNextOld [2]
| Stores a snapshot of the values in the bdryNext array from the last point in the search when bdryEdges was precisely two. More...
char | regina::CompactSearcher::TetVertexState::bdryTwistOld [2]
| Stores a snapshot of the values in the bdryTwist array from the last point in the search when bdryEdges was precisely two. More...
int | regina::CompactSearcher::TetEdgeState::parent
| The index of the parent object in the current tree, or -1 if this object is the root of the tree. More...
unsigned | regina::CompactSearcher::TetEdgeState::rank
| The depth of the subtree beneath this object (where a leaf node has depth zero). More...
unsigned | regina::CompactSearcher::TetEdgeState::size
| The total number of objects in the subtree descending from this object (where this object is counted also). More...
bool | regina::CompactSearcher::TetEdgeState::bounded
| Does this equivalence class of tetrahedron edges represent a boundary edge? More...
char | regina::CompactSearcher::TetEdgeState::twistUp
| Each tetrahedron edge can be assigned an orientation pointing from the lower numbered tetrahedron vertex to the higher. More...
bool | regina::CompactSearcher::TetEdgeState::hadEqualRank
| Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone. More...
QitmaskLen64 | regina::CompactSearcher::TetEdgeState::facesPos
| Indicates how many times this edge runs along the boundary of each tetrahedron face in the positive direction. More...
QitmaskLen64 | regina::CompactSearcher::TetEdgeState::facesNeg
| Indicates how many times this edge runs along the boundary of each tetrahedron face in the negative direction. More...
static const char | regina::CompactSearcher::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
unsigned | regina::CompactSearcher::nVertexClasses
| The number of equivalence classes of identified tetrahedron vertices. More...
TetVertexState * | regina::CompactSearcher::vertexState
| Used for tracking equivalence classes of identified tetrahedron vertices. More...
int * | regina::CompactSearcher::vertexStateChanged
| Tracks the way in which the vertexState[] array has been updated over time. More...
unsigned | regina::CompactSearcher::nEdgeClasses
| The number of equivalence classes of identified tetrahedron edges. More...
TetEdgeState * | regina::CompactSearcher::edgeState
| Used for tracking equivalence classes of identified tetrahedron edges. More...
int * | regina::CompactSearcher::edgeStateChanged
| Tracks the way in which the edgeState[] array has been updated over time. More...
static const char | regina::ClosedPrimeMinSearcher::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
static const char | regina::HyperbolicMinSearcher::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
static const int | regina::GluingPermSearcher< 4 >::edgeLinkNextFacet [10][5]
| Maintains an ordering of the three pentachoron facets surrounding an edge in a pentachoron. More...
static const int | regina::GluingPermSearcher< 4 >::edgeLinkPrevFacet [10][5]
| Provides backwards links for the ordering described by edgeLinkNextFacet. More...
int | regina::GluingPermSearcher< 4 >::PentEdgeState::parent
| The index of the parent object in the current tree, or -1 if this object is the root of the tree. More...
unsigned | regina::GluingPermSearcher< 4 >::PentEdgeState::rank
| The depth of the subtree beneath this object (where a leaf node has depth zero). More...
unsigned | regina::GluingPermSearcher< 4 >::PentEdgeState::bdry
| The number of boundary triangle edges in the link for this equivalence class of pentachoron edges. More...
char | regina::GluingPermSearcher< 4 >::PentEdgeState::twistUpEdge
| Each pentachoron edge can be assigned an orientation pointing from the lower numbered pentachoron vertex to the higher. More...
char | regina::GluingPermSearcher< 4 >::PentEdgeState::twistUpTriangle
| The identification of this object and its parent in the tree corresponds to a gluing of two triangles in the edge link. More...
bool | regina::GluingPermSearcher< 4 >::PentEdgeState::hadEqualRank
| Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone. More...
unsigned char | regina::GluingPermSearcher< 4 >::PentEdgeState::bdryEdges
| The number of edges of the triangular piece of 4-manifold edge link that are in fact boundary edges of this link. More...
int | regina::GluingPermSearcher< 4 >::PentEdgeState::bdryNext [2]
| If the corresponding triangular piece of 4-manifold edge link has any boundary edges, bdryNext stores the indices of the pentachoron edges that provide the boundary edges following on from either end of this boundary segment. More...
char | regina::GluingPermSearcher< 4 >::PentEdgeState::bdryTwist [2]
| Describes whether the orientation of this boundary segment of the 4-manifold edge link is consistent with the orientation of the adjacent segments on either side. More...
int | regina::GluingPermSearcher< 4 >::PentEdgeState::bdryNextOld [2]
| Stores a snapshot of the values in the bdryNext array from the last point in the search when bdryEdges was precisely two. More...
char | regina::GluingPermSearcher< 4 >::PentEdgeState::bdryTwistOld [2]
| Stores a snapshot of the values in the bdryTwist array from the last point in the search when bdryEdges was precisely two. More...
int | regina::GluingPermSearcher< 4 >::PentTriangleState::parent
| The index of the parent object in the current tree, or -1 if this object is the root of the tree. More...
unsigned | regina::GluingPermSearcher< 4 >::PentTriangleState::rank
| The depth of the subtree beneath this object (where a leaf node has depth zero). More...
unsigned | regina::GluingPermSearcher< 4 >::PentTriangleState::size
| The total number of objects in the subtree descending from this object (where this object is counted also). More...
bool | regina::GluingPermSearcher< 4 >::PentTriangleState::bounded
| Does this equivalence class of pentachoron triangles represent a boundary triangle? More...
Perm< 3 > | regina::GluingPermSearcher< 4 >::PentTriangleState::twistUp
| The vertices of each pentachoron triangle can be labelled (0,1,2) by running through the underlying pentachoron vertices from smallest index to largest index. More...
bool | regina::GluingPermSearcher< 4 >::PentTriangleState::hadEqualRank
| Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone. More...
static const char | regina::GluingPermSearcher< 4 >::dataTag_
| A character used to identify this class when reading and writing tagged data in text format. More...
const FacetPairing< 4 >::IsoList * | regina::GluingPermSearcher< 4 >::autos_
| The set of isomorphisms that define equivalence of gluing permutation sets. More...
bool | regina::GluingPermSearcher< 4 >::autosNew_
| Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)? More...
bool | regina::GluingPermSearcher< 4 >::orientableOnly_
| Are we only searching for gluing permutations that correspond to orientable triangulations? More...
bool | regina::GluingPermSearcher< 4 >::finiteOnly_
| Are we only searching for gluing permutations that correspond to finite (non-ideal) triangulations? More...
GluingPermSearcher< 4 >::Use | regina::GluingPermSearcher< 4 >::use_
| A routine to call each time a gluing permutation set is found during the search. More...
void * | regina::GluingPermSearcher< 4 >::useArgs_
| Additional user-supplied data to be passed as the second argument to the use_ routine. More...
bool | regina::GluingPermSearcher< 4 >::started_
| Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search. More...
int * | regina::GluingPermSearcher< 4 >::orientation_
| Keeps track of the orientation of each pentachoron in the underlying triangulation. More...
FacetSpec< 4 > * | regina::GluingPermSearcher< 4 >::order_
| Describes the order in which gluing permutations are assigned to pentachoron facets. More...
int | regina::GluingPermSearcher< 4 >::orderSize_
| The total number of edges in the facet pairing graph, i.e., the number of elements of interest in the order_[] array. More...
int | regina::GluingPermSearcher< 4 >::orderElt_
| Marks which element of order_[] we are currently examining at this stage of the search. More...
unsigned | regina::GluingPermSearcher< 4 >::nEdgeClasses_
| The number of equivalence classes of identified pentachoron edges. More...
PentEdgeState * | regina::GluingPermSearcher< 4 >::edgeState_
| Used for tracking equivalence classes of identified pentachoron edges. More...
int * | regina::GluingPermSearcher< 4 >::edgeStateChanged_
| Tracks the way in which the edgeState_[] array has been updated over time. More...
unsigned | regina::GluingPermSearcher< 4 >::nTriangleClasses_
| The number of equivalence classes of identified pentachoron triangles. More...
PentTriangleState * | regina::GluingPermSearcher< 4 >::triState_
| Used for tracking equivalence classes of identified pentachoron triangles. More...
int * | regina::GluingPermSearcher< 4 >::triStateChanged_
| Tracks the way in which the triState_[] array has been updated over time. More...

## Friends

class | regina::CensusHit::CensusDB
class | regina::CensusHit::CensusHits

## Detailed Description

Census lookup and enumeration for triangulations of various dimensions.

## Typedef Documentation

## Dim2GluingPerms

typedef GluingPerms<2> regina::Dim2GluingPerms

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef Dim2GluingPerms, you should use the full class name GluingPerms<2>.

## Dim2GluingPermSearcher

typedef GluingPermSearcher<2> regina::Dim2GluingPermSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef Dim2GluingPermSearcher, you should use the full class name GluingPermSearcher<2>.

## Dim4GluingPerms

typedef GluingPerms<4> regina::Dim4GluingPerms

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef Dim4GluingPerms, you should use the full class name GluingPerms<4>.

## Dim4GluingPermSearcher

typedef GluingPermSearcher<4> regina::Dim4GluingPermSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef Dim4GluingPermSearcher, you should use the full class name GluingPermSearcher<4>.

## NCensus

typedef Census regina::NCensus

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NCensus has now been renamed to Census.

## NCensusDB

typedef CensusDB regina::NCensusDB

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NCensusDB has now been renamed to CensusDB.

## NCensusHit

typedef CensusHit regina::NCensusHit

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NCensusHit has now been renamed to CensusHit.

## NCensusHits

typedef CensusHits regina::NCensusHits

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NCensusHits has now been renamed to CensusHits.

## NClosedPrimeMinSearcher

typedef ClosedPrimeMinSearcher regina::NClosedPrimeMinSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NClosedPrimeMinSearcher has now been renamed to ClosedPrimeMinSearcher.

## NCompactSearcher

typedef CompactSearcher regina::NCompactSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NCompactSearcher has now been renamed to CompactSearcher.

## NEulerSearcher

typedef EulerSearcher regina::NEulerSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NEulerSearcher has now been renamed to EulerSearcher.

## NGenericGluingPerms

template<int dim>

using regina::NGenericGluingPerms = typedef GluingPerms<dim>

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old type alias NGenericGluingPerms<dim>, you should use the new class name GluingPerms<dim>.

## NGluingPerms

typedef GluingPerms<3> regina::NGluingPerms

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef NGluingPerms, you should use the full class name GluingPerms<3>.

## NGluingPermSearcher

typedef GluingPermSearcher<3> regina::NGluingPermSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef NGluingPermSearcher, you should use the full class name GluingPermSearcher<3>.

## NHyperbolicMinSearcher

typedef HyperbolicMinSearcher regina::NHyperbolicMinSearcher

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  The class NHyperbolicMinSearcher has now been renamed to HyperbolicMinSearcher.

## Use [1/3]

typedef void(* regina::GluingPermSearcher< 2 >::Use) (const GluingPermSearcher< 2 > *, void *)

A routine that can do arbitrary processing upon a set of gluing permutations.

Such routines are used to process permutation sets that are found when running census-building routines such as findAllPerms().

The first parameter passed will be a set of gluing permutations (as this class derives from GluingPerms<2>). This set of gluing permutations must not be deallocated by this routine, since it may be used again later by the caller. The second parameter may contain arbitrary data; typically this will be the data passed to the relevant search routine, such as findAllPerms() or the GluingPermSearcher class constructor.

Note that the first parameter passed might be `null` to signal that gluing permutation generation has finished.

## Use [2/3]

typedef void(* regina::GluingPermSearcher< 3 >::Use) (const GluingPermSearcher< 3 > *, void *)

A routine that can do arbitrary processing upon a set of gluing permutations.

Such routines are used to process permutation sets that are found when running census-building routines such as findAllPerms().

The first parameter passed will be a set of gluing permutations (as this class derives from GluingPerms<3>). This set of gluing permutations must not be deallocated by this routine, since it may be used again later by the caller. The second parameter may contain arbitrary data; typically this will be the data passed to the relevant search routine, such as findAllPerms() or the GluingPermSearcher class constructor.

Note that the first parameter passed might be `null` to signal that gluing permutation generation has finished.

## Use [3/3]

typedef void(* regina::GluingPermSearcher< 4 >::Use) (const GluingPermSearcher< 4 > *, void *)

A routine that can do arbitrary processing upon a set of gluing permutations.

Such routines are used to process permutation sets that are found when running census-building routines such as findAllPerms().

The first parameter passed will be a set of gluing permutations (as this class derives from GluingPerms<4>). This set of gluing permutations must not be deallocated by this routine, since it may be used again later by the caller. The second parameter may contain arbitrary data; typically this will be the data passed to the relevant search routine, such as findAllPerms() or the GluingPermSearcher class constructor.

Note that the first parameter passed might be `null` to signal that gluing permutation generation has finished.

## UseDim2GluingPerms

typedef GluingPermSearcher<2>::Use regina::UseDim2GluingPerms

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef UseDim2GluingPerms, you should use the new type name GluingPermSearcher<2>::Use.

## UseDim4GluingPerms

typedef GluingPermSearcher<4>::Use regina::UseDim4GluingPerms

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef UseDim4GluingPerms, you should use the new type name GluingPermSearcher<4>::Use.

## UseGluingPerms

typedef GluingPermSearcher<3>::Use regina::UseGluingPerms

Deprecated typedef for backward compatibility.

This typedef will be removed in a future release of Regina.

Deprecated:
  Instead of the old typedef UseGluingPerms, you should use the new type name GluingPermSearcher<3>::Use.

## Enumeration Type Documentation

## anonymous enum

anonymous enum

protected

Constants used in the vertexStateChanged array to indicate how a partial vertex link becomes glued to itself along two of its boundary edges.

See vertexStateChanged for details.

Enumerator
VLINK_JOIN_INIT | A placeholder value for a join that has not yet been made.
VLINK_JOIN_HANDLE | Signifies that two distinct boundary components of a vertex link have been connected, forming a handle (either orientable or non-orientable).
VLINK_JOIN_BRIDGE | Signifies that a single boundary component of the vertex link has had two edges joined together in an orientation-preserving fashion.
VLINK_JOIN_TWIST | Signifies that a single boundary component of the vertex link has had two edges joined together in an orientation-reversing fashion.

## PurgeFlags

enum regina::GluingPermSearcher< 3 >::PurgeFlags

Flags to indicate that our enumeration may (at the discretion of the enumeration algorithm) ignore certain classes of triangulations.

These flags can be combined using bitwise OR.

See the GluingPermSearcher<3> constructor documentation for further details on how these flags are used.

Python:\n For convenience, these constants are also made
  available directly in Python's regina namespace.

Enumerator
PURGE_NONE | Indicates that no triangulations should be ignored.
PURGE_NON_MINIMAL | Indicates that non-minimal triangulations may be ignored.
PURGE_NON_PRIME | Indicates that any triangulation that is not prime (i.e., can be written as a non-trivial connected sum) and any bounded triangulation that is reducible over a disc may be ignored.
PURGE_NON_MINIMAL_PRIME | Indicates that any triangulation that is not prime (i.e., can be written as a non-trivial connected sum), any bounded triangulation that is reducible over a disc and any triangulation that is non-minimal may be ignored. Note that this is simply a combination of the constants PURGE_NON_MINIMAL and PURGE_NON_PRIME.
PURGE_NON_MINIMAL_HYP | Indicates that any triangulation that is not a minimal ideal triangulation of a cusped finite-volume hyperbolic 3-manifold may be ignored.
PURGE_P2_REDUCIBLE | Indicates that any triangulation containing an embedded two-sided projective plane may be ignored.

## Function Documentation

## append()

void regina::CensusHits::append | ( | CensusHit * | hit | ) |

inline

Appends a new hit to the end of this list.

This list will take ownership of the given object.

Parameters

  hit | the hit to append to this list.

## badEdgeLink()

bool regina::GluingPermSearcher< 3 >::badEdgeLink | ( | const FacetSpec< 3 > & | face | ) | const

protected

Determines whether the permutations already constructed model a triangulation with an edge identified with itself in reverse.

Note that such edges can only occur in non-orientable triangulations.

Tests that do not refer to the gluing permutation for the given face will not be run.

This routine is not fussy about the order in which gluing permutations are selected, as long as permutations not yet selected have the corresponding element of permIndices[] set to -1.

If finiteOnly_ is `true` in the search criteria, additional tests will be run that can eliminate triangulations with non-orientable vertex links. Although these tests are not searching for bad edge links per se, they can be performed within this routine with very little additional work needing to be done.

Parameters

  face | the specific tetrahedron face upon which tests will be based.

Returns
  `true` if the permutations under construction will lead to an edge identified with itself in reverse, or `false` if no such edge is found.

## badTriangleLink()

bool regina::GluingPermSearcher< 4 >::badTriangleLink | ( | const FacetSpec< 4 > & | facet | ) | const

protected

Determines whether the permutations already constructed model a 4-manifold triangulation with a (2-dimensional) triangle identified with itself using a non-trivial rotation or reflection.

Tests that do not refer to the gluing permutation for the given pentachoron facet will not be run.

This routine is not fussy about the order in which gluing permutations are selected, as long as permutations not yet selected have the corresponding element of permIndices[] set to -1.

Parameters

  facet | the specific pentachoron facet upon which tests will be based.

Returns
  `true` if the permutations under construction will lead to a triangle identified with itself using a non-trivial rotation or reflection, or `false` if no such triangle is found.

## bestSearcher() [1/3]

static GluingPermSearcher<2>* regina::GluingPermSearcher< 2 >::bestSearcher | ( | const FacetPairing< 2 > * | pairing,
|  | const FacetPairing< 2 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | GluingPermSearcher< 2 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

Constructs a search manager of the best possible class for the given search parameters.

Different subclasses of GluingPermSearcher<2> provide optimised search algorithms for different types of search.

Calling this routine and then calling runSearch() on the result has the same effect as the all-in-one routine findAllPerms(). Unless you have specialised requirements (such as partial searching), you are probably better calling findAllPerms() instead.

The resulting object is newly created, and must be destroyed by the caller of this routine.

See the GluingPermSearcher<2> constructor for documentation on the arguments to this routine.

Precondition
  The given edge pairing is connected, i.e., it is possible to reach any triangle from any other triangle via a series of matched edge pairs.
  The given edge pairing is in canonical form as described by FacetPairing<2>::isCanonical(). Note that all edge pairings constructed by FacetPairing<2>::findAllPairings() are of this form.

Returns
  the newly created search manager.

## bestSearcher() [2/3]

static GluingPermSearcher<3>* regina::GluingPermSearcher< 3 >::bestSearcher | ( | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | bool | finiteOnly,
|  | int | whichPurge,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

Constructs a search manager of the best possible class for the given search parameters.

Different subclasses of GluingPermSearcher<3> provide optimised search algorithms for different types of search.

Calling this routine and then calling runSearch() on the result has the same effect as the all-in-one routine findAllPerms(). Unless you have specialised requirements (such as partial searching), you are probably better calling findAllPerms() instead.

The resulting object is newly created, and must be destroyed by the caller of this routine.

See the GluingPermSearcher<3> constructor for documentation on the arguments to this routine.

Precondition
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.

Returns
  the newly created search manager.

## bestSearcher() [3/3]

static GluingPermSearcher<4>* regina::GluingPermSearcher< 4 >::bestSearcher | ( | const FacetPairing< 4 > * | pairing,
|  | const FacetPairing< 4 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | bool | finiteOnly,
|  | GluingPermSearcher< 4 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

Constructs a search manager of the best possible class for the given search parameters.

Different subclasses of GluingPermSearcher<4> provide optimised search algorithms for different types of search.

Calling this routine and then calling runSearch() on the result has the same effect as the all-in-one routine findAllPerms(). Unless you have specialised requirements (such as partial searching), you are probably better calling findAllPerms() instead.

The resulting object is newly created, and must be destroyed by the caller of this routine.

See the GluingPermSearcher<4> constructor for documentation on the arguments to this routine.

Precondition
  The given facet pairing is connected, i.e., it is possible to reach any pentachoron from any other pentachoron via a series of matched facet pairs.
  The given facet pairing is in canonical form as described by FacetPairing<4>::isCanonical(). Note that all facet pairings constructed by FacetPairing<4>::findAllPairings() are of this form.

Returns
  the newly created search manager.

## CensusDB()

regina::CensusDB::CensusDB | ( | const std::string & | filename,
|  | const std::string & | desc
| ) |  |

inline

Creates a new reference to one of Regina's census databases.

This constructor will not run any checks (e.g., it will not verify that the database exists, or that it is stored in the correct format). Note that even if the database does not exist, the lookup() routine will fail gracefully.

Parameters

  filename | the filename where the database is stored.
  desc | a human-readable description of the database. See the desc() routine for further information on how this description might be used.

## CensusHits()

regina::CensusHits::CensusHits | ( |  | ) |

inline

Constructs an empty set of hits.

## ClosedPrimeMinSearcher() [1/2]

regina::ClosedPrimeMinSearcher::ClosedPrimeMinSearcher | ( | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Creates a new search manager for use when (i) only closed prime minimal P2-irreducible triangulations are required, and (ii) the given face pairing has order at least three.

Note that other unwanted triangulations may still be produced (e.g., non-prime or non-minimal triangulations), but there will be far fewer of these than when using the GluingPermSearcher<3> class directly.

For details on how a search manager is used, see the GluingPermSearcher<3> documentation. Note in particular that this class will be automatically used by GluingPermSearcher<3>::findAllPerms() if possible, so there is often no need for an end user to instantiate this class directly.

All constructor arguments are the same as for the GluingPermSearcher<3> constructor, though some arguments (such as finiteOnly and whichPurge) are not needed here since they are already implied by the specialised search context.

Precondition
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.
  The given face pairing has no boundary faces and has at least three tetrahedra.

## ClosedPrimeMinSearcher() [2/2]

regina::ClosedPrimeMinSearcher::ClosedPrimeMinSearcher | ( | std::istream & | in,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search manager based on data read from the given input stream.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

The arguments use and useArgs are the same as for the GluingPermSearcher<3> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## CompactSearcher() [1/2]

regina::CompactSearcher::CompactSearcher | ( | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | int | whichPurge,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Creates a new search manager for use when only compact 3-manifold triangulations are required.

For details on how a search manager is used, see the GluingPermSearcher<3> documentation. Note in particular that this class will be automatically used by GluingPermSearcher<3>::findAllPerms() if possible, so there is often no need for an end user to instantiate this class directly.

All constructor arguments are the same as for the GluingPermSearcher<3> constructor, though some arguments (such as finiteOnly) are not needed here since they are already implied by the specialised search context.

Precondition
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.

## CompactSearcher() [2/2]

regina::CompactSearcher::CompactSearcher | ( | std::istream & | in,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search manager based on data read from the given input stream.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

The arguments use and useArgs are the same as for the GluingPermSearcher<3> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## completePermSet() [1/3]

bool regina::GluingPermSearcher< 2 >::completePermSet | ( |  | ) | const

inline

Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state.

This may assist the use_ routine when running partial depth-based searches. See runSearch() for further details.

Returns
  `true` if a complete gluing permutation set is held, or `false` otherwise.

## completePermSet() [2/3]

bool regina::GluingPermSearcher< 3 >::completePermSet | ( |  | ) | const

inline

Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state.

This may assist the use_ routine when running partial depth-based searches. See runSearch() for further details.

Returns
  `true` if a complete gluing permutation set is held, or `false` otherwise.

## completePermSet() [3/3]

bool regina::GluingPermSearcher< 4 >::completePermSet | ( |  | ) | const

inline

Determines whether this search manager holds a complete gluing permutation set or just a partially completed search state.

This may assist the use_ routine when running partial depth-based searches. See runSearch() for further details.

Returns
  `true` if a complete gluing permutation set is held, or `false` otherwise.

## count()

size_t regina::CensusHits::count | ( |  | ) | const

inline

Returns the total number of hits in this list.

This routine is fast, since the number of hits is cached (it does not need to walk through the entire list to count).

Returns
  the total number of hits.

## dataTag() [1/7]

char regina::GluingPermSearcher< 2 >::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

## dataTag() [2/7]

char regina::GluingPermSearcher< 3 >::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

Reimplemented in regina::HyperbolicMinSearcher, regina::ClosedPrimeMinSearcher, regina::CompactSearcher, and regina::EulerSearcher.

## dataTag() [3/7]

char regina::GluingPermSearcher< 4 >::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

## dataTag() [4/7]

char regina::EulerSearcher::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

Reimplemented from regina::GluingPermSearcher< 3 >.

Reimplemented in regina::HyperbolicMinSearcher.

## dataTag() [5/7]

char regina::CompactSearcher::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

Reimplemented from regina::GluingPermSearcher< 3 >.

Reimplemented in regina::ClosedPrimeMinSearcher.

## dataTag() [6/7]

char regina::ClosedPrimeMinSearcher::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

Reimplemented from regina::CompactSearcher.

## dataTag() [7/7]

char regina::HyperbolicMinSearcher::dataTag | ( |  | ) | const

inline protected virtual

Returns the character used to identify this class when storing tagged data in text format.

Returns
  the class tag.

Reimplemented from regina::EulerSearcher.

## db()

const CensusDB * regina::CensusHit::db | ( |  | ) | const

inline

Returns details of the census database in which the triangulation was found.

Returns
  the database for this hit.

## desc()

const std::string & regina::CensusDB::desc | ( |  | ) | const

inline

Returns a human-readable description of this database.

The description could (for instance) be shown to users when giving a list of all available databases, or when identifying in which particular database a match was found.

Returns
  the database description.

## dumpData() [1/14]

template<int dim>

virtual void regina::GluingPerms< dim >::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented in regina::HyperbolicMinSearcher, regina::ClosedPrimeMinSearcher, regina::CompactSearcher, regina::EulerSearcher, regina::GluingPermSearcher< 4 >, regina::GluingPermSearcher< 3 >, and regina::GluingPermSearcher< 2 >.

## dumpData() [2/14]

void regina::GluingPermSearcher< 4 >::PentEdgeState::dumpData | ( | std::ostream & | out | ) | const

Dumps all internal data in a plain text format to the given output stream.

This state can be recreated from this text data by calling readData().

This routine may be useful for transferring objects from one processor to another.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## dumpData() [3/14]

virtual void regina::GluingPermSearcher< 2 >::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::GluingPerms< 2 >.

## dumpData() [4/14]

void regina::GluingPermSearcher< 4 >::PentTriangleState::dumpData | ( | std::ostream & | out | ) | const

Dumps all internal data in a plain text format to the given output stream.

This state can be recreated from this text data by calling readData().

This routine may be useful for transferring objects from one processor to another.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## dumpData() [5/14]

virtual void regina::GluingPermSearcher< 3 >::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::GluingPerms< 3 >.

Reimplemented in regina::HyperbolicMinSearcher, regina::ClosedPrimeMinSearcher, regina::CompactSearcher, and regina::EulerSearcher.

## dumpData() [6/14]

virtual void regina::GluingPermSearcher< 4 >::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::GluingPerms< 4 >.

## dumpData() [7/14]

void regina::EulerSearcher::TetVertexState::dumpData | ( | std::ostream & | out | ) | const

Dumps all internal data in a plain text format to the given output stream.

This state can be recreated from this text data by calling readData().

This routine may be useful for transferring objects from one processor to another.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## dumpData() [8/14]

virtual void regina::EulerSearcher::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::GluingPermSearcher< 3 >.

Reimplemented in regina::HyperbolicMinSearcher.

## dumpData() [9/14]

void regina::CompactSearcher::TetVertexState::dumpData | ( | std::ostream & | out | ) | const

Dumps all internal data in a plain text format to the given output stream.

This state can be recreated from this text data by calling readData().

This routine may be useful for transferring objects from one processor to another.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## dumpData() [10/14]

virtual void regina::CompactSearcher::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::GluingPermSearcher< 3 >.

Reimplemented in regina::ClosedPrimeMinSearcher.

## dumpData() [11/14]

virtual void regina::ClosedPrimeMinSearcher::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::CompactSearcher.

## dumpData() [12/14]

virtual void regina::HyperbolicMinSearcher::dumpData | ( | std::ostream & | out | ) | const

virtual

Dumps all internal data in a plain text format to the given output stream.

This object can be recreated from this text data by calling the input stream constructor for this class.

This routine may be useful for transferring objects from one processor to another.

Note that subclass data is written after superclass data, so it is safe to dump data from a subclass and then recreate a new superclass object from that data (though subclass-specific information will of course be lost).

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

Reimplemented from regina::EulerSearcher.

## dumpData() [13/14]

void regina::EulerSearcher::TetEdgeState::dumpData | ( | std::ostream & | out,
|  | unsigned | nTets
| ) |  | const

Dumps all internal data in a plain text format to the given output stream.

This state can be recreated from this text data by calling readData().

This routine may be useful for transferring objects from one processor to another.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  nTets | the number of tetrahedra under consideration in the census.
  out | the output stream to which the data should be written.

## dumpData() [14/14]

void regina::CompactSearcher::TetEdgeState::dumpData | ( | std::ostream & | out,
|  | unsigned | nTets
| ) |  | const

Dumps all internal data in a plain text format to the given output stream.

This state can be recreated from this text data by calling readData().

This routine may be useful for transferring objects from one processor to another.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  nTets | the number of tetrahedra under consideration in the census.
  out | the output stream to which the data should be written.

## dumpTaggedData() [1/3]

void regina::GluingPermSearcher< 2 >::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.

This routine can be used with readTaggedData() to transport objects from place to place whose precise class is unknown.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## dumpTaggedData() [2/3]

void regina::GluingPermSearcher< 3 >::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.

This routine can be used with readTaggedData() to transport objects from place to place whose precise class is unknown.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## dumpTaggedData() [3/3]

void regina::GluingPermSearcher< 4 >::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.

This routine can be used with readTaggedData() to transport objects from place to place whose precise class is unknown.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  out | the output stream to which the data should be written.

## edgeBdryBackup()

void regina::GluingPermSearcher< 4 >::edgeBdryBackup | ( | int | edgeID | ) |

inline protected

Copies the bdryNext and bdryTwist arrays to the bdryNextOld and bdryTwistOld arrays for the given pentachoron edge.

See the PentEdgeState class for further information.

Parameters

  edgeID | the pentachoron edge on which to operate; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.

## edgeBdryConsistencyCheck()

void regina::GluingPermSearcher< 4 >::edgeBdryConsistencyCheck | ( |  | ) |

protected

Runs a number of tests on all pentachoron edges to locate consistency errors in the bdryEdges, bdryNext and bdryTwist members of the PentEdgeState class.

Any errors that are identified will be written to standard error. Note that some errors might be harmless (for instance, when a call to mergeEdgeClasses() leaves processing incomplete because it has located a bad edge link and expects the merge to be immediately undone).

## edgeBdryDump()

void regina::GluingPermSearcher< 4 >::edgeBdryDump | ( | std::ostream & | out | ) |

protected

Dumps a summary of bdryNext, bdryTwist and bdryEdges for every edge of every pentachoron to the given output stream.

The output format is relatively compact, and is subject to change in future versions of Regina. The output uses one line only, and a final newline is written.

See the PentEdgeState class for further information.

Parameters

  out | the output stream to which to write.

## edgeBdryFixAdj()

void regina::GluingPermSearcher< 4 >::edgeBdryFixAdj | ( | int | edgeID | ) |

inline protected

Adjusts the bdryNext and bdryTwist arrays for nearby pentachoron edges, to ensure that these arrays are consistent with the bdryNext and bdryTwist arrays stored with the given pentachoron edge.

It is assumed that the linking triangle for the given pentachoron edge contributes at least one boundary edge to the 4-manifold edge link. Recall from the PentEdgeState class notes that the bdryNext and bdryTwist arrays for the given pentachoron edge describe the boundary edges that follow on in either direction from the boundary edges supplied by this triangle.

This routine locates the pentachoron edges that provide the neighbouring boundary edges of the link, and adjusts the bdryNext and bdryTwist arrays for these neighbouring pentachoron edges to point back to the given pentachoron edge.

This routine is intended to assist with backtracking. This routine is safe to use if the given pentachoron edge points to itself (i.e., it provides a complete boundary cycle of three edges in the 4-manifold edge link).

See the PentEdgeState class for further information.

Precondition
  The linking triangle for the given pentachoron edge contributes at least one boundary edge to the 4-manifold edge link.

Parameters

  edgeID | the pentachoron edge to examine; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.

## edgeBdryJoin()

void regina::GluingPermSearcher< 4 >::edgeBdryJoin | ( | int | edgeID,
|  | char | end,
|  | int | adjEdgeID,
|  | char | twist
| ) |  |

inline protected

Signifies that the boundary edges supplied by the linking triangles for the two given pentachoron edges should be marked as adjacent.

The bdryNext and bdryTwist arrays for each pentachoron edge will be adjusted to point to the other.

See the PentEdgeState class for details.

Parameters

  edgeID | the first pentachoron edge on which to operate; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.
  end | specifies in which direction the adjacent boundary edges lie. This must be either 0 or 1, and its value should correspond to the relevant index in the bdryNext and bdryTwist arrays for edge edgeID.
  adjEdgeID | the pentachoron edge whose boundary edges are adjacent to the boundary edges supplied by edgeID; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.
  twist | 0 if the orientations of the two boundary segments of edge link are oriented in the same direction, or 1 if they are oriented in opposite directions; see the bdryTwist documentation for details.

## edgeBdryLength1()

bool regina::GluingPermSearcher< 4 >::edgeBdryLength1 | ( | int | edgeID | ) |

inline protected

Determines whether one of the edges of the linking triangle for the given pentachoron edge in fact forms an entire one-edge boundary component of the overall 4-manifold edge link.

See the PentEdgeState class for further information.

Parameters

  edgeID | the pentachoron edge to examine; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.

Returns
  `true` if a one-edge boundary component is formed as described above, or `false` otherwise.

## edgeBdryLength2()

bool regina::GluingPermSearcher< 4 >::edgeBdryLength2 | ( | int | edgeID1,
|  | int | edgeID2
| ) |  |

inline protected

Determines whether edges of the linking triangles for each of the given pentachoron edges combine to form an entire two-edge boundary component of the overall 4-manifold edge link, with one edge from each triangle.

See the PentEdgeState class for further information.

Parameters

  edgeID1 | the first pentachoron edge to examine; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.
  edgeID2 | the second pentachoron edge to examine; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.

Returns
  `true` if a two-edge boundary component is formed as described above, or `false` otherwise.

## edgeBdryNext()

void regina::GluingPermSearcher< 4 >::edgeBdryNext | ( | int | edgeID,
|  | int | pent,
|  | int | edge,
|  | int | bdryFacet,
|  | int | next[2],
|  | char | twist[2]
| ) |  |

protected

Assuming the given edge of the linking triangle for the given pentachoron edge lies on the boundary of the link, this routine identifies the adjacent boundary edges of the link in each direction.

The given edge of the linking triangle must belong to one of the two pentachoron facets currently being joined.

The pentachoron edge to examine is passed in edgeID, pent and edge, and the particular edge of the linking triangle to examine is specified by bdryFacet. Details of the adjacent boundary edges are returned in the arrays next and twist.

Note that the values returned might or might not correspond to the bdryNext and bdryTwist arrays of the PentEdgeState class, since the PentEdgeState arrays skip over adjacent edges belonging to the same linking triangle.

If the given edge of the linking triangle is not a boundary edge of the 4-manifold edge link, the behaviour of this routine is undefined.

See the PentEdgeState class for further information.

Precondition
  The pentachoron facet (pent, bdryFacet) is one of the two facets that are currently being joined together. That is, this facet is either order_[orderElt_] or its partner in the underlying pentachoron facet pairing.

Parameters

  edgeID | the pentachoron edge to examine; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.
  pent | the pentachoron described by edgeID; this must be (edgeID / 10). It is passed separately to avoid a slow division operation.
  edge | the pentachoron edge number described by edgeID; this must be (edgeID % 10). It is passed separately to avoid a slow modulus operation.
  bdryFacet | the facet number of the given pentachoron containing the edge of the linking triangle that is under consideration. This must be between 0 and 4 inclusive.
  next | returns the pentachoron edge supplying each adjacent boundary edge of the link; see the PentEdgeState::bdryNext notes for details on which directions correspond to array indices 0 and 1.
  twist | returns whether the orientations of the adjacent boundary edges are consistent with the orientation of this boundary edge; see the PentEdgeState::bdryTwist notes for further information on orientations in the link.

## edgeBdryRestore()

void regina::GluingPermSearcher< 4 >::edgeBdryRestore | ( | int | edgeID | ) |

inline protected

Copies the bdryNextOld and bdryTwistOld arrays to the bdryNext and bdryTwist arrays for the given pentachoron edge.

See the PentEdgeState class for further information.

Parameters

  edgeID | the pentachoron edge on which to operate; this must be between 0 and 10n-1 inclusive, where n is the number of pentachora.

## empty()

bool regina::CensusHits::empty | ( |  | ) | const

inline

Returns whether there are any hits at all.

Returns
  `true` if this list is empty (i.e., there are no hits), or `false` if the list is non-empty (i.e., there are one or more hits).

## EulerSearcher() [1/2]

regina::EulerSearcher::EulerSearcher | ( | int | useEuler,
|  | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | int | whichPurge,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Creates a new search manager that restricts Euler characteristic on the vertex links, as described in the class overview.

For details on how a search manager is used, see the GluingPermSearcher<3> documentation. Note in particular that this class will be automatically used by GluingPermSearcher<3>::findAllPerms() if possible, so there is often no need for an end user to instantiate this class directly.

All constructor arguments except for euler are the same as for the GluingPermSearcher<3> constructor, though some arguments (such as finiteOnly) are not needed here since they are already implied by the specialised search context.

Precondition
  The given Euler characteristic is at most 2.
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.

Parameters

  useEuler | the Euler characteristic that vertex links must have. For boundary vertices, this is the Euler characteristic of the closed surface that would be obtained if the puncture in the vertex link were filled.

## EulerSearcher() [2/2]

regina::EulerSearcher::EulerSearcher | ( | std::istream & | in,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search manager based on data read from the given input stream.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

The arguments use and useArgs are the same as for the GluingPermSearcher<3> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## facetPairing()

template<int dim>

const FacetPairing< dim > * regina::GluingPerms< dim >::facetPairing | ( |  | ) | const

inline

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

Returns
  the corresponding simplex facet pairing.

## filename()

const std::string & regina::CensusDB::filename | ( |  | ) | const

inline

Returns the filename where this database is stored.

Returns
  the database filename.

## findAllPerms() [1/3]

static void regina::GluingPermSearcher< 2 >::findAllPerms | ( | const FacetPairing< 2 > * | pairing,
|  | const FacetPairing< 2 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | GluingPermSearcher< 2 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

The main entry routine for running a search for all gluing permutation sets that complement a given edge pairing.

This routine examines the search parameters, chooses the best possible search algorithm, constructs an object of the corresponding subclass of GluingPermSearcher<2> and then calls runSearch().

See the GluingPermSearcher<2> constructor for documentation on the arguments to this routine. See the runSearch() method for documentation on how the search runs and returns its results.

Precondition
  The given edge pairing is connected, i.e., it is possible to reach any triangle from any other triangle via a series of matched edge pairs.
  The given edge pairing is in canonical form as described by FacetPairing<2>::isCanonical(). Note that all edge pairings constructed by FacetPairing<2>::findAllPairings() are of this form.

## findAllPerms() [2/3]

static void regina::GluingPermSearcher< 3 >::findAllPerms | ( | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | bool | finiteOnly,
|  | int | whichPurge,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

The main entry routine for running a search for all gluing permutation sets that complement a given face pairing.

This routine examines the search parameters, chooses the best possible search algorithm, constructs an object of the corresponding subclass of GluingPermSearcher<3> and then calls runSearch().

See the GluingPermSearcher<3> constructor for documentation on the arguments to this routine. See the runSearch() method for documentation on how the search runs and returns its results.

Precondition
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.

## findAllPerms() [3/3]

static void regina::GluingPermSearcher< 4 >::findAllPerms | ( | const FacetPairing< 4 > * | pairing,
|  | const FacetPairing< 4 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | bool | finiteOnly,
|  | GluingPermSearcher< 4 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

The main entry routine for running a search for all gluing permutation sets that complement a given pentachoron facet pairing.

This routine examines the search parameters, chooses the best possible search algorithm, constructs an object of the corresponding subclass of GluingPermSearcher<4> and then calls runSearch().

See the GluingPermSearcher<4> constructor for documentation on the arguments to this routine. See the runSearch() method for documentation on how the search runs and returns its results.

Precondition
  The given facet pairing is connected, i.e., it is possible to reach any pentachoron from any other pentachoron via a series of matched facet pairs.
  The given facet pairing is in canonical form as described by FacetPairing<4>::isCanonical(). Note that all facet pairings constructed by FacetPairing<4>::findAllPairings() are of this form.

## findEdgeClass() [1/4]

int regina::EulerSearcher::findEdgeClass | ( | int | edgeID | ) | const

inline protected

Returns the representative of the equivalence class containing the given tetrahedron edge.

The class representative is defined to be the root of the corresponding union-find tree.

See the TetEdgeState class for further details. See also the other variant of findEdgeClass(), which is slightly slower but which also tracks edge orientation.

Parameters

  edgeID | the index of a single tetrahedron edge; this must be between 0 and 6t-1 inclusive, where t is the number of tetrahedra. See the TetEdgeState class notes for details on edge indexing.

Returns
  the index of the tetrahedron edge at the root of the union-find tree, i.e., the representative of the equivalence class.

## findEdgeClass() [2/4]

int regina::CompactSearcher::findEdgeClass | ( | int | edgeID | ) | const

inline protected

Returns the representative of the equivalence class containing the given tetrahedron edge.

The class representative is defined to be the root of the corresponding union-find tree.

See the TetEdgeState class for further details. See also the other variant of findEdgeClass(), which is slightly slower but which also tracks edge orientation.

Parameters

  edgeID | the index of a single tetrahedron edge; this must be between 0 and 6t-1 inclusive, where t is the number of tetrahedra. See the TetEdgeState class notes for details on edge indexing.

Returns
  the index of the tetrahedron edge at the root of the union-find tree, i.e., the representative of the equivalence class.

## findEdgeClass() [3/4]

int regina::EulerSearcher::findEdgeClass | ( | int | edgeID,
|  | char & | twisted
| ) |  | const

inline protected

Returns the representative of the equivalence class containing the given tetrahedron edge.

The class representative is defined to be the root of the corresponding union-find tree.

The argument twisted is also modified to indicate whether or not the identification of the given edge with the class representative preserves orientation. Note that this arugment is not initialised. Instead, if the identification is orientation-preserving then twisted will be left unmodified, and if it is orientation-reversing then twisted will be changed from 0 to 1 or vice-versa.

See the TetEdgeState class for further details. See also the other variant of findEdgeClass(), which is slightly faster but which does not track edge orientation.

Parameters

  edgeID | the index of a single tetrahedron edge; this must be between 0 and 6t-1 inclusive, where t is the number of tetrahedra. See the TetEdgeState class notes for details on edge indexing.
  twisted | used to track edge orientation, as described above. This must be either 0 or 1 as it is passed into the function, and it will also be either 0 or 1 upon returning from the function.

Returns
  the index of the tetrahedron edge at the root of the union-find tree, i.e., the representative of the equivalence class.

## findEdgeClass() [4/4]

int regina::CompactSearcher::findEdgeClass | ( | int | edgeID,
|  | char & | twisted
| ) |  | const

inline protected

Returns the representative of the equivalence class containing the given tetrahedron edge.

The class representative is defined to be the root of the corresponding union-find tree.

The argument twisted is also modified to indicate whether or not the identification of the given edge with the class representative preserves orientation. Note that this arugment is not initialised. Instead, if the identification is orientation-preserving then twisted will be left unmodified, and if it is orientation-reversing then twisted will be changed from 0 to 1 or vice-versa.

See the TetEdgeState class for further details. See also the other variant of findEdgeClass(), which is slightly faster but which does not track edge orientation.

Parameters

  edgeID | the index of a single tetrahedron edge; this must be between 0 and 6t-1 inclusive, where t is the number of tetrahedra. See the TetEdgeState class notes for details on edge indexing.
  twisted | used to track edge orientation, as described above. This must be either 0 or 1 as it is passed into the function, and it will also be either 0 or 1 upon returning from the function.

Returns
  the index of the tetrahedron edge at the root of the union-find tree, i.e., the representative of the equivalence class.

## findTriangleClass() [1/2]

int regina::GluingPermSearcher< 4 >::findTriangleClass | ( | int | triID | ) | const

inline protected

Returns the representative of the equivalence class containing the given pentachoron triangle.

The class representative is defined to be the root of the corresponding union-find tree.

See the PentTriangleState class for further details. See also the other variant of findTriangleClass(), which is slower but which also tracks triangle rotations and reflections.

Parameters

  triID | the index of a single pentachoron triangle; this must be between 0 and 10p-1 inclusive, where p is the number of pentachora. See the PentTriangleState class notes for details on triangle indexing.

Returns
  the index of the pentachoron triangle at the root of the union-find tree, i.e., the representative of the equivalence class.

## findTriangleClass() [2/2]

int regina::GluingPermSearcher< 4 >::findTriangleClass | ( | int | triID,
|  | Perm< 3 > & | twist
| ) |  | const

inline protected

Returns the representative of the equivalence class containing the given pentachoron triangle.

The class representative is defined to be the root of the corresponding union-find tree.

The argument twist is also modified to indicate what rotation or reflection is used to identify vertices (0,1,2) of the given triangle with vertices (0,1,2) of the class representative. Note that this argument is not initialised. Instead, the original twist will be multiplied on the left by the mapping described above.

See the PentTriangleState class for further details. See also the other variant of findTriangleClass(), which is faster but which does not track triangle rotations and reflections.

Parameters

  triID | the index of a single pentachoron triangle; this must be between 0 and 10p-1 inclusive, where p is the number of pentachora. See the PentTriangleState class notes for details on triangle indexing.
  twist | used to track triangle rotations and reflections, as described above. This must be a mapping from (0,1,2) to (0,1,2) as it is passed into the function, and it will also be a mapping from (0,1,2) to (0,1,2) upon returning from the function.

Returns
  the index of the pentachoron triangle at the root of the union-find tree, i.e., the representative of the equivalence class.

## first()

CensusHit * regina::CensusHits::first | ( |  | ) | const

inline

Returns the first hit in this list.

To continue iterating, you can call CensusHit::next() upon each individual hit to retrieve the next hit in the list.

Returns
  the first hit, or 0 if there are no hits at all.

## gluingPerm() [1/2]

template<int dim>

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

inline

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

  source | the simplex facet under investigation.

Returns
  the associated gluing permutation.

## gluingPerm() [2/2]

template<int dim>

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

inline

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

  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 associated gluing permutation.

## GluingPerms() [1/3]

template<int dim>

regina::GluingPerms< dim >::GluingPerms | ( | const FacetPairing< dim > * | pairing | ) |

inline protected

Creates a new permutation set.

All internal arrays will be allocated but not initialised.

Precondition
  The given facet pairing is connected, i.e., it is possible to reach any simplex from any other simplex via a series of matched facet pairs.
  The given facet pairing is in canonical form as described by FacetPairing::isCanonical(). Note that all facet pairings constructed by FacetPairing::findAllPairings() are of this form.

Parameters

  pairing | the specific pairing of simplex facets that this permutation set will complement.

## GluingPerms() [2/3]

template<int dim>

regina::GluingPerms< dim >::GluingPerms | ( | const GluingPerms< dim > & | cloneMe | ) |

Creates a new set of gluing permutations that is a clone of the given permutation set.

Parameters

  cloneMe | the gluing permutations to clone.

## GluingPerms() [3/3]

template<int dim>

regina::GluingPerms< dim >::GluingPerms | ( | std::istream & | in | ) |

Reads a new set of gluing permutations from the given input stream.

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

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## GluingPermSearcher() [1/6]

regina::GluingPermSearcher< 2 >::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.

The search is started by calling runSearch(). Note that the static method findAllPerms() handles both construction and searching, and is the preferred entry point for end users.

The arguments to this constructor describe the search parameters in detail, as well as what should be done with each gluing permutation set that is found.

Precondition
  The given edge pairing is connected, i.e., it is possible to reach any triangle from any other triangle via a series of matched edge pairs.
  The given edge pairing is in canonical form as described by FacetPairing<2>::isCanonical(). Note that all edge pairings constructed by FacetPairing<2>::findAllPairings() are of this form.

Parameters

  pairing | the specific pairing of triangle edges that the generated permutation sets will complement.

  autos

  the collection of isomorphisms that define equivalence of permutation sets. These are used by runSearch(), which produces each permutation set precisely once up to equivalence. These isomorphisms must all be automorphisms of the given edge pairing, and will generally be the set of all such automorphisms. This parameter may be 0, in which case the set of all automorphisms of the given edge pairing will be generated and used.

  orientableOnly | `true` if only gluing permutations corresponding to orientable triangulations should be generated, or `false` if no such restriction should be imposed.
  use | the function to call upon each permutation set that is found. The first parameter passed to this function will be a gluing permutation set. The second parameter will be parameter useArgs as was passed to this routine.
  useArgs | the pointer to pass as the final parameter for the function use which will be called upon each permutation set found.

## GluingPermSearcher() [2/6]

regina::GluingPermSearcher< 3 >::GluingPermSearcher | ( | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | bool | finiteOnly,
|  | int | whichPurge,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search for gluing permutation sets.

The search is started by calling runSearch(). Note that the static method findAllPerms() handles both construction and searching, and is the preferred entry point for end users.

The arguments to this constructor describe the search parameters in detail, as well as what should be done with each gluing permutation set that is found.

Parameter whichPurge may be used to avoid constructing permutation sets that correspond to triangulations satisfying certain constraints (such as non-minimality). The use of this parameter, combined with parameters orientableOnly and finiteOnly, can significantly speed up the permutation set generation. For some combinations of these parameters entirely different algorithms are used.

Note that not all permutation sets described by parameter whichPurge will be avoided (i.e., you may get gluing permutation sets that you did not want). It is guaranteed however that every permutation set whose corresonding triangulation does not satisfy the whichPurge constraints will be generated.

Similarly, even if finiteOnly is set to `true`, some non-finite triangulations might still slip through the net (since the full vertex links are not always constructed). However, like whichPurge, setting finiteOnly to `true` allow the census algorithm to take shortcuts and therefore run faster. The resulting triangulations may be tested for finiteness (and other properties) by calling triangulate().

Precondition
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.

Parameters

  pairing | the specific pairing of tetrahedron faces that the generated permutation sets will complement.

  autos

  the collection of isomorphisms that define equivalence of permutation sets. These are used by runSearch(), which produces each permutation set precisely once up to equivalence. These isomorphisms must all be automorphisms of the given face pairing, and will generally be the set of all such automorphisms. This parameter may be 0, in which case the set of all automorphisms of the given face pairing will be generated and used.

  orientableOnly | `true` if only gluing permutations corresponding to orientable triangulations should be generated, or `false` if no such restriction should be imposed.
  finiteOnly | `true` if only gluing permutations corresponding to finite triangulations are required, or `false` if there is no such requirement. Note that regardless of this value, some non-finite triangulations might still be produced; see the notes above for details.

  whichPurge

  specifies which permutation sets we may avoid constructing (see the function notes above for details). This should be a bitwise OR of constants from the PurgeFlags enumeration, or 0 if we should simply generate every possible permutation set. If a variety of purge constants are bitwise ORed together, a permutation set whose triangulation satisfies any of these constraints may be avoided. Note that not all such permutation sets will be avoided, but enough are avoided that the performance increase is noticeable.

  use | the function to call upon each permutation set that is found. The first parameter passed to this function will be a gluing permutation set. The second parameter will be parameter useArgs as was passed to this routine.
  useArgs | the pointer to pass as the final parameter for the function use which will be called upon each permutation set found.

## GluingPermSearcher() [3/6]

regina::GluingPermSearcher< 4 >::GluingPermSearcher | ( | const FacetPairing< 4 > * | pairing,
|  | const FacetPairing< 4 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | bool | finiteOnly,
|  | GluingPermSearcher< 4 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search for gluing permutation sets.

The search is started by calling runSearch(). Note that the static method findAllPerms() handles both construction and searching, and is the preferred entry point for end users.

The arguments to this constructor describe the search parameters in detail, as well as what should be done with each gluing permutation set that is found.

The appropriate use of parameters orientableOnly and finiteOnly can significantly speed up the permutation set generation. For some combinations of these parameters entirely different algorithms are used.

Note that even if finiteOnly is set to `true`, some ideal triangulations might still slip through the net (since the full vertex links are not always constructed). However, setting finiteOnly to `true` will allow the census algorithm to take shortcuts and therefore run faster. The resulting triangulations may be tested for finiteness (and other properties) by calling triangulate().

Precondition
  The given facet pairing is connected, i.e., it is possible to reach any pentachoron from any other pentachoron via a series of matched facet pairs.
  The given facet pairing is in canonical form as described by FacetPairing<4>::isCanonical(). Note that all facet pairings constructed by FacetPairing<4>::findAllPairings() are of this form.

Parameters

  pairing | the specific pairing of pentachoron facets that the generated permutation sets will complement.

  autos

  the collection of isomorphisms that define equivalence of permutation sets. These are used by runSearch(), which produces each permutation set precisely once up to equivalence. These isomorphisms must all be automorphisms of the given facet pairing, and will generally be the set of all such automorphisms. This parameter may be 0, in which case the set of all automorphisms of the given facet pairing will be generated and used.

  orientableOnly | `true` if only gluing permutations corresponding to orientable triangulations should be generated, or `false` if no such restriction should be imposed.
  finiteOnly | `true` if only gluing permutations corresponding to finite (non-ideal) triangulations are required, or `false` if there is no such requirement. Note that regardless of this value, some ideal triangulations might still be produced; see the notes above for details.
  use | the function to call upon each permutation set that is found. The first parameter passed to this function will be a gluing permutation set. The second parameter will be parameter useArgs as was passed to this routine.
  useArgs | the pointer to pass as the final parameter for the function use which will be called upon each permutation set found.

## GluingPermSearcher() [4/6]

regina::GluingPermSearcher< 2 >::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.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.
  use | as for the main GluingPermSearcher<2> constructor.
  useArgs | as for the main GluingPermSearcher<2> constructor.

## GluingPermSearcher() [5/6]

regina::GluingPermSearcher< 3 >::GluingPermSearcher | ( | std::istream & | in,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search manager based on data read from the given input stream.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.
  use | as for the main GluingPermSearcher<3> constructor.
  useArgs | as for the main GluingPermSearcher<3> constructor.

## GluingPermSearcher() [6/6]

regina::GluingPermSearcher< 4 >::GluingPermSearcher | ( | std::istream & | in,
|  | GluingPermSearcher< 4 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search manager based on data read from the given input stream.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.
  use | as for the main GluingPermSearcher<4> constructor.
  useArgs | as for the main GluingPermSearcher<4> constructor.

## gluingToIndex() [1/2]

template<int dim>

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

protected

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

  source | the simplex facet under investigation.
  gluing | a 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]

template<int dim>

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

protected

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

  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; this must be between 0 and dim inclusive.
  gluing | a 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.

## HyperbolicMinSearcher() [1/2]

regina::HyperbolicMinSearcher::HyperbolicMinSearcher | ( | const FacetPairing< 3 > * | pairing,
|  | const FacetPairing< 3 >::IsoList * | autos,
|  | bool | orientableOnly,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Creates a new search manager for use when only minimal ideal triangulations of cusped finite-volume hyperbolic 3-manifolds are required.

Here every vertex link will be a torus or Klein bottle. Note that other unwanted triangulations may still be produced (e.g., non-hyperbolic or non-minimal triangulations), but there will be far fewer of these than when using the GluingPermSearcher<3> class directly.

For details on how a search manager is used, see the GluingPermSearcher<3> documentation.

All constructor arguments are the same as for the GluingPermSearcher<3> constructor, though some arguments (such as finiteOnly and whichPurge) are not needed here since they are already implied by the specialised search context.

Precondition
  The given face pairing is connected, i.e., it is possible to reach any tetrahedron from any other tetrahedron via a series of matched face pairs.
  The given face pairing is in canonical form as described by FacetPairing<3>::isCanonical(). Note that all face pairings constructed by FacetPairing<3>::findAllPairings() are of this form.
  The given face pairing has no boundary faces.

## HyperbolicMinSearcher() [2/2]

regina::HyperbolicMinSearcher::HyperbolicMinSearcher | ( | std::istream & | in,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

Initialises a new search manager based on data read from the given input stream.

This may be a new search or a partially completed search.

This routine reads data in the format written by dumpData(). If you wish to read data whose precise class is unknown, consider using dumpTaggedData() and readTaggedData() instead.

If the data found in the input stream is invalid or incorrectly formatted, the routine inputError() will return `true` but the contents of this object will be otherwise undefined.

The arguments use and useArgs are the same as for the GluingPermSearcher<3> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## indexToGluing() [1/2]

template<int dim>

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

inline protected

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

  source | the simplex facet under investigation.
  index | an 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]

template<int dim>

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

inline protected

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

  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; this must be between 0 and dim inclusive.
  index | an 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()

template<int dim>

bool regina::GluingPerms< dim >::inputError | ( |  | ) | const

inline

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.

## isCanonical() [1/3]

bool regina::GluingPermSearcher< 2 >::isCanonical | ( |  | ) | const

protected

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

Returns
  `true` if the current set is in canonical form, or `false` otherwise.

## isCanonical() [2/3]

bool regina::GluingPermSearcher< 3 >::isCanonical | ( |  | ) | const

protected

Compares the current set of gluing permutations with its preimage under each automorphism of the underlying face pairing, in order to see whether the current set is in canonical form (i.e., is lexicographically smallest).

Returns
  `true` if the current set is in canonical form, or `false` otherwise.

## isCanonical() [3/3]

bool regina::GluingPermSearcher< 4 >::isCanonical | ( |  | ) | const

protected

Compares the current set of gluing permutations with its preimage under each automorphism of the underlying facet pairing, in order to see whether the current set is in canonical form (i.e., is lexicographically smallest).

Returns
  `true` if the current set is in canonical form, or `false` otherwise.

## lookup() [1/3]

static CensusHits* regina::Census::lookup | ( | const std::string & | isoSig | ) |

static

Searches for the given triangulation through all of Regina's in-built census databases.

For this routine you specify the triangulation by giving its isomorphism signature, as returned by Triangulation<3>::isoSig(). This is faster than the variant lookup(const Triangulation<3>&), since Regina's census databases store isomorphism signatures internally. If you do not already know the isomorphism signature, it is fine to just call lookup(const Triangulation<3>&) instead.

Note that there may be many hits (possibly from multiple databases, and in some cases possibly even within the same database). The list of hits will be returned as a CensusHits object, which you can use to iterate through the individual matches. Even if there are no matches at all, a CensusHits object will still be returned; you can call CensusHits::empty() to test whether any matches were found.

The CensusHits object that is returned will be newly allocated, and it is the caller's responsibility to destroy it.

This routine is fast: it first computes the isomorphism signature of the triangulation, and then performs a logarithmic-time lookup in each database (here "logarithmic" means logarithmic in the size of the database).

Parameters

  isoSig | the isomorphism signature of the triangulation that you wish to search for.

Returns
  a newly created list of all database matches.

## lookup() [2/3]

bool regina::CensusDB::lookup | ( | const std::string & | isoSig,
|  | CensusHits * | hits
| ) |  | const

Searches for the given isomorphism signature in this database.

All matches (if any) will be appended to the given list of hits.

Note that the database will be opened and closed every time this routine is called.

Parameters

  isoSig | the isomorphism signature to search for.
  hits | the list of hits to which all matches will be appended.

Returns
  `true` if the lookup was correctly performed, or `false` if some error occurred (e.g., the database could not be opened). Note in particular that if there were no matches but no errors, then the return value will be `true`.

## lookup() [3/3]

static CensusHits* regina::Census::lookup | ( | const Triangulation< 3 > & | tri | ) |

static

Searches for the given triangulation through all of Regina's in-built census databases.

Internally, the census databases store isomorphism signatures as opposed to fully fleshed-out triangulations. If you already have the isomorphism signature of the triangulation, then you can call the variant lookup(const std::string&) instead, which will be faster since it avoids some extra overhead.

Note that there may be many hits (possibly from multiple databases, and in some cases possibly even within the same database). The list of hits will be returned as a CensusHits object, which you can use to iterate through the individual matches. Even if there are no matches at all, a CensusHits object will still be returned; you can call CensusHits::empty() to test whether any matches were found.

The CensusHits object that is returned will be newly allocated, and it is the caller's responsibility to destroy it.

This routine is fast: it first computes the isomorphism signature of the triangulation, and then performs a logarithmic-time lookup in each database (here "logarithmic" means logarithmic in the size of the database).

Parameters

  tri | the triangulation that you wish to search for.

Returns
  a newly created list of all database matches.

## lowDegreeEdge()

bool regina::GluingPermSearcher< 3 >::lowDegreeEdge | ( | const FacetSpec< 3 > & | face,
|  | bool | testDegree12,
|  | bool | testDegree3
| ) |  | const

protected

Determines whether the permutations already constructed model a triangulation with a low degree edge.

Precisely which types of low degree edges are identified must be specified through parameters testDegree12 and testDegree3.

Tests that do not refer to the gluing permutation for the given face will not be run.

This routine is not fussy about the order in which gluing permutations are selected, as long as permutations not yet selected have the corresponding element of permIndices[] set to -1.

Parameters

  face | the specific tetrahedron face upon which tests will be based.
  testDegree12 | `true` if we should test for non-boundary edges of degree 1 or 2.
  testDegree3 | `true` if we should test for non-boundary edges of degree 3 involving three distinct tetrahedra.

Returns
  `true` if the permutations under construction will lead to a low-degree edge as specified by parameters testDegree12 and testDegree3, or `false` if no such edge is found.

## mergeEdgeClasses() [1/3]

bool regina::GluingPermSearcher< 4 >::mergeEdgeClasses | ( |  | ) |

protected

Merges the classes of pentachoron edges as required by the new gluing made at stage orderElt of the search.

See the PentEdgeState class for details.

This routine returns a boolean that indicates whether this merge creates an invalid edge (i.e., an edge with identified with itself in reverse, or whose link is something other than a (possibly) punctured 2-sphere).

Returns
  `true` if this merge creates an invalid edge, or `false` if not.

## mergeEdgeClasses() [2/3]

bool regina::EulerSearcher::mergeEdgeClasses | ( |  | ) |

protected

Merge the classes of tetrahedron edges as required by the new gluing made at stage orderElt of the search.

See the TetEdgeState class for details.

This routine returns a boolean that indicates whether this merge creates an invalid edge (i.e., an edge identified with itself in reverse).

Returns
  `true` if this merge creates an invalid edge, or `false` if not.

## mergeEdgeClasses() [3/3]

bool regina::CompactSearcher::mergeEdgeClasses | ( |  | ) |

protected

Merge the classes of tetrahedron edges as required by the new gluing made at stage orderElt of the search.

See the TetEdgeState class for details.

This routine returns a boolean that indicates whether this merge creates an invalid edge (i.e., an edge identified with itself in reverse).

Returns
  `true` if this merge creates an invalid edge, or `false` if not.

## mergeTriangleClasses()

bool regina::GluingPermSearcher< 4 >::mergeTriangleClasses | ( |  | ) |

protected

Merges the classes of pentachoron triangles as required by the new gluing made at stage orderElt of the search.

See the PentTriangleState class for details.

This routine returns a boolean that indicates whether this merge creates an invalid triangle (i.e., a triangle identified with itself using a non-trivial rotation or reflection).

Returns
  `true` if this merge creates an invalid triangle, or `false` if not.

## mergeVertexClasses() [1/2]

int regina::EulerSearcher::mergeVertexClasses | ( |  | ) |

protected

Merge the classes of tetrahedron vertices as required by the new gluing made at stage orderElt of the search.

See the TetVertexState class for details.

This routine returns a bitwise (OR) combination of the VLINK_... flags defined earlier in this class. These flags describe what happened to the vertex links during this particular merge. In particular, they note when a vertex link is closed off, or enters a state where it will be forced to have the wrong Euler characteristic.

Returns
  a combination of VLINK_... flags describing how the vertex links were changed, or 0 if none of the changes described by these flags were observed.

## mergeVertexClasses() [2/2]

int regina::CompactSearcher::mergeVertexClasses | ( |  | ) |

protected

Merge the classes of tetrahedron vertices as required by the new gluing made at stage orderElt of the search.

See the TetVertexState class for details.

This routine returns a bitwise (OR) combination of the VLINK_... flags defined earlier in this class. These flags describe what happened to the vertex links during this particular merge. In particular, they note when a vertex link is closed off, or is made into something other than a punctured 2-sphere.

Returns
  a combination of VLINK_... flags describing how the vertex links were changed, or 0 if none of the changes described by these flags were observed.

## name()

const std::string & regina::CensusHit::name | ( |  | ) | const

inline

Returns the human-readable name associated with the triangulation in the database.

This typically contains the name of the triangulation and/or the name of the underlying manifold.

Returns
  the human-readable name for this hit.

## next()

const CensusHit * regina::CensusHit::next | ( |  | ) | const

inline

Returns the next hit for the same triangulation, or 0 if there are no more hits.

Recall that hits are typically returned using the CensusHits class, which stores a list of individual CensusHit objects. To iterate through this list, you should begin by calling CensusHits::first() to retrieve the first hit, and then for each hit call CensusHit::next() (this function) to retrieve the next hit.

Returns
  the next hit after this in the list, or 0 if this is the last hit.

## PentEdgeState()

regina::GluingPermSearcher< 4 >::PentEdgeState::PentEdgeState | ( |  | ) |

inline

Constructor for a standalone pentachoron edge in an equivalence class all of its own.

Note that the edge link will be a single triangle with three boundary edges.

## PentTriangleState()

regina::GluingPermSearcher< 4 >::PentTriangleState::PentTriangleState | ( |  | ) |

inline

Constructor for a standalone pentachoron triangle in an equivalence class all of its own.

## permIndex() [1/4]

template<int dim>

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

inline protected

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

  source | the simplex facet under investigation.

Returns
  a reference to the corresponding array index.

## permIndex() [2/4]

template<int dim>

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

inline protected

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

  source | the simplex facet under investigation.

Returns
  a reference to the corresponding array index.

## permIndex() [3/4]

template<int dim>

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

inline protected

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

  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
  a reference to the corresponding array index.

## permIndex() [4/4]

template<int dim>

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

inline protected

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

  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
  a reference to the corresponding array index.

## readData() [1/6]

bool regina::GluingPermSearcher< 4 >::PentEdgeState::readData | ( | std::istream & | in,
|  | unsigned long | nStates
| ) |  |

Fills this state with data read from the given input stream.

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

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

This routine does test for bad input data, but it does not test for end-of-file.

Parameters

  in | the input stream from which to read.
  nStates | the total number of edge states under consideration (this must be ten times the number of tetrahedra).

Returns
  `false` if any errors were encountered during reading, or `true` otherwise.

## readData() [2/6]

bool regina::GluingPermSearcher< 4 >::PentTriangleState::readData | ( | std::istream & | in,
|  | unsigned long | nStates
| ) |  |

Fills this state with data read from the given input stream.

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

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

This routine does test for bad input data, but it does not test for end-of-file.

Parameters

  in | the input stream from which to read.
  nStates | the total number of triangle states under consideration (this must be ten times the number of pentachora).

Returns
  `false` if any errors were encountered during reading, or `true` otherwise.

## readData() [3/6]

bool regina::EulerSearcher::TetVertexState::readData | ( | std::istream & | in,
|  | unsigned long | nStates
| ) |  |

Fills this state with data read from the given input stream.

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

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

This routine does test for bad input data, but it does not test for end-of-file.

Parameters

  in | the input stream from which to read.
  nStates | the total number of vertex states under consideration (this must be four times the number of tetrahedra).

Returns
  `false` if any errors were encountered during reading, or `true` otherwise.

## readData() [4/6]

bool regina::CompactSearcher::TetVertexState::readData | ( | std::istream & | in,
|  | unsigned long | nStates
| ) |  |

Fills this state with data read from the given input stream.

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

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

This routine does test for bad input data, but it does not test for end-of-file.

Parameters

  in | the input stream from which to read.
  nStates | the total number of vertex states under consideration (this must be four times the number of tetrahedra).

Returns
  `false` if any errors were encountered during reading, or `true` otherwise.

## readData() [5/6]

bool regina::EulerSearcher::TetEdgeState::readData | ( | std::istream & | in,
|  | unsigned | nTets
| ) |  |

Fills this state with data read from the given input stream.

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

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

This routine does test for bad input data, but it does not test for end-of-file.

Parameters

  in | the input stream from which to read.
  nTets | the number of tetrahedra under consideration in the census.

Returns
  `false` if any errors were encountered during reading, or `true` otherwise.

## readData() [6/6]

bool regina::CompactSearcher::TetEdgeState::readData | ( | std::istream & | in,
|  | unsigned | nTets
| ) |  |

Fills this state with data read from the given input stream.

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

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

This routine does test for bad input data, but it does not test for end-of-file.

Parameters

  in | the input stream from which to read.
  nTets | the number of tetrahedra under consideration in the census.

Returns
  `false` if any errors were encountered during reading, or `true` otherwise.

## readTaggedData() [1/3]

static GluingPermSearcher<2>* regina::GluingPermSearcher< 2 >::readTaggedData | ( | std::istream & | in,
|  | GluingPermSearcher< 2 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

Creates a new search manager based on tagged data read from the given input stream.

This may be a new search or a partially completed search.

The tagged data should be in the format written by dumpTaggedData(). The precise class of the search manager will be determined from the tagged data, and does not need to be known in advance. This is in contrast to dumpData() and the input stream constructors, where the class of the data being read must be known at compile time.

If the data found in the input stream is invalid or incorrectly formatted, a null pointer will be returned. Otherwise a newly constructed search manager will be returned, and it is the responsibility of the caller of this routine to destroy it after use.

The arguments use and useArgs are the same as for the GluingPermSearcher<2> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## readTaggedData() [2/3]

static GluingPermSearcher<3>* regina::GluingPermSearcher< 3 >::readTaggedData | ( | std::istream & | in,
|  | GluingPermSearcher< 3 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

Creates a new search manager based on tagged data read from the given input stream.

This may be a new search or a partially completed search.

The tagged data should be in the format written by dumpTaggedData(). The precise class of the search manager will be determined from the tagged data, and does not need to be known in advance. This is in contrast to dumpData() and the input stream constructors, where the class of the data being read must be known at compile time.

If the data found in the input stream is invalid or incorrectly formatted, a null pointer will be returned. Otherwise a newly constructed search manager will be returned, and it is the responsibility of the caller of this routine to destroy it after use.

The arguments use and useArgs are the same as for the GluingPermSearcher<3> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## readTaggedData() [3/3]

static GluingPermSearcher<4>* regina::GluingPermSearcher< 4 >::readTaggedData | ( | std::istream & | in,
|  | GluingPermSearcher< 4 >::Use | use,
|  | void * | useArgs = `0`
| ) |  |

static

Creates a new search manager based on tagged data read from the given input stream.

This may be a new search or a partially completed search.

The tagged data should be in the format written by dumpTaggedData(). The precise class of the search manager will be determined from the tagged data, and does not need to be known in advance. This is in contrast to dumpData() and the input stream constructors, where the class of the data being read must be known at compile time.

If the data found in the input stream is invalid or incorrectly formatted, a null pointer will be returned. Otherwise a newly constructed search manager will be returned, and it is the responsibility of the caller of this routine to destroy it after use.

The arguments use and useArgs are the smae as for the GluingPermSearcher<4> constructor.

Warning
  The data format is liable to change between Regina releases. Data in this format should be used on a short-term temporary basis only.

Parameters

  in | the input stream from which to read.

## runSearch() [1/7]

virtual void regina::GluingPermSearcher< 2 >::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given edge pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<2> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

## runSearch() [2/7]

virtual void regina::GluingPermSearcher< 3 >::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given face pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<3> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

Reimplemented in regina::HyperbolicMinSearcher, regina::ClosedPrimeMinSearcher, regina::CompactSearcher, and regina::EulerSearcher.

## runSearch() [3/7]

virtual void regina::GluingPermSearcher< 4 >::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given facet pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<4> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

## runSearch() [4/7]

virtual void regina::EulerSearcher::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given face pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<3> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

Reimplemented from regina::GluingPermSearcher< 3 >.

Reimplemented in regina::HyperbolicMinSearcher.

## runSearch() [5/7]

virtual void regina::CompactSearcher::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given face pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<3> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

Reimplemented from regina::GluingPermSearcher< 3 >.

Reimplemented in regina::ClosedPrimeMinSearcher.

## runSearch() [6/7]

virtual void regina::ClosedPrimeMinSearcher::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given face pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<3> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

Reimplemented from regina::CompactSearcher.

## runSearch() [7/7]

virtual void regina::HyperbolicMinSearcher::runSearch | ( | long | maxDepth = `-1` | ) |

virtual

Generates all possible gluing permutation sets that satisfy the current search criteria.

The search criteria are specified in the class constructor, or through the static method findAllPerms().

Each set of gluing permutations will be produced precisely once up to equivalence, where equivalence is defined by the given set of automorphisms of the given face pairing.

For each permutation set that is generated, routine use_ (as passed to the class constructor) will be called with that permutation set as an argument.

Once the generation of permutation sets has finished, routine use_ will be called once more, this time with `null` as its first (permutation set) argument.

Subclasses corresponding to more specialised search criteria should override this routine to use a better optimised algorithm where possible.

It is possible to run only a partial search, branching to a given depth but no further. In this case, rather than producing complete gluing permutation sets, the search will produce a series of partially-complete GluingPermSearcher<3> objects. These partial searches may then be restarted by calling runSearch() once more (usually after being frozen or passed on to a different processor). If necessary, the use_ routine may call completePermSet() to distinguish between a complete set of gluing permutations and a partial search state.

Note that a restarted search will never drop below its initial depth. That is, calling runSearch() with a fixed depth can be used to subdivide the overall search space into many branches, and then calling runSearch() on each resulting partial search will complete each of these branches without overlap.

Todo:
  Feature: Allow cancellation of permutation set generation.

Parameters

  maxDepth | the depth of the partial search to run, or a negative number if a full search should be run (the default).

Reimplemented from regina::EulerSearcher.

## size()

template<int dim>

unsigned regina::GluingPerms< dim >::size | ( |  | ) | const

inline

Returns the total number of simplices under consideration.

Returns
  the number of simplices under consideration.

## splitEdgeClasses() [1/3]

void regina::GluingPermSearcher< 4 >::splitEdgeClasses | ( |  | ) |

protected

Splits the classes of pentachoron edges to mirror the undoing of the gluing at stage orderElt of the search.

See the PentEdgeState class for details.

## splitEdgeClasses() [2/3]

void regina::EulerSearcher::splitEdgeClasses | ( |  | ) |

protected

Split the classes of tetrahedron edges to mirror the undoing of the gluing at stage orderElt of the search.

See the TetEdgeState class for details.

## splitEdgeClasses() [3/3]

void regina::CompactSearcher::splitEdgeClasses | ( |  | ) |

protected

Split the classes of tetrahedron edges to mirror the undoing of the gluing at stage orderElt of the search.

See the TetEdgeState class for details.

## splitTriangleClasses()

void regina::GluingPermSearcher< 4 >::splitTriangleClasses | ( |  | ) |

protected

Splits the classes of pentachoron triangles to mirror the undoing of the gluing at stage orderElt of the search.

See the PentTriangleState class for details.

## splitVertexClasses() [1/2]

void regina::EulerSearcher::splitVertexClasses | ( |  | ) |

protected

Split the classes of tetrahedron vertices to mirror the undoing of the gluing at stage orderElt of the search.

See the TetVertexState class for details.

## splitVertexClasses() [2/2]

void regina::CompactSearcher::splitVertexClasses | ( |  | ) |

protected

Split the classes of tetrahedron vertices to mirror the undoing of the gluing at stage orderElt of the search.

See the TetVertexState class for details.

## TetEdgeState() [1/2]

regina::EulerSearcher::TetEdgeState::TetEdgeState | ( |  | ) |

inline

Constructor for a standalone tetrahedron edge in an equivalence class all of its own.

## TetEdgeState() [2/2]

regina::CompactSearcher::TetEdgeState::TetEdgeState | ( |  | ) |

inline

Constructor for a standalone tetrahedron edge in an equivalence class all of its own.

## TetVertexState() [1/2]

regina::EulerSearcher::TetVertexState::TetVertexState | ( |  | ) |

inline

Constructor for a standalone tetrahedron vertex in an equivalence class all of its own.

Note that the vertex link will be a single triangle with three boundary edges.

## TetVertexState() [2/2]

regina::CompactSearcher::TetVertexState::TetVertexState | ( |  | ) |

inline

Constructor for a standalone tetrahedron vertex in an equivalence class all of its own.

Note that the vertex link will be a single triangle with three boundary edges.

## triangulate()

template<int dim>

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

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.

## vtxBdryBackup() [1/2]

void regina::EulerSearcher::vtxBdryBackup | ( | int | vertexID | ) |

inline protected

Copies the bdryNext and bdryTwist arrays to the bdryNextOld and bdryTwistOld arrays for the given tetrahedron vertex.

See the TetVertexState class for further information.

Parameters

  vertexID | the tetrahedron vertex on which to operate; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

## vtxBdryBackup() [2/2]

void regina::CompactSearcher::vtxBdryBackup | ( | int | vertexID | ) |

inline protected

Copies the bdryNext and bdryTwist arrays to the bdryNextOld and bdryTwistOld arrays for the given tetrahedron vertex.

See the TetVertexState class for further information.

Parameters

  vertexID | the tetrahedron vertex on which to operate; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

## vtxBdryConsistencyCheck() [1/2]

void regina::EulerSearcher::vtxBdryConsistencyCheck | ( |  | ) |

protected

Runs a number of tests on all tetrahedron vertices to locate consistency errors in the bdryEdges, bdryNext and bdryTwist members of the TetVertexState class.

Any errors that are identified will be written to standard error. Note that some errors might be harmless (for instance, when a call to mergeVertexClasses() leaves processing incomplete because it has located a bad vertex link and expects the merge to be immediately undone).

## vtxBdryConsistencyCheck() [2/2]

void regina::CompactSearcher::vtxBdryConsistencyCheck | ( |  | ) |

protected

Runs a number of tests on all tetrahedron vertices to locate consistency errors in the bdryEdges, bdryNext and bdryTwist members of the TetVertexState class.

Any errors that are identified will be written to standard error. Note that some errors might be harmless (for instance, when a call to mergeVertexClasses() leaves processing incomplete because it has located a bad vertex link and expects the merge to be immediately undone).

## vtxBdryDump() [1/2]

void regina::EulerSearcher::vtxBdryDump | ( | std::ostream & | out | ) |

protected

Dumps a summary of bdryNext, bdryTwist and bdryEdges for every vertex of every tetrahedron to the given output stream.

The output format is relatively compact, and is subject to change in future versions of Regina. The output uses one line only, and a final newline is written.

See the TetVertexState class for further information.

Parameters

  out | the output stream to which to write.

## vtxBdryDump() [2/2]

void regina::CompactSearcher::vtxBdryDump | ( | std::ostream & | out | ) |

protected

Dumps a summary of bdryNext, bdryTwist and bdryEdges for every vertex of every tetrahedron to the given output stream.

The output format is relatively compact, and is subject to change in future versions of Regina. The output uses one line only, and a final newline is written.

See the TetVertexState class for further information.

Parameters

  out | the output stream to which to write.

## vtxBdryFixAdj() [1/2]

void regina::EulerSearcher::vtxBdryFixAdj | ( | int | vertexID | ) |

inline protected

Adjusts the bdryNext and bdryTwist arrays for nearby tetrahedron vertices, to ensure that these arrays are consistent with the bdryNext and bdryTwist arrays stored with the given vertex.

It is assumed that the vertex linking triangle for the given tetrahedron vertex contributes at least one boundary edge to the vertex link. Recall from the TetVertexState class notes that the bdryNext and bdryTwist arrays for the given vertex describe the boundary edges that follow on in either direction from the boundary edges supplied by this triangle.

This routine locates the tetrahedron vertices that provide the neighbouring boundary edges, and adjusts the bdryNext and bdryTwist arrays for these neighbouring vertices to point back to the given vertex.

This routine is intended to assist with backtracking. This routine is safe to use if the given tetrahedron vertex points to itself (i.e., it provides a complete boundary cycle of three edges in the vertex link).

See the TetVertexState class for further information.

Precondition
  The vertex linking triangle for the given tetrahedron vertex contributes at least one boundary edge to the vertex link.

Parameters

  vertexID | the tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

## vtxBdryFixAdj() [2/2]

void regina::CompactSearcher::vtxBdryFixAdj | ( | int | vertexID | ) |

inline protected

Adjusts the bdryNext and bdryTwist arrays for nearby tetrahedron vertices, to ensure that these arrays are consistent with the bdryNext and bdryTwist arrays stored with the given vertex.

It is assumed that the vertex linking triangle for the given tetrahedron vertex contributes at least one boundary edge to the vertex link. Recall from the TetVertexState class notes that the bdryNext and bdryTwist arrays for the given vertex describe the boundary edges that follow on in either direction from the boundary edges supplied by this triangle.

This routine locates the tetrahedron vertices that provide the neighbouring boundary edges, and adjusts the bdryNext and bdryTwist arrays for these neighbouring vertices to point back to the given vertex.

This routine is intended to assist with backtracking. This routine is safe to use if the given tetrahedron vertex points to itself (i.e., it provides a complete boundary cycle of three edges in the vertex link).

See the TetVertexState class for further information.

Precondition
  The vertex linking triangle for the given tetrahedron vertex contributes at least one boundary edge to the vertex link.

Parameters

  vertexID | the tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

## vtxBdryJoin() [1/2]

void regina::EulerSearcher::vtxBdryJoin | ( | int | vertexID,
|  | char | end,
|  | int | adjVertexID,
|  | char | twist
| ) |  |

inline protected

Signifies that the boundary edges supplied by the vertex linking triangles for the two given tetrahedron vertices should be marked as adjacent.

The bdryNext and bdryTwist arrays for each vertex will be adjusted to point to the other.

See the TetVertexState class for details.

Parameters

  vertexID | the first tetrahedron vertex on which to operate; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  end | specifies in which direction the adjacent boundary edges lie. This must be either 0 or 1, and its value should correspond to the relevant index in the bdryNext and bdryTwist arrays for vertex vertexID.
  adjVertexID | the tetrahedron vertex whose boundary edges are adjacent to the boundary edges supplied by vertexID; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  twist | 0 if the orientations of the two boundary segments of vertex link are oriented in the same direction, or 1 if they are oriented in opposite directions; see the bdryTwist documentation for details.

## vtxBdryJoin() [2/2]

void regina::CompactSearcher::vtxBdryJoin | ( | int | vertexID,
|  | char | end,
|  | int | adjVertexID,
|  | char | twist
| ) |  |

inline protected

Signifies that the boundary edges supplied by the vertex linking triangles for the two given tetrahedron vertices should be marked as adjacent.

The bdryNext and bdryTwist arrays for each vertex will be adjusted to point to the other.

See the TetVertexState class for details.

Parameters

  vertexID | the first tetrahedron vertex on which to operate; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  end | specifies in which direction the adjacent boundary edges lie. This must be either 0 or 1, and its value should correspond to the relevant index in the bdryNext and bdryTwist arrays for vertex vertexID.
  adjVertexID | the tetrahedron vertex whose boundary edges are adjacent to the boundary edges supplied by vertexID; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  twist | 0 if the orientations of the two boundary segments of vertex link are oriented in the same direction, or 1 if they are oriented in opposite directions; see the bdryTwist documentation for details.

## vtxBdryLength1() [1/2]

bool regina::EulerSearcher::vtxBdryLength1 | ( | int | vertexID | ) |

inline protected

Determines whether one of the edges of the vertex linking triangle for the given tetrahedron vertex in fact forms an entire one-edge boundary component of the overall vertex link.

See the TetVertexState class for further information.

Parameters

  vertexID | the tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

Returns
  `true` if a one-edge boundary component is formed as described above, or `false` otherwise.

## vtxBdryLength1() [2/2]

bool regina::CompactSearcher::vtxBdryLength1 | ( | int | vertexID | ) |

inline protected

Determines whether one of the edges of the vertex linking triangle for the given tetrahedron vertex in fact forms an entire one-edge boundary component of the overall vertex link.

See the TetVertexState class for further information.

Parameters

  vertexID | the tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

Returns
  `true` if a one-edge boundary component is formed as described above, or `false` otherwise.

## vtxBdryLength2() [1/2]

bool regina::EulerSearcher::vtxBdryLength2 | ( | int | vertexID1,
|  | int | vertexID2
| ) |  |

inline protected

Determines whether edges of the vertex linking triangles for each of the given tetrahedron vertices combine to form an entire two-edge boundary component of the overall vertex link, with one edge from each triangle.

See the TetVertexState class for further information.

Parameters

  vertexID1 | the first tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  vertexID2 | the second tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

Returns
  `true` if a two-edge boundary component is formed as described above, or `false` otherwise.

## vtxBdryLength2() [2/2]

bool regina::CompactSearcher::vtxBdryLength2 | ( | int | vertexID1,
|  | int | vertexID2
| ) |  |

inline protected

Determines whether edges of the vertex linking triangles for each of the given tetrahedron vertices combine to form an entire two-edge boundary component of the overall vertex link, with one edge from each triangle.

See the TetVertexState class for further information.

Parameters

  vertexID1 | the first tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  vertexID2 | the second tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

Returns
  `true` if a two-edge boundary component is formed as described above, or `false` otherwise.

## vtxBdryNext() [1/2]

void regina::EulerSearcher::vtxBdryNext | ( | int | vertexID,
|  | int | tet,
|  | int | vertex,
|  | int | bdryFace,
|  | int | next[2],
|  | char | twist[2]
| ) |  |

inline protected

Assuming the given edge of the vertex linking triangle for the given tetrahedron vertex lies on the boundary of the vertex link, this routine identifies the adjacent boundary edges of the vertex link in each direction.

The given edge of the vertex linking triangle must belong to one of the two tetrahedron faces currently being joined.

The tetrahedron vertex to examine is passed in vertexID, tet and vertex, and the particular edge of the vertex linking triangle to examine is specified by bdryFace. Details of the adjacent boundary edges are returned in the arrays next and twist.

Note that the values returned might or might not correspond to the bdryNext and bdryTwist arrays of the TetVertexState class, since the TetVertexState arrays skip over adjacent edges belonging to the same vertex linking triangle.

If the given edge of the vertex linking triangle is not a boundary edge of the vertex link, the behaviour of this routine is undefined.

See the TetVertexState class for further information.

Precondition
  The tetrahedron face (tet, bdryFace) is one of the two faces that are currently being joined together. That is, this face is either order[orderElt] or its partner in the underlying face pairing.

Parameters

  vertexID | the tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  tet | the tetrahedron described by vertexID; this must be (vertexID / 4). It is passed separately to avoid a slow division operation.
  vertex | the tetrahedron vertex number described by vertexID; this must be (vertexID % 4). It is passed separately to avoid a slow modulus operation.
  bdryFace | the face number of the given tetrahedron containing the edge of the vertex linking triangle that is under consideration. This must be between 0 and 3 inclusive, and it may not be equal to vertex.
  next | returns the tetrahedron vertex supplying each adjacent boundary edge; see the TetVertexState::bdryNext notes for details on which directions correspond to array indices 0 and 1.
  twist | returns whether the orientations of the adjacent boundary edges are consistent with the orientation of this boundary edge; see the TetVertexState::bdryTwist notes for further information on orientations in the vertex link.

## vtxBdryNext() [2/2]

void regina::CompactSearcher::vtxBdryNext | ( | int | vertexID,
|  | int | tet,
|  | int | vertex,
|  | int | bdryFace,
|  | int | next[2],
|  | char | twist[2]
| ) |  |

inline protected

Assuming the given edge of the vertex linking triangle for the given tetrahedron vertex lies on the boundary of the vertex link, this routine identifies the adjacent boundary edges of the vertex link in each direction.

The given edge of the vertex linking triangle must belong to one of the two tetrahedron faces currently being joined.

The tetrahedron vertex to examine is passed in vertexID, tet and vertex, and the particular edge of the vertex linking triangle to examine is specified by bdryFace. Details of the adjacent boundary edges are returned in the arrays next and twist.

Note that the values returned might or might not correspond to the bdryNext and bdryTwist arrays of the TetVertexState class, since the TetVertexState arrays skip over adjacent edges belonging to the same vertex linking triangle.

If the given edge of the vertex linking triangle is not a boundary edge of the vertex link, the behaviour of this routine is undefined.

See the TetVertexState class for further information.

Precondition
  The tetrahedron face (tet, bdryFace) is one of the two faces that are currently being joined together. That is, this face is either order[orderElt] or its partner in the underlying face pairing.

Parameters

  vertexID | the tetrahedron vertex to examine; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.
  tet | the tetrahedron described by vertexID; this must be (vertexID / 4). It is passed separately to avoid a slow division operation.
  vertex | the tetrahedron vertex number described by vertexID; this must be (vertexID % 4). It is passed separately to avoid a slow modulus operation.
  bdryFace | the face number of the given tetrahedron containing the edge of the vertex linking triangle that is under consideration. This must be between 0 and 3 inclusive, and it may not be equal to vertex.
  next | returns the tetrahedron vertex supplying each adjacent boundary edge; see the TetVertexState::bdryNext notes for details on which directions correspond to array indices 0 and 1.
  twist | returns whether the orientations of the adjacent boundary edges are consistent with the orientation of this boundary edge; see the TetVertexState::bdryTwist notes for further information on orientations in the vertex link.

## vtxBdryRestore() [1/2]

void regina::EulerSearcher::vtxBdryRestore | ( | int | vertexID | ) |

inline protected

Copies the bdryNextOld and bdryTwistOld arrays to the bdryNext and bdryTwist arrays for the given tetrahedron vertex.

See the TetVertexState class for further information.

Parameters

  vertexID | the tetrahedron vertex on which to operate; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

## vtxBdryRestore() [2/2]

void regina::CompactSearcher::vtxBdryRestore | ( | int | vertexID | ) |

inline protected

Copies the bdryNextOld and bdryTwistOld arrays to the bdryNext and bdryTwist arrays for the given tetrahedron vertex.

See the TetVertexState class for further information.

Parameters

  vertexID | the tetrahedron vertex on which to operate; this must be between 0 and 4n-1 inclusive, where n is the number of tetrahedra.

## ~CensusHits()

regina::CensusHits::~CensusHits | ( |  | ) |

inline

Destroys this object and all of the individual CensusHit objects that it contains.

## ~ClosedPrimeMinSearcher()

regina::ClosedPrimeMinSearcher::~ClosedPrimeMinSearcher | ( |  | ) |

inline virtual

Destroys this search manager and all supporting data structures.

## ~CompactSearcher()

regina::CompactSearcher::~CompactSearcher | ( |  | ) |

inline virtual

Destroys this search manager and all supporting data structures.

## ~EulerSearcher()

regina::EulerSearcher::~EulerSearcher | ( |  | ) |

inline virtual

Destroys this search manager and all supporting data structures.

## ~GluingPerms()

template<int dim>

regina::GluingPerms< dim >::~GluingPerms | ( |  | ) |

inline virtual

Deallocates any memory used by this structure.

## ~GluingPermSearcher() [1/3]

virtual regina::GluingPermSearcher< 2 >::~GluingPermSearcher | ( |  | ) |

virtual

Destroys this search manager and all supporting data structures.

## ~GluingPermSearcher() [2/3]

virtual regina::GluingPermSearcher< 3 >::~GluingPermSearcher | ( |  | ) |

virtual

Destroys this search manager and all supporting data structures.

## ~GluingPermSearcher() [3/3]

virtual regina::GluingPermSearcher< 4 >::~GluingPermSearcher | ( |  | ) |

virtual

Destroys this search manager and all supporting data structures.

## Variable Documentation

## autos_ [1/3]

const FacetPairing<2>::IsoList* regina::GluingPermSearcher< 2 >::autos_

protected

The set of isomorphisms that define equivalence of gluing permutation sets.

Generally this is the set of all automorphisms of the underlying edge pairing.

## autos_ [2/3]

const FacetPairing<3>::IsoList* regina::GluingPermSearcher< 3 >::autos_

protected

The set of isomorphisms that define equivalence of gluing permutation sets.

Generally this is the set of all automorphisms of the underlying face pairing.

## autos_ [3/3]

const FacetPairing<4>::IsoList* regina::GluingPermSearcher< 4 >::autos_

protected

The set of isomorphisms that define equivalence of gluing permutation sets.

Generally this is the set of all automorphisms of the underlying facet pairing.

## autosNew [1/2]

bool regina::GluingPermSearcher< 2 >::autosNew

protected

Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)?

## autosNew [2/2]

bool regina::GluingPermSearcher< 3 >::autosNew

protected

Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)?

## autosNew_

bool regina::GluingPermSearcher< 4 >::autosNew_

protected

Did we create the isomorphism list autos_ ourselves (in which case we must destroy it also)?

## bdry [1/3]

unsigned regina::GluingPermSearcher< 4 >::PentEdgeState::bdry

The number of boundary triangle edges in the link for this equivalence class of pentachoron edges.

Any pentachoron facet whose gluing permutation has not yet been decided is treated as a boundary facet. This value is only maintained correctly for the root of the corresponding object tree; other objects in the tree will have older values to facilitate backtracking.

## bdry [2/3]

unsigned regina::EulerSearcher::TetVertexState::bdry

The number of boundary edges in the vertex link for this equivalence class of vertices.

Any face whose gluing permutation has not yet been decided is treated as a boundary face. This value is only maintained correctly for the root of the corresponding object tree; other objects in the tree will have older values to facilitate backtracking.

## bdry [3/3]

unsigned regina::CompactSearcher::TetVertexState::bdry

The number of boundary edges in the vertex link for this equivalence class of vertices.

Any face whose gluing permutation has not yet been decided is treated as a boundary face. This value is only maintained correctly for the root of the corresponding object tree; other objects in the tree will have older values to facilitate backtracking.

## bdryEdges [1/3]

unsigned char regina::GluingPermSearcher< 4 >::PentEdgeState::bdryEdges

The number of edges of the triangular piece of 4-manifold edge link that are in fact boundary edges of this link.

Equivalently, this measures the number of facets of this pentachoron meeting this pentachoron edge that are not yet joined to their partner facets. This always takes the value 0, 1, 2 or 3.

## bdryEdges [2/3]

unsigned char regina::EulerSearcher::TetVertexState::bdryEdges

The number of edges of the triangular piece of vertex link that are in fact boundary edges of the vertex link.

Equivalently, this measures the number of faces of this tetrahedron meeting this vertex that are not yet joined to their partner faces. This always takes the value 0, 1, 2 or 3.

## bdryEdges [3/3]

unsigned char regina::CompactSearcher::TetVertexState::bdryEdges

The number of edges of the triangular piece of vertex link that are in fact boundary edges of the vertex link.

Equivalently, this measures the number of faces of this tetrahedron meeting this vertex that are not yet joined to their partner faces. This always takes the value 0, 1, 2 or 3.

## bdryNext [1/3]

int regina::GluingPermSearcher< 4 >::PentEdgeState::bdryNext[2]

If the corresponding triangular piece of 4-manifold edge link has any boundary edges, bdryNext stores the indices of the pentachoron edges that provide the boundary edges following on from either end of this boundary segment.

Note that in most cases (see below) this is not the present pentachoron edge. For instance, if this pentachoron edge provides two boundary edges for the edge link, then this array describes the boundary before the first edge and after the second.

The boundary segment described by bdryNext[1] follows on from this segment in the direction described by the edgeLinkNextFacet array. The boundary segment in the other direction is described by bdryNext[0].

If the 4-manifold edge link is just this one triangle (i.e., all three facets of this pentachoron surrounding this edge are boundary facets, or one is a boundary and the other two are joined together), then both elements of bdryNext refer to this pentachoron edge itself. These are the only situations in which bdryNext refers back to this pentachoron edge.

If the triangle is internal to the 4-manifold edge link (i.e., bdryEdges is zero), then this array maintains the last values it had when there was at least one boundary edge earlier in the search.

Each element of this array lies between 0 and 10p-1 inclusive, where p is the total number of pentachora.

## bdryNext [2/3]

int regina::EulerSearcher::TetVertexState::bdryNext[2]

If the corresponding triangular piece of vertex link has any boundary edges, bdryNext stores the indices of the tetrahedron vertices that provide the boundary edges following on from either end of this boundary segment.

Note that in most cases (see below) this is not the present vertex. For instance, if this vertex provides two boundary edges, then this array describes the boundary before the first edge and after the second.

The boundary segment described by bdryNext[1] follows on from this segment in the direction described by the vertexLinkNextFace array. The boundary segment in the other direction is described by bdryNext[0].

If the vertex link is just this one triangle (i.e., all three faces of this tetrahedron surrounding this vertex are boundary faces, or one is a boundary and the other two are joined together), then both elements of bdryNext refer to this vertex itself. These are the only situations in which bdryNext refers back to this vertex.

If the triangle is internal to the vertex link (i.e., bdryEdges is zero), then this array maintains the last values it had when there was at least one boundary edge earlier in the search.

Each element of this array lies between 0 and 4t-1 inclusive, where t is the total number of tetrahedra.

## bdryNext [3/3]

int regina::CompactSearcher::TetVertexState::bdryNext[2]

If the corresponding triangular piece of vertex link has any boundary edges, bdryNext stores the indices of the tetrahedron vertices that provide the boundary edges following on from either end of this boundary segment.

Note that in most cases (see below) this is not the present vertex. For instance, if this vertex provides two boundary edges, then this array describes the boundary before the first edge and after the second.

The boundary segment described by bdryNext[1] follows on from this segment in the direction described by the vertexLinkNextFace array. The boundary segment in the other direction is described by bdryNext[0].

If the vertex link is just this one triangle (i.e., all three faces of this tetrahedron surrounding this vertex are boundary faces, or one is a boundary and the other two are joined together), then both elements of bdryNext refer to this vertex itself. These are the only situations in which bdryNext refers back to this vertex.

If the triangle is internal to the vertex link (i.e., bdryEdges is zero), then this array maintains the last values it had when there was at least one boundary edge earlier in the search.

Each element of this array lies between 0 and 4t-1 inclusive, where t is the total number of tetrahedra.

## bdryNextOld [1/3]

int regina::GluingPermSearcher< 4 >::PentEdgeState::bdryNextOld[2]

Stores a snapshot of the values in the bdryNext array from the last point in the search when bdryEdges was precisely two.

If bdryEdges is still two or three, then this array is undefined.

## bdryNextOld [2/3]

int regina::EulerSearcher::TetVertexState::bdryNextOld[2]

Stores a snapshot of the values in the bdryNext array from the last point in the search when bdryEdges was precisely two.

If bdryEdges is still two or three, then this array is undefined.

## bdryNextOld [3/3]

int regina::CompactSearcher::TetVertexState::bdryNextOld[2]

Stores a snapshot of the values in the bdryNext array from the last point in the search when bdryEdges was precisely two.

If bdryEdges is still two or three, then this array is undefined.

## bdryTwist [1/3]

char regina::GluingPermSearcher< 4 >::PentEdgeState::bdryTwist[2]

Describes whether the orientation of this boundary segment of the 4-manifold edge link is consistent with the orientation of the adjacent segments on either side.

See bdryNext for further discussion of boundary segments. The bdryNext array defines an orientation for this section of 4-manifold edge link, pointing from the end described by bdryNext[0] to the end described by bdryNext[1].

For each i, the value bdryTwist[i] is 0 if the orientation of the adjacent segment described by bdryNext[i] is the same as this segment (as defined by the bdryNext values stored with the adjacent pentachoron edge), or 1 if the orientations differ.

If the triangle supplied by this pentachoron edge is internal to the edge link, this array maintains the last values it had when there was at least one boundary edge earlier in the search (just like the bdryNext array).

## bdryTwist [2/3]

char regina::EulerSearcher::TetVertexState::bdryTwist[2]

Describes whether the orientation of this boundary segment of the vertex link is consistent with the orientation of the adjacent segments on either side.

See bdryNext for further discussion of boundary segments. The bdryNext array defines an orientation for this section of vertex link, pointing from the end described by bdryNext[0] to the end described by bdryNext[1].

For each i, the value bdryTwist[i] is 0 if the orientation of the adjacent segment described by bdryNext[i] is the same as this segment (as defined by the bdryNext values stored with the adjacent vertex), or 1 if the orientations differ.

If the triangle supplied by this vertex is internal to the vertex link, this array maintains the last values it had when there was at least one boundary edge earlier in the search (just like the bdryNext array).

## bdryTwist [3/3]

char regina::CompactSearcher::TetVertexState::bdryTwist[2]

Describes whether the orientation of this boundary segment of the vertex link is consistent with the orientation of the adjacent segments on either side.

See bdryNext for further discussion of boundary segments. The bdryNext array defines an orientation for this section of vertex link, pointing from the end described by bdryNext[0] to the end described by bdryNext[1].

For each i, the value bdryTwist[i] is 0 if the orientation of the adjacent segment described by bdryNext[i] is the same as this segment (as defined by the bdryNext values stored with the adjacent vertex), or 1 if the orientations differ.

If the triangle supplied by this vertex is internal to the vertex link, this array maintains the last values it had when there was at least one boundary edge earlier in the search (just like the bdryNext array).

## bdryTwistOld [1/3]

char regina::GluingPermSearcher< 4 >::PentEdgeState::bdryTwistOld[2]

Stores a snapshot of the values in the bdryTwist array from the last point in the search when bdryEdges was precisely two.

If bdryEdges is still two or three, then this array is undefined.

## bdryTwistOld [2/3]

char regina::EulerSearcher::TetVertexState::bdryTwistOld[2]

Stores a snapshot of the values in the bdryTwist array from the last point in the search when bdryEdges was precisely two.

If bdryEdges is still two or three, then this array is undefined.

## bdryTwistOld [3/3]

char regina::CompactSearcher::TetVertexState::bdryTwistOld[2]

Stores a snapshot of the values in the bdryTwist array from the last point in the search when bdryEdges was precisely two.

If bdryEdges is still two or three, then this array is undefined.

## bounded [1/3]

bool regina::GluingPermSearcher< 4 >::PentTriangleState::bounded

Does this equivalence class of pentachoron triangles represent a boundary triangle?

If this equivalence class describes a complete loop of pentachoron triangles then the value of bounded is `false`. If this equivalence class describes a string of pentachoron triangles with two endpoints, the value of bounded is `true`. Here we treat any facet whose gluing permutation has not yet been decided as a boundary facet.

This value is only maintained correctly for the root of the corresponding object tree; other objects in the tree will have older values to facilitate backtracking.

## bounded [2/3]

bool regina::EulerSearcher::TetEdgeState::bounded

Does this equivalence class of tetrahedron edges represent a boundary edge?

If this equivalence class describes a complete loop of tetrahedron edges then the value of bounded is `false`. If this equivalence class describes a string of tetrahedron edges with two endpoints, the value of bounded is `true`. Here we treat any face whose gluing permutation has not yet been decided as a boundary face.

This value is only maintained correctly for the root of the corresponding object tree; other objects in the tree will have older values to facilitate backtracking.

## bounded [3/3]

bool regina::CompactSearcher::TetEdgeState::bounded

Does this equivalence class of tetrahedron edges represent a boundary edge?

If this equivalence class describes a complete loop of tetrahedron edges then the value of bounded is `false`. If this equivalence class describes a string of tetrahedron edges with two endpoints, the value of bounded is `true`. Here we treat any face whose gluing permutation has not yet been decided as a boundary face.

This value is only maintained correctly for the root of the corresponding object tree; other objects in the tree will have older values to facilitate backtracking.

## dataTag_ [1/7]

const char regina::GluingPermSearcher< 2 >::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## dataTag_ [2/7]

const char regina::GluingPermSearcher< 3 >::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## dataTag_ [3/7]

const char regina::GluingPermSearcher< 4 >::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## dataTag_ [4/7]

const char regina::EulerSearcher::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## dataTag_ [5/7]

const char regina::CompactSearcher::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## dataTag_ [6/7]

const char regina::ClosedPrimeMinSearcher::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## dataTag_ [7/7]

const char regina::HyperbolicMinSearcher::dataTag_

static

A character used to identify this class when reading and writing tagged data in text format.

## edgeLinkNextFacet

const int regina::GluingPermSearcher< 4 >::edgeLinkNextFacet[10][5]

static protected

Maintains an ordering of the three pentachoron facets surrounding an edge in a pentachoron.

This ordering is consistent with the orientations of triangles in the edge link used by PentEdgeState::twistUp.

For edge e (0..9), the pentachoron facet that follows f (0..5) in this ordering is edgeLinkNextFacet[e][f]. Note that 2/5 of the values in this array remain unaccounted for; these remaining values are set to -1.

## edgeLinkPrevFacet

const int regina::GluingPermSearcher< 4 >::edgeLinkPrevFacet[10][5]

static protected

Provides backwards links for the ordering described by edgeLinkNextFacet.

For edge e (0..9), the pentachoron facet that follows f (0..5) in this ordering is edgeLinkPrevFacet[e][f]. Again 2/5 of the values in this array remain unaccounted for, and these remaining values are set to -1.

## edgeState [1/2]

TetEdgeState* regina::EulerSearcher::edgeState

protected

Used for tracking equivalence classes of identified tetrahedron edges.

See the TetEdgeState description for details. This array has size 6n, where edge e of tetrahedron t has index 6t+e.

## edgeState [2/2]

TetEdgeState* regina::CompactSearcher::edgeState

protected

Used for tracking equivalence classes of identified tetrahedron edges.

See the TetEdgeState description for details. This array has size 6n, where edge e of tetrahedron t has index 6t+e.

## edgeState_

PentEdgeState* regina::GluingPermSearcher< 4 >::edgeState_

protected

Used for tracking equivalence classes of identified pentachoron edges.

See the PentEdgeState description for details. This array has size 10n, where edge e of pentachoron p has index 10p+e.

## edgeStateChanged [1/2]

int* regina::EulerSearcher::edgeStateChanged

protected

Tracks the way in which the edgeState[] array has been updated over time.

This array has size 8n. Suppose the gluing for order[i] affects face f of tetrahedron t. Then element 4i+v of this array describes how the gluing for order[i] affects the edge of tetrahedron t opposite vertices f and v (note that a quarter of this array will remain unused, since f and v are never equal).

If this identification of edges results in the tree with root edgeState[p] being grafted beneath the tree with root edgeState[q], this array will store the value p. Otherwise it will store the value -1.

## edgeStateChanged [2/2]

int* regina::CompactSearcher::edgeStateChanged

protected

Tracks the way in which the edgeState[] array has been updated over time.

This array has size 8n. Suppose the gluing for order[i] affects face f of tetrahedron t. Then element 4i+v of this array describes how the gluing for order[i] affects the edge of tetrahedron t opposite vertices f and v (note that a quarter of this array will remain unused, since f and v are never equal).

If this identification of edges results in the tree with root edgeState[p] being grafted beneath the tree with root edgeState[q], this array will store the value p. Otherwise it will store the value -1.

## edgeStateChanged_

int* regina::GluingPermSearcher< 4 >::edgeStateChanged_

protected

Tracks the way in which the edgeState_[] array has been updated over time.

This array has size 25n. Suppose the gluing for order[i] affects facet k of pentachoron p. Then element 10i+e of this array describes how the gluing for order[i] affects edge e of pentachoron p. Note that almost half of this array will remain unused, since only six edges of a pentachoron are affected by any one gluing.

If this identification of edges results in the tree with root edgeState_[x] being grafted beneath the tree with root edgeState_[y], this array will store the value x. Otherwise it will store the value -1.

## euler

int regina::EulerSearcher::TetVertexState::euler

The Euler characteristic that the vertex link would have if its punctures were all filled.

As above, this value is only maintained correctly for the root of the corresponding object tree.

## euler_

int regina::EulerSearcher::euler_

protected

The Euler characteristic that vertex links must have.

For boundary vertices, this is the Euler characteristic of the closed surface that would be obtained if the puncture in the vertex link were filled.

## facesNeg [1/2]

QitmaskLen64 regina::EulerSearcher::TetEdgeState::facesNeg

Indicates how many times this edge runs along the boundary of each tetrahedron face in the negative direction.

Specifically, the (4t+i)th trit counts how many times it runs in the negative direction around the boundary of face i of tetrahedron t. Which direction is "negative" is chosen arbitrarily for each face; for details see the implementation of the EulerSearcher constructor.

Because of the fixed-size data type, this only stores information for the faces of the first 16 tetrahedra.

Currently this data member is initialised by the EulerSearcher constructors (since it belongs to TetEdgeState), but it is only used and updated in the subclass ClosedPrimeMinSearcher (where it allows us to optimise the census algorithm).

## facesNeg [2/2]

QitmaskLen64 regina::CompactSearcher::TetEdgeState::facesNeg

Indicates how many times this edge runs along the boundary of each tetrahedron face in the negative direction.

Specifically, the (4t+i)th trit counts how many times it runs in the negative direction around the boundary of face i of tetrahedron t. Which direction is "negative" is chosen arbitrarily for each face; for details see the implementation of the CompactSearcher constructor.

Because of the fixed-size data type, this only stores information for the faces of the first 16 tetrahedra.

Currently this data member is initialised by the CompactSearcher constructors (since it belongs to TetEdgeState), but it is only used and updated in the subclass ClosedPrimeMinSearcher (where it allows us to optimise the census algorithm).

## facesPos [1/2]

QitmaskLen64 regina::EulerSearcher::TetEdgeState::facesPos

Indicates how many times this edge runs along the boundary of each tetrahedron face in the positive direction.

Specifically, the (4t+i)th trit counts how many times it runs in the positive direction around the boundary of face i of tetrahedron t. Which direction is "positive" is chosen arbitrarily for each face; for details see the implementation of the EulerSearcher constructor.

Because of the fixed-size data type, this only stores information for the faces of the first 16 tetrahedra.

Currently this data member is initialised by the EulerSearcher constructors (since it belongs to TetEdgeState), but it is only used and updated in the subclass ClosedPrimeMinSearcher (where it allows us to optimise the census algorithm).

## facesPos [2/2]

QitmaskLen64 regina::CompactSearcher::TetEdgeState::facesPos

Indicates how many times this edge runs along the boundary of each tetrahedron face in the positive direction.

Specifically, the (4t+i)th trit counts how many times it runs in the positive direction around the boundary of face i of tetrahedron t. Which direction is "positive" is chosen arbitrarily for each face; for details see the implementation of the CompactSearcher constructor.

Because of the fixed-size data type, this only stores information for the faces of the first 16 tetrahedra.

Currently this data member is initialised by the CompactSearcher constructors (since it belongs to TetEdgeState), but it is only used and updated in the subclass ClosedPrimeMinSearcher (where it allows us to optimise the census algorithm).

## finiteOnly_ [1/2]

bool regina::GluingPermSearcher< 3 >::finiteOnly_

protected

Are we only searching for gluing permutations that correspond to finite triangulations?

## finiteOnly_ [2/2]

bool regina::GluingPermSearcher< 4 >::finiteOnly_

protected

Are we only searching for gluing permutations that correspond to finite (non-ideal) triangulations?

## hadEqualRank [1/6]

bool regina::GluingPermSearcher< 4 >::PentEdgeState::hadEqualRank

Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone.

If this object is still the root of its tree, this value is set to false.

## hadEqualRank [2/6]

bool regina::GluingPermSearcher< 4 >::PentTriangleState::hadEqualRank

Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone.

If this object is still the root of its tree, this value is set to false.

## hadEqualRank [3/6]

bool regina::EulerSearcher::TetVertexState::hadEqualRank

Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone.

If this object is still the root of its tree, this value is set to false.

## hadEqualRank [4/6]

bool regina::EulerSearcher::TetEdgeState::hadEqualRank

Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone.

If this object is still the root of its tree, this value is set to false.

## hadEqualRank [5/6]

bool regina::CompactSearcher::TetVertexState::hadEqualRank

Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone.

If this object is still the root of its tree, this value is set to false.

## hadEqualRank [6/6]

bool regina::CompactSearcher::TetEdgeState::hadEqualRank

Did this tree have rank equal to its parent immediately before it was grafted beneath its parent? This information is used to maintain the ranks correctly when grafting operations are undone.

If this object is still the root of its tree, this value is set to false.

## inputError_

template<int dim>

bool regina::GluingPerms< dim >::inputError_

protected

Has an error occurred during construction from an input stream?

## nEdgeClasses [1/2]

unsigned regina::EulerSearcher::nEdgeClasses

protected

The number of equivalence classes of identified tetrahedron edges.

## nEdgeClasses [2/2]

unsigned regina::CompactSearcher::nEdgeClasses

protected

The number of equivalence classes of identified tetrahedron edges.

## nEdgeClasses_

unsigned regina::GluingPermSearcher< 4 >::nEdgeClasses_

protected

The number of equivalence classes of identified pentachoron edges.

## nTriangleClasses_

unsigned regina::GluingPermSearcher< 4 >::nTriangleClasses_

protected

The number of equivalence classes of identified pentachoron triangles.

## nVertexClasses [1/2]

unsigned regina::EulerSearcher::nVertexClasses

protected

The number of equivalence classes of identified tetrahedron vertices.

## nVertexClasses [2/2]

unsigned regina::CompactSearcher::nVertexClasses

protected

The number of equivalence classes of identified tetrahedron vertices.

## order [1/2]

FacetSpec<2>* regina::GluingPermSearcher< 2 >::order

protected

Describes the order in which gluing permutations are assigned to edges.

Specifically, this order is order[0], order[1], ..., order[orderSize-1].

Note that each element of this array corresponds to a single edge of the underlying edge pairing graph, which in turn represents a triangle edge and its image under the given edge pairing.

The specific triangle edge stored in this array for each edge of the underlying edge pairing graph will be the smaller of the two identified triangle edges (unless otherwise specified by a subclass that uses a specialised search algorithm.

## order [2/2]

FacetSpec<3>* regina::GluingPermSearcher< 3 >::order

protected

Describes the order in which gluing permutations are assigned to faces.

Specifically, this order is order[0], order[1], ..., order[orderSize-1].

Note that each element of this array corresponds to a single edge of the underlying face pairing graph, which in turn represents a tetrahedron face and its image under the given face pairing.

The specific tetrahedron face stored in this array for each edge of the underlying face pairing graph will be the smaller of the two identified tetrahedron faces (unless otherwise specified for a particular edge type; see ClosedPrimeMinSearcher for examples).

## order_

FacetSpec<4>* regina::GluingPermSearcher< 4 >::order_

protected

Describes the order in which gluing permutations are assigned to pentachoron facets.

Specifically, this order is order_[0], order_[1], ..., order_[orderSize_-1].

Note that each element of this array corresponds to a single edge of the underlying facet pairing graph, which in turn represents a pentachoron facet and its image under the given facet pairing.

The specific pentachoron facet stored in this array for each edge of the underlying facet pairing graph will be the smaller of the two identified pentachoron facets.

## orderElt [1/2]

int regina::GluingPermSearcher< 2 >::orderElt

protected

Marks which element of order[] we are currently examining at this stage of the search.

## orderElt [2/2]

int regina::GluingPermSearcher< 3 >::orderElt

protected

Marks which element of order[] we are currently examining at this stage of the search.

## orderElt_

int regina::GluingPermSearcher< 4 >::orderElt_

protected

Marks which element of order_[] we are currently examining at this stage of the search.

## orderSize [1/2]

int regina::GluingPermSearcher< 2 >::orderSize

protected

The total number of edges in the edge pairing graph, i.e., the number of elements of interest in the order[] array.

## orderSize [2/2]

int regina::GluingPermSearcher< 3 >::orderSize

protected

The total number of edges in the face pairing graph, i.e., the number of elements of interest in the order[] array.

## orderSize_

int regina::GluingPermSearcher< 4 >::orderSize_

protected

The total number of edges in the facet pairing graph, i.e., the number of elements of interest in the order_[] array.

## orientableOnly_ [1/3]

bool regina::GluingPermSearcher< 2 >::orientableOnly_

protected

Are we only searching for gluing permutations that correspond to orientable triangulations?

## orientableOnly_ [2/3]

bool regina::GluingPermSearcher< 3 >::orientableOnly_

protected

Are we only searching for gluing permutations that correspond to orientable triangulations?

## orientableOnly_ [3/3]

bool regina::GluingPermSearcher< 4 >::orientableOnly_

protected

Are we only searching for gluing permutations that correspond to orientable triangulations?

## orientation [1/2]

int* regina::GluingPermSearcher< 2 >::orientation

protected

Keeps track of the orientation of each triangle in the underlying triangulation.

Orientation is positive/negative, or 0 if unknown. Note that in some algorithms the orientation is simply +/-1, and in some algorithms the orientation counts forwards or backwards from 0 according to how many times the orientation has been set or verified.

## orientation [2/2]

int* regina::GluingPermSearcher< 3 >::orientation

protected

Keeps track of the orientation of each tetrahedron in the underlying triangulation.

Orientation is positive/negative, or 0 if unknown. Note that in some algorithms the orientation is simply +/-1, and in some algorithms the orientation counts forwards or backwards from 0 according to how many times the orientation has been set or verified.

## orientation_

int* regina::GluingPermSearcher< 4 >::orientation_

protected

Keeps track of the orientation of each pentachoron in the underlying triangulation.

Orientation is positive/negative, or 0 if unknown. Note that in some algorithms the orientation is simply +/-1, and in some algorithms the orientation counts forwards or backwards from 0 according to how many times the orientation has been set or verified.

## pairing_

template<int dim>

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

protected

The facet pairing that this permutation set complements.

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

## parent [1/6]

int regina::GluingPermSearcher< 4 >::PentEdgeState::parent

The index of the parent object in the current tree, or -1 if this object is the root of the tree.

## parent [2/6]

int regina::GluingPermSearcher< 4 >::PentTriangleState::parent

The index of the parent object in the current tree, or -1 if this object is the root of the tree.

## parent [3/6]

int regina::EulerSearcher::TetVertexState::parent

The index of the parent object in the current tree, or -1 if this object is the root of the tree.

## parent [4/6]

int regina::EulerSearcher::TetEdgeState::parent

The index of the parent object in the current tree, or -1 if this object is the root of the tree.

## parent [5/6]

int regina::CompactSearcher::TetVertexState::parent

The index of the parent object in the current tree, or -1 if this object is the root of the tree.

## parent [6/6]

int regina::CompactSearcher::TetEdgeState::parent

The index of the parent object in the current tree, or -1 if this object is the root of the tree.

## permIndices_

template<int dim>

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

protected

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.

## rank [1/6]

unsigned regina::GluingPermSearcher< 4 >::PentEdgeState::rank

The depth of the subtree beneath this object (where a leaf node has depth zero).

## rank [2/6]

unsigned regina::GluingPermSearcher< 4 >::PentTriangleState::rank

The depth of the subtree beneath this object (where a leaf node has depth zero).

## rank [3/6]

unsigned regina::EulerSearcher::TetVertexState::rank

The depth of the subtree beneath this object (where a leaf node has depth zero).

## rank [4/6]

unsigned regina::EulerSearcher::TetEdgeState::rank

The depth of the subtree beneath this object (where a leaf node has depth zero).

## rank [5/6]

unsigned regina::CompactSearcher::TetVertexState::rank

The depth of the subtree beneath this object (where a leaf node has depth zero).

## rank [6/6]

unsigned regina::CompactSearcher::TetEdgeState::rank

The depth of the subtree beneath this object (where a leaf node has depth zero).

## size [1/3]

unsigned regina::GluingPermSearcher< 4 >::PentTriangleState::size

The total number of objects in the subtree descending from this object (where this object is counted also).

## size [2/3]

unsigned regina::EulerSearcher::TetEdgeState::size

The total number of objects in the subtree descending from this object (where this object is counted also).

## size [3/3]

unsigned regina::CompactSearcher::TetEdgeState::size

The total number of objects in the subtree descending from this object (where this object is counted also).

## started [1/2]

bool regina::GluingPermSearcher< 2 >::started

protected

Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search.

## started [2/2]

bool regina::GluingPermSearcher< 3 >::started

protected

Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search.

## started_

bool regina::GluingPermSearcher< 4 >::started_

protected

Has the search started yet? This helps distinguish between a new search and the resumption of a partially completed search.

## triState_

PentTriangleState* regina::GluingPermSearcher< 4 >::triState_

protected

Used for tracking equivalence classes of identified pentachoron triangles.

See the PentTriangleState description for details. This array has size 10n, where triangle f of pentachoron p has index 10p+f.

## triStateChanged_

int* regina::GluingPermSearcher< 4 >::triStateChanged_

protected

Tracks the way in which the triState_[] array has been updated over time.

This array has size [25n/2]. Suppose the gluing for order[i] affects facet k of pentachoron p. Then element 5i+v of this array describes how the gluing for order[i] affects the triangle of pentachoron p opposite vertices k and v (note that a fifth of this array will remain unused, since k and v are never equal).

If this identification of triangles results in the tree with root triState_[x] being grafted beneath the tree with root triState_[y], this array will store the value x. Otherwise it will store the value -1.

## twistUp [1/5]

Perm<3> regina::GluingPermSearcher< 4 >::PentTriangleState::twistUp

The vertices of each pentachoron triangle can be labelled (0,1,2) by running through the underlying pentachoron vertices from smallest index to largest index.

The parameter twistUp is a permutation that maps vertices (0,1,2) of this triangle to vertices (0,1,2) of its parent in the tree according to the way in which the two triangles are identified. If this object has no parent, the value of twistUp is undefined.

## twistUp [2/5]

char regina::EulerSearcher::TetVertexState::twistUp

The identification of this object and its parent in the tree corresponds to a gluing of two triangles in the vertex link.

Each of these triangles in the vertex link can be labelled with its own vertices 0, 1 and 2 and thereby be assigned a clockwise or anticlockwise orientation.

The parameter twistUp is 0 if these two triangles in the vertex link are joined in a way that preserves orientation, or 1 if the gluing does not preserve orientation.

If this object has no parent, the value of twistUp is undefined.

## twistUp [3/5]

char regina::EulerSearcher::TetEdgeState::twistUp

Each tetrahedron edge can be assigned an orientation pointing from the lower numbered tetrahedron vertex to the higher.

The parameter twistUp is 0 if the identification of this object and its parent in the tree preserves this orientation, or 1 if it does not. If this object has no parent, the value of twistUp is undefined.

## twistUp [4/5]

char regina::CompactSearcher::TetVertexState::twistUp

The identification of this object and its parent in the tree corresponds to a gluing of two triangles in the vertex link.

Each of these triangles in the vertex link can be labelled with its own vertices 0, 1 and 2 and thereby be assigned a clockwise or anticlockwise orientation.

The parameter twistUp is 0 if these two triangles in the vertex link are joined in a way that preserves orientation, or 1 if the gluing does not preserve orientation.

If this object has no parent, the value of twistUp is undefined.

## twistUp [5/5]

char regina::CompactSearcher::TetEdgeState::twistUp

Each tetrahedron edge can be assigned an orientation pointing from the lower numbered tetrahedron vertex to the higher.

The parameter twistUp is 0 if the identification of this object and its parent in the tree preserves this orientation, or 1 if it does not. If this object has no parent, the value of twistUp is undefined.

## twistUpEdge

char regina::GluingPermSearcher< 4 >::PentEdgeState::twistUpEdge

Each pentachoron edge can be assigned an orientation pointing from the lower numbered pentachoron vertex to the higher.

The parameter twistUpEdge is 0 if the identification of this object and its parent in the tree preserves this orientation, or 1 if it does not. If this object has no parent, the value of twistUpEdge is undefined.

## twistUpTriangle

char regina::GluingPermSearcher< 4 >::PentEdgeState::twistUpTriangle

The identification of this object and its parent in the tree corresponds to a gluing of two triangles in the edge link.

Each of these triangles in the edge link can be labelled with its own vertices 0, 1 and 2 and thereby be assigned a clockwise or anticlockwise orientation.

The parameter twistUpTriangle is 0 if these two triangles in the edge link are joined in a way that preserves orientation, or 1 if the gluing does not preserve orientation.

If this object has no parent, the value of twistUpTriangle is undefined.

## use_ [1/3]

GluingPermSearcher<2>::Use regina::GluingPermSearcher< 2 >::use_

protected

A routine to call each time a gluing permutation set is found during the search.

## use_ [2/3]

GluingPermSearcher<3>::Use regina::GluingPermSearcher< 3 >::use_

protected

A routine to call each time a gluing permutation set is found during the search.

## use_ [3/3]

GluingPermSearcher<4>::Use regina::GluingPermSearcher< 4 >::use_

protected

A routine to call each time a gluing permutation set is found during the search.

## useArgs_ [1/3]

void* regina::GluingPermSearcher< 2 >::useArgs_

protected

Additional user-supplied data to be passed as the second argument to the use_ routine.

## useArgs_ [2/3]

void* regina::GluingPermSearcher< 3 >::useArgs_

protected

Additional user-supplied data to be passed as the second argument to the use_ routine.

## useArgs_ [3/3]

void* regina::GluingPermSearcher< 4 >::useArgs_

protected

Additional user-supplied data to be passed as the second argument to the use_ routine.

## vertexLinkNextFace [1/2]

const int regina::EulerSearcher::vertexLinkNextFace[4][4]

static protected

Maintains an ordering of the three tetrahedron faces surrounding a vertex in a tetrahedron.

This ordering is consistent with the orientations of triangles in the vertex link used by TetVertexState::twistUp.

For vertex v (0..3), the tetrahedron face that follows f (0..3) in this ordering is vertexLinkNextFace[v][f]. The remaining array elements vertexLinkNextFace[v][v] are all -1.

## vertexLinkNextFace [2/2]

const int regina::CompactSearcher::vertexLinkNextFace[4][4]

static protected

Maintains an ordering of the three tetrahedron faces surrounding a vertex in a tetrahedron.

This ordering is consistent with the orientations of triangles in the vertex link used by TetVertexState::twistUp.

For vertex v (0..3), the tetrahedron face that follows f (0..3) in this ordering is vertexLinkNextFace[v][f]. The remaining array elements vertexLinkNextFace[v][v] are all -1.

## vertexLinkPrevFace [1/2]

const int regina::EulerSearcher::vertexLinkPrevFace[4][4]

static protected

Provides backwards links for the ordering described by vertexLinkNextFace.

For vertex v (0..3), the tetrahedron face that precedes f (0..3) in this ordering is vertexLinkPrevFace[v][f]. The remaining array elements vertexLinkPrevFace[v][v] are all -1.

## vertexLinkPrevFace [2/2]

const int regina::CompactSearcher::vertexLinkPrevFace[4][4]

static protected

Provides backwards links for the ordering described by vertexLinkNextFace.

For vertex v (0..3), the tetrahedron face that precedes f (0..3) in this ordering is vertexLinkPrevFace[v][f]. The remaining array elements vertexLinkPrevFace[v][v] are all -1.

## vertexState [1/2]

TetVertexState* regina::EulerSearcher::vertexState

protected

Used for tracking equivalence classes of identified tetrahedron vertices.

See the TetVertexState description for details. This array has size 4n, where vertex v of tetrahedron t has index 4t+v.

## vertexState [2/2]

TetVertexState* regina::CompactSearcher::vertexState

protected

Used for tracking equivalence classes of identified tetrahedron vertices.

See the TetVertexState description for details. This array has size 4n, where vertex v of tetrahedron t has index 4t+v.

## vertexStateChanged [1/2]

int* regina::EulerSearcher::vertexStateChanged

protected

Tracks the way in which the vertexState[] array has been updated over time.

This array has size 8n, where element 4i+v describes how the gluing for order[i] affects vertex v of the corresponding tetrahedron (thus a quarter of this array will remain unused, since only three vertices are affected for each gluing).

If this identification of vertices results in the tree with root vertexState[p] being grafted beneath the tree with root vertexState[q] (so two distinct vertex links become joined together), this array will store the value p. Otherwise it will store one of the values VLINK_JOIN_HANDLE, VLINK_JOIN_BRIDGE or VLINK_JOIN_TWIST, indicating how the corresponding partial link is glued to itself.

The value VLINK_JOIN_INIT will be stored for positions in the array that correspond to gluings that have not yet been made.

## vertexStateChanged [2/2]

int* regina::CompactSearcher::vertexStateChanged

protected

Tracks the way in which the vertexState[] array has been updated over time.

This array has size 8n, where element 4i+v describes how the gluing for order[i] affects vertex v of the corresponding tetrahedron (thus a quarter of this array will remain unused, since only three vertices are affected for each gluing).

If this identification of vertices results in the tree with root vertexState[p] being grafted beneath the tree with root vertexState[q], this array will store the value p. Otherwise it will store the value -1.

## VLINK_BAD_EULER

const char regina::EulerSearcher::VLINK_BAD_EULER

static protected

Signifies that a vertex link has either (i) accumulated too high a genus (so when its punctures are filled the Euler characteristic will be too low), or has (ii) been closed off with too low a genus (so its final Euler characteristic is too high).

## VLINK_CLOSED [1/2]

const char regina::EulerSearcher::VLINK_CLOSED

static protected

Signifies that a vertex link has been closed off (i.e., the link has no remaining boundary edges).

## VLINK_CLOSED [2/2]

const char regina::CompactSearcher::VLINK_CLOSED

static protected

Signifies that a vertex link has been closed off (i.e., the link has no remaining boundary edges).

## VLINK_NON_SPHERE

const char regina::CompactSearcher::VLINK_NON_SPHERE

static protected

Signifies that a vertex link has been made into something other than a 2-sphere with zero or more punctures.

## whichPurge_

int regina::GluingPermSearcher< 3 >::whichPurge_

protected

Are there any types of triangulation that we may optionally avoid constructing? This should be a bitwise OR of constants from the PurgeFlags enumeration.

See the constructor documentation for further details on this search parameter.

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