Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

regina::NManifold Class Reference
[Standard 3-Manifolds]

Represents a particular 3-manifold. More...

#include <nmanifold.h>

Inheritance diagram for regina::NManifold:

regina::ShareableObject regina::boost::noncopyable regina::NHandlebody regina::NLensSpace regina::NSFS regina::NSimpleSurfaceBundle List of all members.

Public Member Functions

virtual ~NManifold ()
 A destructor that does nothing.

std::string getName () const
 Returns the common name of this 3-manifold as a human-readable string.

std::string getTeXName () const
 Returns the common name of this 3-manifold in TeX format.

std::string getStructure () const
 Returns details of the structure of this 3-manifold that might not be evident from its common name.

virtual NTriangulationconstruct () const
 Returns a triangulation of this 3-manifold, if such a construction has been implemented.

virtual NAbelianGroupgetHomologyH1 () const
 Returns the first homology group of this 3-manifold, if such a routine has been implemented.

virtual std::ostream & writeName (std::ostream &out) const =0
 Writes the common name of this 3-manifold as a human-readable string to the given output stream.

virtual std::ostream & writeTeXName (std::ostream &out) const =0
 Writes the common name of this 3-manifold in TeX format to the given output stream.

virtual std::ostream & writeStructure (std::ostream &out) const
 Writes details of the structure of this 3-manifold that might not be evident from its common name to the given output stream.

virtual void writeTextShort (std::ostream &out) const
 Writes this object in short text format to the given output stream.

virtual void writeTextLong (std::ostream &out) const
 Writes this object in long text format to the given output stream.


Detailed Description

Represents a particular 3-manifold.

The triangulation of this 3-manifold that may be in use is not of interest.

Subclasses corresponding to the different types of 3-manifold 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.


Constructor & Destructor Documentation

regina::NManifold::~NManifold  )  [inline, virtual]
 

A destructor that does nothing.


Member Function Documentation

NTriangulation * regina::NManifold::construct  )  const [inline, virtual]
 

Returns a triangulation of this 3-manifold, if such a construction has been implemented.

If no construction routine has yet been implemented for this 3-manifold (for instance, if this 3-manifold is a Seifert fibred space with sufficiently many exceptional fibres) then this routine will return 0.

The details of which 3-manifolds have construction routines can be found in the notes for the corresponding subclasses of NManifold. The default implemention of this routine returns 0.

Returns:
a triangulation of this 3-manifold, or 0 if the appropriate construction routine has not yet been implemented.

Reimplemented in regina::NLensSpace, regina::NSFS, and regina::NSimpleSurfaceBundle.

NAbelianGroup * regina::NManifold::getHomologyH1  )  const [inline, virtual]
 

Returns the first homology group of this 3-manifold, if such a routine has been implemented.

If the calculation of homology has not yet been implemented for this 3-manifold then this routine will return 0.

The details of which 3-manifolds 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.

Returns:
the first homology group of this 3-manifold, or 0 if the appropriate calculation routine has not yet been implemented.

Reimplemented in regina::NHandlebody, regina::NLensSpace, regina::NSFS, and regina::NSimpleSurfaceBundle.

std::string regina::NManifold::getName  )  const
 

Returns the common name of this 3-manifold as a human-readable string.

Returns:
the common name of this 3-manifold.

std::string regina::NManifold::getStructure  )  const
 

Returns details of the structure of this 3-manifold 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.

Returns:
a string describing additional structural details.

std::string regina::NManifold::getTeXName  )  const
 

Returns the common name of this 3-manifold in TeX format.

Leading and trailing dollar signs will be included.

Returns:
the common name of this 3-manifold in TeX format.

virtual std::ostream& regina::NManifold::writeName std::ostream &  out  )  const [pure virtual]
 

Writes the common name of this 3-manifold as a human-readable string to the given output stream.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.
Returns:
a reference to the given output stream.

Implemented in regina::NHandlebody, regina::NLensSpace, regina::NSFS, and regina::NSimpleSurfaceBundle.

std::ostream & regina::NManifold::writeStructure std::ostream &  out  )  const [inline, virtual]
 

Writes details of the structure of this 3-manifold 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.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.
Returns:
a reference to the given output stream.

Reimplemented in regina::NSFS.

virtual std::ostream& regina::NManifold::writeTeXName std::ostream &  out  )  const [pure virtual]
 

Writes the common name of this 3-manifold in TeX format to the given output stream.

Leading and trailing dollar signs will be included.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.
Returns:
a reference to the given output stream.

Implemented in regina::NHandlebody, regina::NLensSpace, regina::NSFS, and regina::NSimpleSurfaceBundle.

void regina::NManifold::writeTextLong std::ostream &  out  )  const [inline, virtual]
 

Writes this object in long text format to the given output stream.

The output should provided the user with all the information they could want. The output should end with a newline.

The default implementation of this routine merely calls writeTextShort() and adds a newline.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.

Reimplemented from regina::ShareableObject.

void regina::NManifold::writeTextShort std::ostream &  out  )  const [inline, virtual]
 

Writes this object in short text format to the given output stream.

The output should fit on a single line and no newline should be written.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.

Implements regina::ShareableObject.


The documentation for this class was generated from the following file:
Copyright © 1999-2003, 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).