Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
regina::BitManipulator< T, size >An optimised class for bitwise analysis and manipulation of native data types
regina::NPacket::ChangeEventBlockAn object that temporarily blocks listeners from being notified of packet change events
regina::CompressionBufferAn output stream buffer that compresses data as it is written
regina::CompressionStreamAn output stream that compresses data as it is written
regina::DecompressionBufferAn input stream buffer that decompresses data as it is read
regina::DecompressionStreamAn input stream that decompresses data as it is read
regina::FuncDelete< T >An adaptable unary function used to deallocate objects
regina::FuncNew< T >An adaptable generator used to create objects using default constructors
regina::FuncNewClonePtr< T >An adaptable unary function used to create objects using the clone() method
regina::FuncNewCopyPtr< T >An adaptable unary function used to create objects using copy constructors
regina::FuncNewCopyRef< T >An adaptable unary function used to create objects using copy constructors
regina::python::GlobalArray< T, ReturnValuePolicy >A template class that references a constant one-dimensional C++ array
regina::python::GlobalArray2D< T, ReturnValuePolicy >A template class that references a constant two-dimensional C++ array
regina::python::GlobalArray3D< T, ReturnValuePolicy >A template class that references a constant three-dimensional C++ array
regina::HashPointerA hash function used to calculate hash values for arbitrary pointers
regina::HashStringA hash function used to calculate hash values for C++ strings
regina::i18n::IConvStreamAn output stream that converts between character encodings
regina::i18n::IConvStreamBufferAn output stream buffer that translates between character encodings
regina::LessDeref< T, Comp >An adaptable binary function used to compare the objects to which pointers are pointing
regina::i18n::LocaleA simple class with static routines for querying information about the current locale
regina::NMutex::MutexLockA utility class for locking and unlocking a mutex
regina::NAbelianGroupRepresents a finitely generated abelian group
regina::NAngleStructureRepresents an angle structure on a triangulation
regina::NAngleStructureListA packet representing a collection of angle structures on a triangulation
regina::NAngleStructureVectorA vector of integers used to indirectly store the individual angles in an angle structure
regina::NAugTriSolidTorusRepresents an augmented triangular solid torus component of a triangulation
regina::NBitmaskA bitmask that can store arbitrarily many true-or-false bits
regina::NBitmask1< T >A small but extremely fast bitmask class that can store up to 8 * sizeof(T) true-or-false bits
regina::NBitmask2< T, U >A small but extremely fast bitmask class that can store up to 8 * sizeof(T) + 8 * sizeof(U) true-or-false bits
regina::NBlockedSFSRepresents a blocked Seifert fibred space
regina::NBlockedSFSLoopRepresents a blocked Seifert fibred space with two boundary tori that are joined together
regina::NBlockedSFSPairRepresents a blocked pair of Seifert fibred spaces joined along a single connecting torus
regina::NBlockedSFSTripleRepresents a blocked sequence of three Seifert fibred spaces joined along connecting tori
regina::NBoolSetA set of booleans
regina::NBoundaryComponentRepresents a component of the boundary of a triangulation
regina::NCensusA utility class used to form a complete census of 3-manifold triangulations satisfying certain constraints
regina::NClosedPrimeMinSearcherA 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
regina::NCompactSearcherA gluing permutation search class that offers a specialised search algorithm for when only compact (finite) 3-manifold triangulations are required
regina::NComponentRepresents a component of a triangulation
regina::NContainerA packet that simply contains other packets
regina::NDiscSetSurfaceRepresents the set of all normal discs forming a normal surface
regina::NDiscSetSurfaceData< T >Stores data of type T for every normal disc within a particular normal surface
regina::NDiscSetTetRepresents a set of normal discs inside a single tetrahedron
regina::NDiscSetTetData< T >Stores data of type T for every normal disc inside a single tetrahedron
regina::NDiscSpecSpecifies a single normal disc in a normal surface
regina::NDiscSpecIteratorAn iterator used for running through all normal discs in a normal surface
regina::NDiscTypeIdentifies a single normal or almost normal disc type within a triangulation
regina::NDoubleDescriptionImplements a modified double description method for polytope vertex enumeration
regina::NEdgeRepresents an edge in the skeleton of a triangulation
regina::NEdgeEmbeddingDetails how an edge in the skeleton forms part of an individual tetrahedron
regina::NEnumConstraintListRepresents an individual validity constraint for use with polytope vertex enumeration
regina::NExampleTriangulationThis class offers routines for constructing sample triangulations of various types
regina::NFaceRepresents a face in the skeleton of a triangulation
regina::NFaceEmbeddingDetails how a face in the skeleton forms part of an individual tetrahedron
regina::NFacePairRepresents a pair of tetrahedron face numbers
regina::NFacePairingRepresents a specific pairwise matching of tetrahedron faces
regina::NFastRayA fast but inflexible class storing a ray rooted at the origin whose coordinates are rational
regina::NFastVector< T >A fast but inflexible vector of elements from a given ring T
regina::NFileRepresents an old-style binary file containing a packet tree
regina::NFileInfoStores information about a Regina data file, including file type and version
regina::NFilePropertyReaderAssists with reading individual object properties from old-style binary data files
regina::NGlobalDirsProvides global routines that return directories in which various components of Regina are installed on the system
regina::NGluingPermsRepresents a specific set of gluing permutations to complement a particular pairwise matching of tetrahedron faces
regina::NGluingPermSearcherA utility class for searching through all possible gluing permutation sets that correspond to a given face pairing
regina::NGraphLoopRepresents a closed graph manifold formed by joining a single bounded Seifert fibred space to itself along a torus
regina::NGraphPairRepresents a closed graph manifold formed by joining two bounded Seifert fibred spaces along a common torus
regina::NGraphTripleRepresents a closed graph manifold formed by joining three bounded Seifert fibred spaces along their torus boundaries
regina::NGroupExpressionRepresents an expression involving generators from a group presentation
regina::NGroupExpressionTermRepresents a power of a generator in a group presentation
regina::NGroupPresentationRepresents a finite presentation of a group
regina::NHandlebodyRepresents an arbitrary handlebody
regina::NHomMarkedAbelianGroupRepresents a homomorphism of finitely generated abelian groups
regina::NHomologicalDataData type that deals with all the detailed homological information in a manifold
regina::NIndexedArray< Data, HashFcn, EqualTo >A dynamically resizable array of objects of type T with fast random access and fast object-to-index lookup
regina::NIsomorphismRepresents a combinatorial isomorphism from one triangulation into another
regina::NIsomorphismDirectA deprecated synonym for NIsomorphism, provided for backward compatibility only
regina::NL31PillowRepresents a triangular pillow L(3,1) component of a triangulation
regina::NLargeIntegerRepresents an arbitrary precision integer
regina::NLayeredChainRepresents a layered chain in a triangulation
regina::NLayeredChainPairRepresents a layered chain pair component of a triangulation
regina::NLayeredLensSpaceRepresents a layered lens space component of a triangulation
regina::NLayeredLoopRepresents a layered loop component of a triangulation
regina::NLayeredSolidTorusRepresents a layered solid torus in a triangulation
regina::NLayeredTorusBundleDescribes a layered torus bundle
regina::NLayeringRepresents a layering of zero or more tetrahedra upon a torus boundary
regina::NLensSpaceRepresents a general Lens space
regina::NListOnCall< T >Offers a hard-coded list of expensive objects that should only be created if they are required
regina::NLocalFileResourceA random access resource that is simply a local file
regina::NManifoldRepresents a particular 3-manifold
regina::NMarkedAbelianGroupRepresents a finitely generated abelian group given by a chain complex
regina::NMarkedElementA base class for elements of NMarkedVector
regina::NMarkedVector< T >A vector of objects with fast, space-efficient reverse lookup of array indices
regina::NMatrix< T >Represents a matrix of elements of the given type T
regina::NMatrix2Represents a 2-by-2 integer matrix
regina::NMatrixIntRepresents a matrix of arbitrary precision integers
regina::NMatrixRing< T >Represents a matrix of elements from a given ring T
regina::NMutexA mutual exclusion device (mutex) used to ensure that different threads do not interfere when working with the same data
regina::NNormalSurfaceRepresents a single normal surface in a 3-manifold
regina::NNormalSurfaceListA packet representing a collection of normal surfaces in a 3-manifold
regina::NNormalSurfaceVectorStores the vector of a single normal surface in a 3-manifold
regina::NNormalSurfaceVectorANStandardAn almost normal surface vector using standard triangle-quad-oct coordinates
regina::NNormalSurfaceVectorMirroredA normal surface vector that is mirrored in another coordinate system to avoid frequent lengthy calculations
regina::NNormalSurfaceVectorQuadA normal surface vector using quad coordinates
regina::NNormalSurfaceVectorQuadOctAn almost normal surface vector using quad-oct coordinates
regina::NNormalSurfaceVectorStandardA normal surface vector using standard triangle-quad coordinates
regina::boost::noncopyableA base class that guarantees that derived classes cannot be copied
regina::NPacketRepresents a packet of information that may be individually edited or operated upon
regina::NPacketListenerAn object that can be registered to listen for packet events
regina::NPDFA packet that can hold a PDF document
regina::NPermRepresents a permutation of {0,1,2,3}
regina::NPermItS4An iterator class that runs through all 24 permutations of four elements
regina::NPillowTwoSphereRepresents a 2-sphere made from two faces glued together along their three edges
regina::NPluggedTorusBundleDescribes a triangulation of a graph manifold formed by joining a bounded saturated region with a thin I-bundle over the torus, possibly with layerings in between
regina::NPlugTriSolidTorusRepresents a plugged triangular solid torus component of a triangulation
regina::NPrimesA helper class for finding primes and factorising integers
regina::NPrismSetSurfaceRepresents the set of prisms defined by slicing along all the quads in a particular normal surface
regina::NPrismSpecSpecifies a single triangular prism in a tetrahedron
regina::NProgressAn object through which external interfaces can obtain progress reports when running long calculations
regina::NProgressFinishedA progress report that immediately claims it is finished
regina::NProgressManagerManages the sharing of an NProgress object between reading and writing threads
regina::NProgressMessageA progress report in which the current state of progress is stored as a string message
regina::NProgressNumberA progress report in which the current state of progress is stored as a number of items completed
regina::NProgressStateNumericA simple structure used for passing around a numeric state of progress
regina::NProperty< T, Storage >Stores a calculable property of an object
regina::NPropertyBaseA base class that provides routines shared by all properties, regardless of their individual NProperty template parameters
regina::NRandomAccessResourceProvides a standard random access interface for old-style binary file-like resources
regina::NRationalRepresents an arbitrary precision rational number
regina::NRayA slow but flexible class storing a ray rooted at the origin whose coordinates are rational
regina::NSatAnnulusRepresents an annulus formed from a pair of faces in a Seifert fibred space
regina::NSatBlockRepresents a saturated block in a Seifert fibred space
regina::NSatBlockSpecDescribes how a single saturated block forms a part of a larger saturated region
regina::NSatBlockStarterContains a triangulation of a saturated block along with the accompanying saturated block description
regina::NSatBlockStarterSearcherA helper class for locating and using starter blocks within a triangulation
regina::NSatBlockStarterSetRepresents a set of starter blocks that can be used for identifying triangulations of Seifert fibred spaces
regina::NSatCubeA saturated block that is a six-tetrahedron cube
regina::NSatLayeringA degenerate saturated block that is a single tetrahedron wrapped around so that two opposite edges touch
regina::NSatLSTA saturated block that is a layered solid torus
regina::NSatMobiusA degenerate zero-tetrahedron saturated block that corresponds to attaching a Mobius band to a single annulus boundary
regina::NSatReflectorStripA saturated block that is a reflector strip
regina::NSatRegionA large saturated region in a Seifert fibred space formed by joining together saturated blocks
regina::NSatTriPrismA saturated block that is a three-tetrahedron triangular prism
regina::NScriptA packet representing a script that can be run
regina::NSFSAltSetProvides a variety of alternative representations of a single bounded Seifert fibred space
regina::NSFSFibreRepresents an exceptional (alpha, beta) fibre in a Seifert fibred space
regina::NSFSpaceRepresents a general Seifert fibred space, which may be orientable or non-orientable
regina::NSigCensusA utility class used by formSigCensus()
regina::NSignatureRepresents a signature of a splitting surface in a closed 3-manifold triangulation
regina::NSigPartialIsomorphismRepresents a partial isomorphism between two splitting surface signatures
regina::NSimpleSurfaceBundleRepresents a particularly simple closed surface bundle over the circle
regina::NSnapPeaCensusManifoldRepresents a 3-manifold from the SnapPea cusped census
regina::NSnapPeaCensusTriRepresents a 3-manifold triangulation from the SnapPea cusped census
regina::NSnapPeaTriangulationOffers direct access to the SnapPea kernel from within Regina
regina::NSnappedBallRepresents a snapped 3-ball in a triangulation
regina::NSnappedTwoSphereRepresents a 2-sphere made from two snapped 3-balls in a triangulation
regina::NSpiralSolidTorusRepresents a spiralled solid torus in a triangulation
regina::NStandardTriangulationDescribes a triangulation or subcomplex of a triangulation whose structure is well-understood
regina::NSurfaceFilterA packet that accepts or rejects normal surfaces
regina::NSurfaceFilterCombinationA normal surface filter that simply combines other filters
regina::NSurfaceFilterPropertiesA normal surface filter that filters by basic properties of the normal surface
regina::NSurfaceSetRepresents a collection of normal surfaces in a 3-manifold
regina::NSurfaceSubsetRepresents a subset of a normal surface set
regina::NTetFaceA lightweight class used to refer to a particular face of a particular tetrahedron
regina::NTetrahedronRepresents a tetrahedron in a triangulation
regina::NTextA packet representing a text string
regina::NThreadProvides very basic thread handling
regina::NTorusBundleRepresents a torus bundle over the circle
regina::NTriangulationStores the triangulation of a 3-manifold along with its various cellular structures and other information
regina::NTriBoolA three-way extension of the boolean type
regina::NTriBool_Illegal_Integer_ConversionAn exception thrown when an illegal integer conversion is attempted with NTriBool
regina::NTriSolidTorusRepresents a three-tetrahedron triangular solid torus in a triangulation
regina::NTrivialTriRepresents one of a few particular trivial triangulations that do not belong to any of the other larger families
regina::NTxICoreProvides a triangulation of the product T x I (the product of the torus and the interval)
regina::NTxIDiagonalCoreOne of a family of thin T x I triangulations that typically appear at the centres of layered torus bundles
regina::NTxIParallelCoreA specific six-tetrahedron NTxICore triangulation that does not fit neatly into other families
regina::NVector< T >A slow but flexible vector class of elements from a given ring T
regina::NVectorDense< T >A dense vector of objects of type T
regina::NVectorMatrix< T >A vector that corresponds to a row or column of a matrix
regina::NVectorMatrix_Illegal_ModificationAn exception thrown when a matrix row or column vector is modified
regina::NVectorMatrixCol< T >A vector that corresponds to a column of a matrix
regina::NVectorMatrixRow< T >A vector that corresponds to a row of a matrix
regina::NVectorUnit< T >A unit vector of type T
regina::NVectorUnit_Illegal_ModificationAn exception thrown when a unit vector is modified
regina::NVertexRepresents a vertex in the skeleton of a triangulation
regina::NVertexEmbeddingDetails how a vertex in the skeleton forms part of an individual tetrahedron
regina::NXMLAbelianGroupReaderAn XML element reader that reads a single abelian group
regina::NXMLAngleStructureListReaderAn XML packet reader that reads a single angle structure list
regina::NXMLAngleStructureReaderAn XML element reader that reads a single angle structure
regina::NXMLCallbackProvides the callbacks for an XMLParser required to parse an entire file using a series of NXMLElementReader objects
regina::NXMLCharsReaderA reader for an XML element that contains only characters
regina::NXMLContainerReaderAn XML packet reader that reads a single container
regina::NXMLElementReaderUsed to read the contents of a single XML element
regina::NXMLFilterPacketReaderAn XML packet reader that reads a single surface filter
regina::NXMLFilterReaderAn XML element reader that reads the specific details of a normal surface filter
regina::NXMLGroupPresentationReaderAn XML element reader that reads a single group presentation
regina::NXMLNormalSurfaceListReaderAn XML packet reader that reads a single normal surface list
regina::NXMLNormalSurfaceReaderAn XML element reader that reads a single normal surface
regina::NXMLPacketReaderAn XML element reader that reads the data for an individual packet
regina::NXMLPDFReaderAn XML packet reader that reads a single PDF packet
regina::NXMLScriptReaderAn XML packet reader that reads a single script
regina::NXMLTextReaderAn XML packet reader that reads a single text packet
regina::NXMLTriangulationReaderAn XML packet reader that reads a single triangulation
regina::boost::reference_wrapper< T >A wrapper allowing references to be passed through generic functions
regina::boost::remove_pointer< T >A template class used to remove the indirection from a pointer type
regina::stl::select1st< Pair >An adaptable unary function used to select the first element of a pair
regina::stl::select2nd< Pair >An adaptable unary function used to select the second element of a pair
regina::ShareableObjectFacilitates mirroring objects in the underlying C++ calculation engine using the various wrapper classes provided in the various external interfaces (such as the Python interface)
regina::StoreConstPtr< T >An NProperty storage policy indicating that the property should be held by constant pointer
regina::StoreManagedPtr< T >An NProperty storage policy indicating that the property should be held by pointer and that the property wrapper will also take responsibility for memory management
regina::StoreValue< T >An NProperty storage policy indicating that the property should be held by value
regina::NAngleStructureList::StructureInserterAn output iterator used to insert angle structures into an NAngleStructureList
regina::NNormalSurfaceList::SurfaceInserterAn output iterator used to insert surfaces into an NNormalSurfaceList
regina::NCompactSearcher::TetEdgeStateA structure used to track equivalence classes of tetrahedron edges as the gluing permutation is constructed
regina::NCompactSearcher::TetVertexStateA structure used to track equivalence classes of tetrahedron vertices as the gluing permutation is constructed
regina::stl::unary_compose< Operation1, Operation2 >An adaptable unary function used to compose two unary functions
regina::xml::XMLParserUsed to parse an entire XML file
regina::xml::XMLParserCallbackProvides the callbacks for an XMLParser
regina::xml::XMLPropertyDictRepresents a hashed map from property names to property values
regina::ZBufferA common base class for compression/decompression stream buffers

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