Regina Calculation Engine

Represents a particular 3manifold. More...
#include <manifold/nmanifold.h>
Public Member Functions  
virtual  ~NManifold () 
A destructor that does nothing. More...  
std::string  getName () const 
Returns the common name of this 3manifold as a humanreadable string. More...  
std::string  getTeXName () const 
Returns the common name of this 3manifold in TeX format. More...  
std::string  getStructure () const 
Returns details of the structure of this 3manifold that might not be evident from its common name. More...  
virtual NTriangulation *  construct () const 
Returns a triangulation of this 3manifold, if such a construction has been implemented. More...  
virtual NAbelianGroup *  getHomologyH1 () const 
Returns the first homology group of this 3manifold, if such a routine has been implemented. More...  
bool  operator< (const NManifold &compare) const 
Determines in a fairly adhoc fashion whether this representation of this 3manifold is "smaller" than the given representation of the given 3manifold. More...  
virtual std::ostream &  writeName (std::ostream &out) const =0 
Writes the common name of this 3manifold as a humanreadable string to the given output stream. More...  
virtual std::ostream &  writeTeXName (std::ostream &out) const =0 
Writes the common name of this 3manifold in TeX format to the given output stream. More...  
virtual std::ostream &  writeStructure (std::ostream &out) const 
Writes details of the structure of this 3manifold that might not be evident from its common name to the given output stream. More...  
virtual void  writeTextShort (std::ostream &out) const 
Writes this object in short text format to the given output stream. More...  
virtual void  writeTextLong (std::ostream &out) const 
Writes this object in long text format to the given output stream. More...  
Public Member Functions inherited from regina::ShareableObject  
ShareableObject ()  
Default constructor that does nothing. More...  
virtual  ~ShareableObject () 
Default destructor that does nothing. More...  
std::string  str () const 
Returns the output from writeTextShort() as a string. More...  
std::string  toString () const 
A deprecated alias for str(), which returns the output from writeTextShort() as a string. More...  
std::string  detail () const 
Returns the output from writeTextLong() as a string. More...  
std::string  toStringLong () const 
A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More...  
Additional Inherited Members  
Protected Member Functions inherited from regina::boost::noncopyable  
noncopyable ()  
A constructor which does nothing. More...  
~noncopyable ()  
A destructor which does nothing. More...  
Represents a particular 3manifold.
The triangulation of this 3manifold that may be in use is not of interest.
Subclasses corresponding to the different types of 3manifold must override at least the virtual functions writeName() and writeTeXName(). They do not need to override writeTextShort() or writeTextLong() since these routines are properly implemented in the base class NManifold.

inlinevirtual 
A destructor that does nothing.

inlinevirtual 
Returns a triangulation of this 3manifold, if such a construction has been implemented.
If no construction routine has yet been implemented for this 3manifold (for instance, if this 3manifold is a Seifert fibred space with sufficiently many exceptional fibres) then this routine will return 0.
The details of which 3manifolds have construction routines can be found in the notes for the corresponding subclasses of NManifold. The default implemention of this routine returns 0.
Reimplemented in regina::NSFSpace, regina::NSnapPeaCensusManifold, regina::NLensSpace, and regina::NSimpleSurfaceBundle.

inlinevirtual 
Returns the first homology group of this 3manifold, if such a routine has been implemented.
If the calculation of homology has not yet been implemented for this 3manifold then this routine will return 0.
The details of which 3manifolds have homology calculation routines can be found in the notes for the corresponding subclasses of NManifold. The default implemention of this routine returns 0.
The homology group will be newly allocated and must be destroyed by the caller of this routine.
Reimplemented in regina::NSFSpace, regina::NGraphTriple, regina::NGraphPair, regina::NGraphLoop, regina::NSnapPeaCensusManifold, regina::NTorusBundle, regina::NLensSpace, regina::NSimpleSurfaceBundle, and regina::NHandlebody.
std::string regina::NManifold::getName  (  )  const 
Returns the common name of this 3manifold as a humanreadable string.
std::string regina::NManifold::getStructure  (  )  const 
Returns details of the structure of this 3manifold that might not be evident from its common name.
For instance, for an orbit space S^3/G this routine might return the full Seifert structure.
This routine may return the empty string if no additional details are deemed necessary.
std::string regina::NManifold::getTeXName  (  )  const 
Returns the common name of this 3manifold in TeX format.
No leading or trailing dollar signs will be included.
bool regina::NManifold::operator<  (  const NManifold &  compare  )  const 
Determines in a fairly adhoc fashion whether this representation of this 3manifold is "smaller" than the given representation of the given 3manifold.
The ordering imposed on 3manifolds is purely aesthetic on the part of the author, and is subject to change in future versions of Regina.
The ordering also depends on the particular representation of the 3manifold that is used. As an example, different representations of the same Seifert fibred space might well be ordered differently.
All that this routine really offers is a welldefined way of ordering 3manifold representations.
compare  the 3manifold representation with which this will be compared. 
true
if and only if this is "smaller" than the given 3manifold representation.

pure virtual 
Writes the common name of this 3manifold as a humanreadable string to the given output stream.
out  the output stream to which to write. 
Implemented in regina::NSFSpace, regina::NGraphTriple, regina::NGraphPair, regina::NGraphLoop, regina::NSnapPeaCensusManifold, regina::NTorusBundle, regina::NLensSpace, regina::NSimpleSurfaceBundle, and regina::NHandlebody.

inlinevirtual 
Writes details of the structure of this 3manifold that might not be evident from its common name to the given output stream.
For instance, for an orbit space S^3/G this routine might write the full Seifert structure.
This routine may write nothing if no additional details are deemed necessary. The default implementation of this routine behaves in this way.
out  the output stream to which to write. 
Reimplemented in regina::NSFSpace, and regina::NSnapPeaCensusManifold.

pure virtual 
Writes the common name of this 3manifold in TeX format to the given output stream.
No leading or trailing dollar signs will be included.
out  the output stream to which to write. 
Implemented in regina::NSFSpace, regina::NGraphTriple, regina::NGraphPair, regina::NGraphLoop, regina::NSnapPeaCensusManifold, regina::NTorusBundle, regina::NLensSpace, regina::NSimpleSurfaceBundle, and regina::NHandlebody.

inlinevirtual 
Writes this object in long text format to the given output stream.
The output should provide the user with all the information they could want. The output should be humanreadable, should not contain extremely long lines (so users can read the output in a terminal), and should end with a final newline.
The default implementation of this routine merely calls writeTextShort() and adds a newline.
out  the output stream to which to write. 
Reimplemented from regina::ShareableObject.

inlinevirtual 
Writes this object in short text format to the given output stream.
The output should be humanreadable, should fit on a single line, and should not end with a newline.
out  the output stream to which to write. 
Implements regina::ShareableObject.