Regina Calculation Engine
|
A dimension-agnostic base class that represents a specific set of gluing permutations to complement a particular pairwise matching of simplex facets. More...
#include <census/ngenericgluingperms.h>
Public Types | |
typedef DimTraits< dim > ::FacetPairing | FacetPairing |
typedef DimTraits< dim >::Perm | Perm |
typedef DimTraits< dim >::Simplex | Simplex |
typedef DimTraits< dim > ::Triangulation | Triangulation |
Public Member Functions | |
NGenericGluingPerms (const NGenericGluingPerms< dim > &cloneMe) | |
Creates a new set of gluing permutations that is a clone of the given permutation set. More... | |
NGenericGluingPerms (std::istream &in) | |
Reads a new set of gluing permutations from the given input stream. More... | |
virtual | ~NGenericGluingPerms () |
Deallocates any memory used by this structure. More... | |
bool | inputError () const |
Was an error found during construction from an input stream? More... | |
unsigned | size () const |
Returns the total number of simplices under consideration. More... | |
const FacetPairing * | getFacetPairing () const |
Returns the specific pairing of simplex facets that this set of gluing permutations complements. More... | |
Perm | gluingPerm (const NFacetSpec< dim > &source) const |
Returns the gluing permutation associated with the given simplex facet. More... | |
Perm | gluingPerm (unsigned simp, unsigned facet) const |
Returns the gluing permutation associated with the given simplex facet. More... | |
Triangulation * | triangulate () const |
Returns a newly created triangulation as modelled by this set of gluing permutations and the associated simplex facet pairing. More... | |
virtual void | dumpData (std::ostream &out) const |
Dumps all internal data in a plain text format to the given output stream. More... | |
Protected Member Functions | |
NGenericGluingPerms (const FacetPairing *pairing) | |
Creates a new permutation set. More... | |
int & | permIndex (const NFacetSpec< dim > &source) |
Returns the index into array Perm::Sn_1 describing how the the given facet is joined to its partner. More... | |
int & | permIndex (unsigned simp, unsigned facet) |
Returns the index into array Perm::Sn_1 describing how the the given facet is joined to its partner. More... | |
const int & | permIndex (const NFacetSpec< dim > &source) const |
Returns the index into array Perm::Sn_1 describing how the the given facet is joined to its partner. More... | |
const int & | permIndex (unsigned simp, unsigned facet) const |
Returns the index into array Perm::Sn_1 describing how the the given facet is joined to its partner. More... | |
int | gluingToIndex (const NFacetSpec< dim > &source, const Perm &gluing) const |
Returns the index into array Perm::Sn_1 corresponding to the given gluing permutation from the given facet to its partner. More... | |
int | gluingToIndex (unsigned simp, unsigned facet, const Perm &gluing) const |
Returns the index into array Perm::Sn_1 corresponding to the given gluing permutation from the given facet to its partner. More... | |
Perm | indexToGluing (const NFacetSpec< 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::Sn_1. More... | |
Perm | 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::Sn_1. More... | |
Protected Attributes | |
const FacetPairing * | pairing_ |
The facet pairing that this permutation set complements. More... | |
int * | permIndices_ |
The index into array Perm::Sn_1 describing how each simplex facet is glued to its partner. More... | |
bool | inputError_ |
Has an error occurred during construction from an input stream? More... | |
A dimension-agnostic base class that represents a specific set of gluing permutations to complement a particular pairwise matching of simplex facets.
Each dimension that Regina works with (2, 3 and 4) offers its own subclass, in some cases with richer functionality. Users should not need to work with this template base class directly.
Given a pairwise matching of facets (as described by class NGenericFacetPairing<dim>), each facet that is matched with some other facet will have an associated permutation of (dim + 1) elements.
If a facet is matched with some other facet, the two associated permutations in this set will be inverses. If a facet is left deliberately unmatched, it will have no associated permutation in this set.
Such a set of permutations models part of the structure of a triangulation, in which each simplex facet that is glued to another facet has a corresponding gluing permutation (and the matched facet has the inverse gluing permutation).
regina::NGenericGluingPerms< dim >::NGenericGluingPerms | ( | const NGenericGluingPerms< dim > & | cloneMe | ) |
Creates a new set of gluing permutations that is a clone of the given permutation set.
cloneMe | the gluing permutations to clone. |
regina::NGenericGluingPerms< dim >::NGenericGluingPerms | ( | 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.
in | the input stream from which to read. |
|
inlinevirtual |
Deallocates any memory used by this structure.
|
inlineprotected |
Creates a new permutation set.
All internal arrays will be allocated but not initialised.
pairing | the specific pairing of simplex facets that this permutation set will complement. |
|
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).
out | the output stream to which the data should be written. |
Reimplemented in regina::NHyperbolicMinSearcher, regina::NClosedPrimeMinSearcher, regina::NCompactSearcher, regina::NEulerSearcher, regina::NGluingPermSearcher, and regina::Dim2GluingPermSearcher.
|
inline |
Returns the specific pairing of simplex facets that this set of gluing permutations complements.
|
inline |
Returns the gluing permutation associated with the given simplex facet.
source | the simplex facet under investigation. |
|
inline |
Returns the gluing permutation associated with the given simplex facet.
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). |
|
protected |
Returns the index into array Perm::Sn_1 corresponding to the given gluing permutation from the given facet to its partner.
This need not be the index into Perm::Sn_1 that is currently stored for the given facet.
Indices into array Perm::Sn_1 are stored internally in the array permIndices_. Full gluing permutations on the other hand are used in constructing triangulations.
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. |
|
protected |
Returns the index into array Perm::Sn_1 corresponding to the given gluing permutation from the given facet to its partner.
This need not be the index into Perm::Sn_1 that is currently stored for the given facet.
Indices into array Perm::Sn_1 are stored internally in the array permIndices_. Full gluing permutations on the other hand are used in constructing triangulations.
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. |
|
inlineprotected |
Returns the gluing permutation from the given facet to its partner that corresponds to the given index into array Perm::Sn_1.
This index into Perm::Sn_1 need not be the index that is currently stored for the given facet.
Indices into array Perm::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.
source | the simplex facet under investigation. |
index | an index into Perm::Sn_1; this must be between 0 and dim!-1 inclusive. |
|
inlineprotected |
Returns the gluing permutation from the given facet to its partner that corresponds to the given index into array Perm::Sn_1.
This index into Perm::Sn_1 need not be the index that is currently stored for the given facet.
Indices into array Perm::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.
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::Sn_1; this must be between 0 and dim!-1 inclusive. |
|
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
.
true
if an error occurred during construction from an input stream, or false
otherwise.
|
inlineprotected |
Returns the index into array Perm::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().
source | the simplex facet under investigation. |
|
inlineprotected |
Returns the index into array Perm::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().
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). |
|
inlineprotected |
Returns the index into array Perm::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().
source | the simplex facet under investigation. |
|
inlineprotected |
Returns the index into array Perm::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().
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). |
|
inline |
Returns the total number of simplices under consideration.
Triangulation* regina::NGenericGluingPerms< 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.
|
protected |
Has an error occurred during construction from an input stream?
|
protected |
The facet pairing that this permutation set complements.
This is guaranteed to be the minimal representative of its facet pairing isomorphism class.
|
protected |
The index into array Perm::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.