File List
Here is a list of all documented files with brief descriptions:

algebra |
abeliangroup.h | Deals with finitely generated abelian groups
grouppresentation.h | Deals with finite presentations of groups
homgrouppresentation.h | Deals with finite presentations of groups
markedabeliangroup.h | Deals with abelian groups given by chain complexes
nabeliangroup.h | Deprecated header
ngrouppresentation.h | Deprecated header
nmarkedabeliangroup.h | Deprecated header
xmlalgebrareader.h | Deals with parsing XML data for various algebraic structures
angle |
anglestructure.h | Deals with angle structures on triangulations
anglestructures.h | Contains a packet representing a collection of angle structures on a triangulation
nanglestructure.h | Deprecated header
nanglestructurelist.h | Deprecated header
xmlanglestructreader.h | Deals with parsing XML data for angle structure lists
census |
census.h | Provides facilities for looking up 3-manifold triangulations in Regina's in-built census databases
dim2gluingperms.h | Deprecated header
dim2gluingpermsearcher.h | Deprecated header
dim4gluingperms.h | Deprecated header
dim4gluingpermsearcher.h | Deprecated header
gluingperms.h | Deals with selecting gluing permutations to complement a particular pairing of facets of simplices in an n-manifold triangulation
gluingpermsearcher.h | Supports searching through all possible sets of gluing permutations for a given facet pairing
gluingpermsearcher2.h | Supports searching through all possible sets of triangle gluing permutations for a given triangle edge pairing
gluingpermsearcher3.h | Supports searching through all possible sets of tetrahedron gluing permutations for a given tetrahedron face pairing
gluingpermsearcher4.h | Supports searching through all possible sets of pentachoron gluing permutations for a given pentachoron facet pairing
ncensus.h | Deprecated header
ngenericgluingperms.h | Deprecated header
ngluingperms.h | Deprecated header
ngluingpermsearcher.h | Deprecated header
dim2 |
dim2boundarycomponent.h | Deprecated header
dim2component.h | Deprecated header
dim2edge.h | Deprecated header
dim2edgepairing.h | Deprecated header
dim2exampletriangulation.h | Deprecated header
dim2isomorphism.h | Deprecated header
dim2triangle.h | Deprecated header
dim2triangulation.h | Deprecated header
dim2vertex.h | Deprecated header
dim4 |
dim4boundarycomponent.h | Deprecated header
dim4component.h | Deprecated header
dim4edge.h | Deprecated header
dim4exampletriangulation.h | Deprecated header
dim4facetpairing.h | Deprecated header
dim4isomorphism.h | Deprecated header
dim4pentachoron.h | Deprecated header
dim4tetrahedron.h | Deprecated header
dim4triangle.h | Deprecated header
dim4triangulation.h | Deprecated header
dim4vertex.h | Deprecated header
enumerate |
doubledescription.h | Provides a modified double description method for polytope vertex enumeration
enumconstraints.h | Deals with validity constraints in polytope vertex enumeration
hilbertcd.h | Provides a modified Contejean-Devie algorithm for Hilbert basis enumeration
hilbertdual.h | Provides a modified dual algorithm for Hilbert basis enumeration
hilbertprimal.h | Provides a modified primal algorithm for Hilbert basis enumeration
maxadmissible.h | Provides an algorithm for enumerating maximal faces of a polyhedral cone that satisfy a set of admissibility constraints
ndoubledescription.h | Deprecated header
nenumconstraint.h | Deprecated header
nhilbertcd.h | Deprecated header
nhilbertdual.h | Deprecated header
nhilbertprimal.h | Deprecated header
nmaxadmissible.h | Deprecated header
ntreeconstraint.h | Deprecated header
ntreelp.h | Deprecated header
ntreetraversal.h | Deprecated header
ntypetrie.h | Deprecated header
ordering.h | Provides different ways of sorting hyperplanes (or matching equations) when performing normal surface enumeration
treeconstraint.h | Constraint classes for use with tree traversal enumeration methods
treelp.h | Linear programming code for tree traversal enumeration methods
treetraversal.h | Tree traversal methods for normal surface and angle structure enumeration and optimisation
typetrie.h | A supporting data structure for tree traversal enumeration methods
file |
fileinfo.h | Deals with determining information about Regina data files
globaldirs.h | Gives information about system installation directories
nfileinfo.h | Deprecated header
nglobaldirs.h | Deprecated header
foreign |
dehydration.h | Allows reading lists of dehydrated triangulations
isosig.h | Allows reading lists of isomorphism signatures
orb.h | Allows reading Orb / Casson triangulation files
generic |
facenumbering.h | Deprecated header
facetspec.h | Deprecated header
xmltrireader.h | Deprecated header
hypersurface |
hscoordregistry.h | Provides access to a registry of all coordinate systems that can be used to create and store normal hypersurfaces in 4-manifold triangulations
hsvectorstandard.h | Implements normal hypersurface vectors using standard tetrahedron-prism coordinates
hypercoords.h | Defines constants for normal hypersurface coordinate systems
hyperflags.h | Defines constants and flags for normal hypersurface enumeration
nhsstandard.h | Deprecated header
nnormalhypersurface.h | Deprecated header
nnormalhypersurfacelist.h | Deprecated header
normalhypersurface.h | Deals with an individual normal hypersurface in a 4-manifold triangulation
normalhypersurfaces.h | Contains a packet representing a collection of normal hypersurfaces in a 4-manifold triangulation
xmlhypersurfacereader.h | Deals with parsing XML data for normal hypersurface lists
manifold |
graphloop.h | Deals with graph manifolds formed from self-identified Seifert fibred spaces
graphpair.h | Deals with graph manifolds formed from pairs of Seifert fibred spaces
graphtriple.h | Deals with graph manifolds formed from sequences of three Seifert fibred spaces
handlebody.h | Deals with arbitrary handlebodies
lensspace.h | Deals with general lens spaces
manifold.h | Deals with the underlying 3-manifolds of triangulations
ngraphloop.h | Deprecated header
ngraphpair.h | Deprecated header
ngraphtriple.h | Deprecated header
nhandlebody.h | Deprecated header
nlensspace.h | Deprecated header
nmanifold.h | Deprecated header
notation.h | Explains notation used for describing various types of 3-manifold
nsfs.h | Deprecated header
nsfsaltset.h | Deprecated header
nsimplesurfacebundle.h | Deprecated header
nsnappeacensusmfd.h | Deprecated header
ntorusbundle.h | Deprecated header
sfs.h | Deals with general Seifert fibred spaces
sfsaltset.h | Assists with providing different representations of the same Seifert fibred space
simplesurfacebundle.h | Deals with simple closed surface bundles
snappeacensusmfd.h | Deals with 3-manifolds from the SnapPea census
torusbundle.h | Deals with torus bundles over the circle
maths |
spec |
perm2.h | Internal header for permutations of {0,1}
perm3.h | Internal header for permutations of {0,1,2}
perm4.h | Internal header for permutations of {0,1,2,3}
perm5.h | Internal header for permutations of {0,1,2,3,4}
approx.h | Deprecated header for managing floating-point roundoff errors
cyclotomic.h | Implements exact arithmetic in cyclotomic fields
integer.h | Provides arbitrary-precision and fixed-precision integer types
matrix.h | Deals with matrices of elements of various types
matrix2.h | Deals with 2x2 integer matrices
matrixops.h | Provides various complex matrix calculations
ncyclotomic.h | Deprecated header
ninteger.h | Deprecated header
nmatrix.h | Deprecated header
nmatrix2.h | Deprecated header
nmatrixint.h | Deprecated header
nperm.h | Deprecated header
nperm2.h | Deprecated header
nperm3.h | Deprecated header
nperm4.h | Deprecated header
nperm5.h | Deprecated header
npolynomial.h | Deprecated header
nprimes.h | Deprecated header
nrational.h | Deprecated header
nray.h | Deprecated header
numbertheory.h | Provides miscellaneous number theory routines
nvector.h | Deprecated header
perm.h | Deals with permutations of {0,1,...,n-1}
polynomial.h | Implements single variable polynomials over arbitrary rings
primes.h | Support for finding primes and factorising integers
rational.h | Deals with artibrary precision rational numbers
ray.h | Provides a fast class for rational rays rooted at the origin
vector.h | Provides a fast and generic vector class
packet |
container.h | Contains a packet whose entire life purpose is to contain other packets
ncontainer.h | Deprecated header
npacket.h | Deprecated header
npacketlistener.h | Deprecated header
npdf.h | Deprecated header
nscript.h | Deprecated header
ntext.h | Deprecated header
packet.h | Deals with packets of information that form the working data objects
packetlistener.h | Deals with objects that can listen for packet events
packetregistry.h | Provides access to a registry of all packet types known to Regina
packettype.h | Defines constants for the various packet types known to Regina
pdf.h | A packet that contains a PDF document
script.h | Contains a packet representing a script
text.h | Contains a packet representing a text string
xmlpacketreader.h | Deals with parsing XML data for individual packets
xmlpacketreaders.h | Deals with parsing XML data for various basic packet types
xmltreeresolver.h | Support for resolving dangling packet references after a complete packet tree has been read from file
progress |
nprogresstracker.h | Deprecated header
progresstracker.h | Facilitates progress tracking and cancellation for long operations
python |
globalarray.h | Allows global C++ arrays to be wrapped neatly in Python
snappea |
examplesnappea.h | Offers several ready-made example SnapPea triangulations
nexamplesnappeatriangulation.h | Deprecated header
nsnappeatriangulation.h | Deprecated header
snappeatriangulation.h | Provides access to the SnapPea kernel
xmlsnappeareader.h | Deals with parsing XML data for SnapPea triangulations
split |
nsigcensus.h | Deprecated header
nsigisomorphism.h | Deprecated header
nsignature.h | Deprecated header
sigcensus.h | Deals with forming a census of splitting surface signatures
sigisomorphism.h | Deals with full and partial isomorphisms of splitting surface signatures
signature.h | Deals with signatures of splitting surfaces
subcomplex |
augtrisolidtorus.h | Deals with augmented triangular solid torus components of a triangulation
blockedsfs.h | Supports Seifert fibred spaces that are triangulated using saturated blocks
blockedsfsloop.h | Supports self-identified Seifert fibred spaces that are triangulated using saturated blocks
blockedsfspair.h | Supports joined pairs of Seifert fibred spaces that are triangulated using saturated blocks
blockedsfstriple.h | Supports joined sequences of three Seifert fibred spaces that are triangulated using saturated blocks
l31pillow.h | Deals with triangular pillow L(3,1) components of a triangulation
layeredchain.h | Deals with layered chains in a triangulation
layeredchainpair.h | Deals with layered chain pair components of a triangulation
layeredlensspace.h | Deals with layered lens space components of a triangulation
layeredloop.h | Deals with layered loop components of a triangulation
layeredsolidtorus.h | Deals with layered solid tori in a triangulation
layeredtorusbundle.h | Deals with layered surface bundle triangulations
layering.h | Assists with the analysis of layerings upon a torus boundary
naugtrisolidtorus.h | Deprecated header
nblockedsfs.h | Deprecated header
nblockedsfsloop.h | Deprecated header
nblockedsfspair.h | Deprecated header
nblockedsfstriple.h | Deprecated header
nl31pillow.h | Deprecated header
nlayeredchain.h | Deprecated header
nlayeredchainpair.h | Deprecated header
nlayeredlensspace.h | Deprecated header
nlayeredloop.h | Deprecated header
nlayeredsolidtorus.h | Deprecated header
nlayeredsurfacebundle.h | Deprecated header
nlayering.h | Deprecated header
npillowtwosphere.h | Deprecated header
npluggedtorusbundle.h | Deprecated header
nplugtrisolidtorus.h | Deprecated header
nsatannulus.h | Deprecated header
nsatblock.h | Deprecated header
nsatblockstarter.h | Deprecated header
nsatblocktypes.h | Deprecated header
nsatregion.h | Deprecated header
nsnappeacensustri.h | Deprecated header
nsnappedball.h | Deprecated header
nsnappedtwosphere.h | Deprecated header
nspiralsolidtorus.h | Deprecated header
nstandardtri.h | Deprecated header
ntrisolidtorus.h | Deprecated header
ntrivialtri.h | Deprecated header
ntxicore.h | Deprecated header
pillowtwosphere.h | Deals with 2-spheres made from two triangles glued along their three edges
pluggedtorusbundle.h | Supports self-identified Seifert fibred spaces that are triangulated using a combination of thin I-bundles and saturated blocks
plugtrisolidtorus.h | Deals with plugged triangular solid torus components of a triangulation
satannulus.h | Deals with saturated two-triangle annuli within a Seifert fibred space
satblock.h | Deals with saturated blocks in triangulations of Seifert fibred spaces
satblockstarter.h | Provides a hard-coded list of saturated blocks to use as starting points for recognising larger Seifert fibred spaces
satblocktypes.h | Describes several types of saturated blocks within Seifert fibred space triangulations
satregion.h | Supports connected regions of saturated blocks in triangulations of Seifert fibred spaces
snappeacensustri.h | Deals with 3-manifold triangulations from the SnapPea census
snappedball.h | Deals with snapped 3-balls in a triangulation
snappedtwosphere.h | Deals with 2-spheres made from two snapped 3-balls in a triangulation
spiralsolidtorus.h | Deals with spiralled solid tori in a triangulation
standardtri.h | Deals with triangulations whose structures are well-understood
trisolidtorus.h | Deals with triangular solid tori in a triangulation
trivialtri.h | Deals with a few specific hard-coded trivial triangulations
txicore.h | Provides various triangulations of the product of the torus and the interval
surfaces |
coordregistry.h | Provides access to a registry of all normal coordinate systems that can be used to create and store normal surfaces in 3-manifold triangulations
disc.h | Deals with individual normal discs and sets of normal discs in a normal surface
disctype.h | Deals with normal and almost normal disc types
filterregistry.h | Provides access to a registry of all normal surface filter classes that can be used to filter lists of normal surfaces in 3-manifold triangulations
ndisc.h | Deprecated header
ndisctype.h | Deprecated header
nnormalsurface.h | Deprecated header
nnormalsurfacelist.h | Deprecated header
normalcoords.h | Defines constants for normal surface coordinate systems
normalflags.h | Defines constants and flags for normal surface enumeration
normalsurface.h | Deals with an individual normal surface in a 3-manifold triangulation
normalsurfaces.h | Contains a packet representing a collection of normal surfaces in a 3-manifold
nprism.h | Deprecated header
nsanstandard.h | Deprecated header
nsmirrored.h | Deprecated header
nsoriented.h | Deprecated header
nsorientedquad.h | Deprecated header
nsquad.h | Deprecated header
nsquadoct.h | Deprecated header
nsstandard.h | Deprecated header
nsurfacefilter.h | Deprecated header
nsvectoranstandard.h | Implements almost normal surface vectors using standard triangle-quad-oct coordinates
nsvectormirrored.h | Provides a normal surface vector that is mirrored in another coordinate system to avoid frequent lengthy calculations
nsvectororiented.h | Implements normal surface vectors using transversly oriented normal surface coordinates
nsvectororientedquad.h | Implements normal surface vectors using transversely oriented quad coordinates
nsvectorquad.h | Implements normal surface vectors using quad coordinates
nsvectorquadoct.h | Implements almost normal surface vectors using quad-oct coordinates
nsvectorstandard.h | Implements normal surface vectors using standard triangle-quad coordinates
prism.h | Deals with triangular prisms defined by slicing along normal quads in a tetrahedron
sfcombination.h | Deprecated header
sfproperties.h | Deprecated header
surfacefilter.h | Contains a packet that filters through normal surfaces
surfacefiltertype.h | Defines constants for normal surface filter types
xmlfilterreader.h | Deals with parsing XML data for normal surface filters
xmlsurfacereader.h | Deals with parsing XML data for normal surface lists
treewidth |
ntreedecomposition.h | Deprecated header
treedecomposition.h | Deals with treewidth and tree decompositions, in particular for facet pairing graphs
triangulation |
alias |
face.h | Provides dimension-specific aliases for dimension-agnostic routines
facenumber.h | Provides dimension-specific aliases for dimension-agnostic routines
isomorphism.h | Provides dimension-specific aliases for dimension-agnostic routines
simplex.h | Provides dimension-specific aliases for dimension-agnostic routines
detail |
boundarycomponent.h | Implementation details for boundary components of triangulations
component.h | Implementation details for connected components of triangulations
example.h | Implementation details for generating example triangulations in arbitrary dimension
face.h | Implementation details for lower-dimensional faces of triangulations
facenumbering.h | Implementation details for describing how subdim-faces are numbered within a dim-dimensional simplex
facetpairing.h | Implementation details for dual graphs of dim-dimensional triangulations
isomorphism.h | Implementation details for combinatorial isomorphisms between triangulations
simplex.h | Implementation details for top-dimensional simplices in a triangulation
strings.h | Implementation details that hard-code strings appropriate for each dimension
triangulation.h | Implementation details for triangulations of arbitrary dimension
xmltrireader.h | Implementation details for parsing XML data for triangulation packets
dim2 |
boundarycomponent2.h | Internal header for boundary components of a 2-manifold triangulation
component2.h | Internal header for connected components of a 2-manifold triangulation
triangle2.h | Internal header for triangular faces in a 2-manifold triangulation
triangulation2.h | Internal header for 2-dimensional triangulations
dim3 |
boundarycomponent3.h | Internal header for components of the boundary of a 3-manifold triangulation
component3.h | Internal header for connected components of a 3-manifold triangulation
tetrahedron3.h | Internal header for tetrahedra in a 3-manifold triangulation
triangle3.h | Internal header for triangles in a 3-manifold triangulation
triangulation3.h | Internal header for 3-dimensional triangulations
vertex3.h | Internal header for vertices in a 3-manifold triangulation
dim4 |
boundarycomponent4.h | Internal header for components of the boundary of a 4-manifold triangulation
component4.h | Internal header for connected components of a 4-manifold triangulation
edge4.h | Internal header for edges in a 4-manifold triangulation
pentachoron4.h | Internal header for 4-dimensional simplices in a 4-manifold triangulation
triangulation4.h | Internal header for 4-dimensional triangulations
vertex4.h | Internal header for vertices in a 4-manifold triangulation
generic |
boundarycomponent.h | Internal header for boundary components of triangulations of arbitrary dimension
component.h | Internal header for connected components of triangulations of arbitrary dimension
face.h | Internal header for faces of triangulations of arbitrary dimension
facetpairing.h | Internal header for dual graphs of triangulations of arbitrary dimension
isomorphism.h | Internal header for combinatorial isomorphisms between triangulations of arbitrary dimension
simplex.h | Internal header for top-dimensional simplices of triangulations of arbitrary dimension
triangulation.h | Internal header for working with triangulations of arbitrary dimension
dim2.h | Includes all headers for working with 2-dimensional triangulations. This includes headers for the main class Triangulation<2>, as well as the face classes Face<2,subdim>, the component classes Component<2> and BoundaryComponent<2>, and the isomorphism class Isomorphism<2>
dim3.h | Includes all headers for working with 3-dimensional triangulations. This includes headers for the main class Triangulation<3>, as well as the face classes Face<3,subdim>, the component classes Component<3> and BoundaryComponent<3>, and the isomorphism class Isomorphism<3>
dim4.h | Includes all headers for working with 4-dimensional triangulations. This includes headers for the main class Triangulation<4>, as well as the face classes Face<4,subdim>, the component classes Component<4> and BoundaryComponent<4>, and the isomorphism class Isomorphism<4>
example.h | Offers some example higher-dimensional triangulations as starting points for testing code or getting used to Regina
example2.h | Offers some example 2-dimensional triangulations as starting points for testing code or getting used to Regina
example3.h | Offers some example 3-dimensional triangulations as starting points for testing code or getting used to Regina
example4.h | Offers some example 4-dimensional triangulations as starting points for testing code or getting used to Regina
facenumbering.h | Describes the way in which subdim-faces are numbered within a dim-dimensional simplex
facepair.h | Deals with simple pairs of face numbers
facetpairing.h | Includes headers for working with facet pairings in all dimensions except for dimension 3. Specifically, this includes headers for the class FacetPairing<dim> for all dim ≠ 3
facetpairing3.h | Deals with dual graphs of 3-manifold triangulations
facetspec.h | Allows lightweight representation of individual facets of simplices
forward.h | Provides forward declarations of Regina's triangulation-related classes
generic.h | Includes all headers for working with higher-dimensional triangulations. This includes headers for the main class Triangulation<dim>, as well as the face classes Face<dim,subdim>, the component classes Component<dim> and BoundaryComponent<dim>, and the isomorphism class Isomorphism<dim>, for all dimensions dim ≥ 5
homologicaldata.h | Deals with all the details of the cellular homology of a manifold
nboundarycomponent.h | Deprecated header
ncomponent.h | Deprecated header
nedge.h | Deprecated header
nexampletriangulation.h | Deprecated header
nfacepair.h | Deprecated header
nfacepairing.h | Deprecated header
nhomologicaldata.h | Deprecated header
nisomorphism.h | Deprecated header
ntetrahedron.h | Deprecated header
ntriangle.h | Deprecated header
ntriangulation.h | Deprecated header
nvertex.h | Deprecated header
pachner.h | Explains terminology used with Pachner moves on triangulations
xmltrireader.h | Deals with parsing XML data for triangulation packets
xmltrireader2.h | Deals with parsing XML data for 2-dimensional triangulation packets
xmltrireader3.h | Deals with parsing XML data for 3-dimensional triangulation packets
xmltrireader4.h | Deals with parsing XML data for 4-dimensional triangulation packets
utilities |
base64.h | Routines for base64 encoding and decoding taken and modified from the Base64 project at base64.sourceforge.net
bitmanip.h | Optimised classes for bitwise analysis and manipulation of native data types
bitmask.h | Provides optimised bitmasks of arbitrary length
boolset.h | Provides various types that extend the standard boolean
flags.h | A template class for handling bitwise combinations of enum flags
i18nutils.h | Various classes and routines for working with internationalisation and character encodings
intutils.h | Miscellaneous utility classes for analysing the built-in integer types at compile time
listoncall.h | Provides lists of expensive objects that are only created when required
markedvector.h | Provides space-efficient arrays with fast object-to-index lookup
memutils.h | Provides object creation and deletion functions for use with the Standard Template Library
nbooleans.h | Deprecated header
osutils.h | Provides miscellaneous helper routines that are specific to particular operating systems
property.h | Deals with calculable properties of individual objects
ptrutils.h | Provides function objects for use in the Standard Template Library that take pointers as arguments but work with the pointees instead
qitmask.h | Provides optimised "base 4 bitmasks" of fixed length
registryutils.h | Miscellaneous utility classes for working with registries of packet types, normal coordinate systems, and so on
safepointeebase.h | Provides a base class for objects pointable by SafePtr
safeptr.h | Provides a smart pointer that is safe in the sense that it cannot be dangling
saferemnant.h | Implementation details for safe pointers
sequence.h | Support for temporary lightweight sequences
stringutils.h | Provides various routines for use with C++ strings
trieset.h | Provides a trie-like structure for storing sets
tritmask.h | Provides optimised "ternary bitmasks" of fixed length
xmlcallback.h | Deals with parsing XML program data at the file level
xmlelementreader.h | Deals with parsing XML program data at the tag level
xmlutils.h | Various classes and routines for XML manipulation, some taken or modified from the libxml++ library. The libxml2 library is used to do most of the underlying work
docs.h | Contains miscellaneous documentation
engine.h | Provides global routines for interfacing with the Regina calculation engine
output.h | Provides a common interface for human-readable text output
regina-core.h | Core definitions that must be included in every Regina header file

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