Regina Calculation Engine File List

Here is a list of all documented files with brief descriptions:
approx.hProvides facilities for working around rounding errors when dealing with real numbers
boostutils.hMiscellaneous utility classes taken or modified from the Boost C++ libraries
dehydration.hAllows reading lists of dehydrated triangulations
docs.hContains miscellaneous documentation
engine.hProvides global routines for interfacing with the Regina calculation engine
filterregistry.hContains a registry of normal surface filtering classes known to the engine. Each such class should be a subclass of NSurfaceFilter
flavourregistry.hContains a registry of coordinate system flavours known to the engine that can actually be used to create and store normal surfaces
globalarray.hAllows global C++ arrays to be wrapped neatly in Python
hashmap.hIncludes the Standard Template Library hash map header
hashset.hIncludes the Standard Template Library hash set header
hashutils.hProvides a variety of hash functions for use with the Standard Template Library
matrixops.hProvides various complex matrix calculations
memutils.hProvides object creation and deletion functions for use with the Standard Template Library
nabeliangroup.hDeals with finitely generated abelian groups
nanglestructure.hDeals with angle structures on triangulations
nanglestructurelist.hContains a packet representing a collection of angle structures on a triangulation
naugtrisolidtorus.hDeals with augmented triangular solid torus components of a triangulation
nblockedsfs.hSupports closed Seifert fibred spaces that are triangulated using saturated blocks
nblockedsfsloop.hSupports self-identified Seifert fibred spaces that are triangulated using saturated blocks
nblockedsfspair.hSupports joined pairs of Seifert fibred spaces that are triangulated using saturated blocks
nblockedsfstriple.hSupports joined sequences of three Seifert fibred spaces that are triangulated using saturated blocks
nbooleans.hProvides various types that extend the standard boolean
nboundarycomponent.hDeals with components of the boundary of a triangulation
ncensus.hDeals with forming a census of all triangulations of a given size
ncompconstraint.hDeals with compatibility constraints in polytope vertex enumeration
ncomponent.hDeals with components of a triangulation
ncontainer.hContains a packet whose entire life purpose is to contain other packets
ndisc.hDeals with individual normal discs and sets of normal discs in a normal surface
ndoubledescriptor.hProvides a modified double descriptor method for polytope vertex enumeration
nedge.hDeals with edges in a triangulation
nenumerator.hProvides the basic infrastructure for polytope vertex enumeration
nexampletriangulation.hOffers several example triangulations as starting points for testing code or getting used to Regina
nface.hDeals with faces in a triangulation
nfacepair.hDeals with simple pairs of face numbers
nfacepairing.hDeals with pairing off tetrahedron faces in a triangulation census
nfile.hDeals with reading and writing packet trees to and from old-style binary files
nfileinfo.hDeals with determining information about Regina data files
nfilepropertyreader.hDeals with reading individual properties of objects from old-style binary files
ngluingperms.hDeals with selecting gluing permutations to complement a particular pairing of tetrahedron faces
ngluingpermsearcher.hSupports searching through all possible gluing permutations sets for a given face pairing
ngraphloop.hDeals with graph manifolds formed from self-identified Seifert fibred spaces
ngraphpair.hDeals with graph manifolds formed from pairs of Seifert fibred spaces
ngraphtriple.hDeals with graph manifolds formed from sequences of three Seifert fibred spaces
ngrouppresentation.hDeals with finite presentations of groups
nhandlebody.hDeals with arbitrary handlebodies
nindexedarray.hDeals with arrays of objects with fast object-to-index lookup
nisomorphism.hDeals with combinatorial isomorphisms of triangulations
nl31pillow.hDeals with triangular pillow L(3,1) components of a triangulation
nlayeredchain.hDeals with layered chains in a triangulation
nlayeredchainpair.hDeals with layered chain pair components of a triangulation
nlayeredlensspace.hDeals with layered lens space components of a triangulation
nlayeredloop.hDeals with layered loop components of a triangulation
nlayeredsolidtorus.hDeals with layered solid tori in a triangulation
nlayeredsurfacebundle.hDeals with layered surface bundle triangulations
nlayering.hAssists with the analysis of layerings upon a torus boundary
nlensspace.hDeals with general Lens spaces
nlistoncall.hProvides lists of expensive objects that are only created when required
nmanifold.hDeals with the underlying 3-manifolds of triangulations
nmatrix.hDeals with matrices of elements of various types
nmatrix2.hDeals with 2x2 integer matrices
nmatrixfield.hDeals with matrices of elements from a given field
nmatrixint.hDeals with matrices of arbitrary precision integers
nmpi.hDeals with arbitrary precision integers
nnormalsurface.hDeals with an individual normal surface
nnormalsurfacelist.hContains a packet representing a collection of normal surfaces in a 3-manifold
notation.hExplains notation used for describing various types of 3-manifold
npacket.hDeals with packets of information that form the working data objects
npacketlistener.hDeals with objects that can listen for packet events
nperm.hDeals with permutations of {0,1,2,3}
npermit.hProvides utilities for iterating through permutations
npillowtwosphere.hDeals with 2-spheres made from two faces glued along their three edges
npluggedtorusbundle.hSupports self-identified Seifert fibred spaces that are triangulated using a combination of thin I-bundles and saturated blocks
nplugtrisolidtorus.hDeals with plugged triangular solid torus components of a triangulation
nprism.hDeals with triangular prisms defined by slicing along normal quads in a tetrahedron
nprogress.hAllows external interfaces to obtain progress reports when running long calculations
nprogressmanager.hFacilitates sharing NProgress objects between an operation thread and an external interface
nprogresstypes.hProvides specific methods of representing progress reports
nproperty.hDeals with calculable properties of individual objects
nrational.hDeals with artibrary precision rational numbers
nray.hDeals with rational rays rooted at the origin
nresources.hProvides methods for accessing old-style binary file-like resources
nsanstandard.hImplements almost normal surface vectors using standard triangle-quad-oct coordinates
nsatannulus.hDeals with saturated two-face annuli within a Seifert fibred space
nsatblock.hDeals with saturated blocks in triangulations of Seifert fibred spaces
nsatblockstarter.hProvides a hard-coded list of saturated blocks to use as starting points for recognising larger Seifert fibred spaces
nsatblocktypes.hDescribes several types of saturated blocks within Seifert fibred space triangulations
nsatregion.hSupports connected regions of saturated blocks in triangulations of Seifert fibred spaces
nscript.hContains a packet representing a script
nsfs.hDeals with general Seifert fibred spaces
nsfsaltset.hAssists with providing different representations of the same Seifert fibred space
nsigcensus.hDeals with forming a census of splitting surface signatures
nsigisomorphism.hDeals with full and partial isomorphisms of splitting surface signatures
nsignature.hDeals with signatures of splitting surfaces
nsimplesurfacebundle.hDeals with simple closed surface bundles
nsmirrored.hProvides a normal surface vector that is mirrored in another coordinate system to avoid frequent lengthy calculations
nsnappeacensusmfd.hDeals with 3-manifolds from the SnapPea census
nsnappeacensustri.hDeals with 3-manifold triangulations from the SnapPea census
nsnappeatriangulation.hAllows Regina triangulations to interact with the SnapPea kernel
nsnappedball.hDeals with snapped 3-balls in a triangulation
nsnappedtwosphere.hDeals with 2-spheres made from two snapped 3-balls in a triangulation
nspiralsolidtorus.hDeals with spiralled solid tori in a triangulation
nsquad.hImplements normal surface vectors using quad coordinates
nsstandard.hImplements normal surface vectors using standard triangle-quad coordinates
nstandardtri.hDeals with triangulations whose structures are well-understood
nsurfacefilter.hContains a packet that filters through normal surfaces
nsurfaceset.hProvides access to a collection of normal surfaces
nsurfacesubset.hProvides subsets of normal surface sets
ntetface.hAllows lightweight representation of individual tetrahedron faces
ntetrahedron.hDeals with tetrahedra in a triangulation
ntext.hContains a packet representing a text string
nthread.hProvides very basic thread handling
ntorusbundle.hDeals with torus bundles over the circle
ntriangulation.hDeals with triangulations
ntrisolidtorus.hDeals with triangular solid tori in a triangulation
ntrivialtri.hDeals with a few specific trivial triangulations
ntxicore.hProvides various triangulations of the product of the torus and the interval
numbertheory.hProvides miscellaneous number theory routines
nvector.hDeals with vectors of elements of various types
nvectordense.hDeals with dense vectors of various types
nvectormatrix.hDeals with vectors that are rows or columns of matrices
nvectorunit.hDeals with unit vectors of various types
nvertex.hDeals with vertices in a triangulation
nxmlalgebrareader.hDeals with parsing XML data for various algebraic structures
nxmlanglestructreader.hDeals with parsing XML data for angle structure lists
nxmlcallback.hDeals with parsing XML program data at the file level
nxmlelementreader.hDeals with parsing XML program data at the tag level
nxmlfile.hDeals with storing program data (including packet trees) in XML data files
nxmlfilterreader.hDeals with parsing XML data for normal surface filters
nxmlpacketreader.hDeals with parsing XML data for individual packets
nxmlpacketreaders.hDeals with parsing XML data for various basic packet types
nxmlsurfacereader.hDeals with parsing XML data for normal surface lists
nxmltrireader.hDeals with parsing XML data for triangulation packets
orb.hAllows reading Orb / Casson triangulation files
packetregistry.hContains a registry of packet types known to the engine
ptrutils.hProvides function objects for use in the Standard Template Library that take pointers as arguments but work with the pointees instead
sfcombination.hContains a normal surface filter that simply combines other filters
sfproperties.hContains a normal surface filter that filters by basic properties
shareableobject.hDeals with objects that can be shared from the calculation engine with the outside world
snappea.hAllows reading and writing SnapPea files
stlutils.hMiscellaneous utility classes and routines taken or modified from the Standard Template Library
stringutils.hProvides various routines for use with C++ strings
xmlutils.hVarious 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
zstream.hProvides compressed I/O streams

Copyright © 1999-2006, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).