Represents a particular 3-manifold, independent of how it might be triangulated. More...

#include <manifold/manifold.h>

Inheritance diagram for regina::Manifold:

Public Member Functions
virtual	~Manifold ()=default
	A destructor that does nothing. More...

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

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

std::string	TeXName () const
	Deprecated routine that returns the common name of this 3-manifold in TeX format. More...

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

virtual Triangulation< 3 >	construct () const
	Returns a triangulation of this 3-manifold, if such a construction has been implemented. More...

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

AbelianGroup	homologyH1 () const
	A deprecated alias for homology(). More...

virtual bool	isHyperbolic () const =0
	Returns whether or not this is a finite-volume hyperbolic manifold. More...

bool	operator< (const Manifold &compare) const
	Determines in a fairly ad-hoc fashion whether this representation of this 3-manifold is "smaller" than the given representation of the given 3-manifold. More...

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

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

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

void	writeTextShort (std::ostream &out) const
	Writes a short text representation of this object to the given output stream. More...

void	writeTextLong (std::ostream &out) const
	Writes a detailed text representation of this object to the given output stream. More...

std::string	str () const
	Returns a short text representation of this object. More...

std::string	utf8 () const
	Returns a short text representation of this object using unicode characters. More...

std::string	detail () const
	Returns a detailed text representation of this object. More...

Protected Member Functions
	Manifold ()=default
	A default constructor. More...

	Manifold (const Manifold &)=default
	A copy constructor. More...

Manifold &	operator= (const Manifold &)=default
	A copy assignment operator. More...

Detailed Description

Represents a particular 3-manifold, independent of how it might be triangulated.

This is an abstract base class: its subclasses correspond to different families of 3-manifolds.

Each subclass:

must override all pure virtual functions (of course);
may optionally override construct(), homology() and/or writeStructure(), if they are able to provide this functionality;
must not override writeTextShort() or writeTextLong(), since these routines are not virtual, and are provided directly by the Manifold base class;
must provide value semantics (including at least a copy constructor and assignment operator);
must provide comparison operators (== and !=);
must provide member and global swap functions, for consistency across all Manifold subclasses.

Constructor & Destructor Documentation

◆ ~Manifold()

virtual regina::Manifold::~Manifold ( )

virtualdefault

A destructor that does nothing.

◆ Manifold() [1/2]

regina::Manifold::Manifold ( )

protecteddefault

A default constructor.

This does nothing in the base Manifold class, and is not for public use. It is declared here so that subclasses can use it implicitly in their own default constructors.

◆ Manifold() [2/2]

regina::Manifold::Manifold ( const Manifold & )

protecteddefault

A copy constructor.

This does nothing in the base Manifold class, and is not for public use. It is declared here so that subclasses can use it implicitly in their own copy constructors.

Member Function Documentation

◆ construct()

virtual Triangulation< 3 > regina::Manifold::construct ( ) const

virtual

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

For details of which types of 3-manifolds have implemented this routine, see the class notes for each corresponding subclasses of Manifold.

The default implemention of this routine just throws a NotImplemented exception.

Exceptions

NotImplemented	explicit construction has not yet been implemented for this particular 3-manifold.
FileError	the construction needs to be read from file (as opposed to computed on the fly), but the file is inaccessible or its contents cannot be read and parsed correctly. Currently this can only happen for the subclass SnapPeaCensusManifold, which reads its triangulations from the SnapPea census databases that are installed with Regina.

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

Reimplemented in regina::LensSpace, regina::SFSpace, regina::SimpleSurfaceBundle, and regina::SnapPeaCensusManifold.

◆ detail()

std::string regina::Output< Manifold , false >::detail ( ) const

inherited

Returns a detailed text representation of this object.

This text may span many lines, and should provide the user with all the information they could want. It should be human-readable, should not contain extremely long lines (which cause problems for users reading the output in a terminal), and should end with a final newline. There are no restrictions on the underlying character set.

Returns: a detailed text representation of this object.

◆ homology()

virtual AbelianGroup regina::Manifold::homology ( ) const

virtual

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

For details of which types of 3-manifolds have implemented this routine, see the class notes for each corresponding subclasses of Manifold.

The default implemention of this routine just throws a NotImplemented exception.

This routine can also be accessed via the alias homologyH1() (a name that is more specific, but a little longer to type).

Exceptions

NotImplemented	homology calculation has not yet been implemented for this particular 3-manifold.
FileError	the homology needs to be read from file (as opposed to computed), but the file is inaccessible or its contents cannot be read and parsed correctly. Currently this can only happen for the subclass SnapPeaCensusManifold, which reads its results from the SnapPea census databases that are installed with Regina.

Returns: the first homology group of this 3-manifold, if this functionality has been implemented.

Reimplemented in regina::GraphLoop, regina::GraphPair, regina::GraphTriple, regina::Handlebody, regina::LensSpace, regina::SFSpace, regina::SimpleSurfaceBundle, regina::SnapPeaCensusManifold, and regina::TorusBundle.

◆ homologyH1()

AbelianGroup regina::Manifold::homologyH1 ( ) const

inline

A deprecated alias for homology().

Deprecated:: This routine can be accessed by the simpler name homology().

Exceptions

NotImplemented	homology calculation has not yet been implemented for this particular 3-manifold.
the	homology needs to be read from file (as opposed to computed), but the file is inaccessible or its contents cannot be read and parsed correctly. Currently this can only happen for the subclass SnapPeaCensusManifold, which reads its results from the SnapPea census databases that are installed with Regina.

Returns: the first homology group of this 3-manifold, if this functionality has been implemented.

◆ isHyperbolic()

virtual bool regina::Manifold::isHyperbolic ( ) const

pure virtual

Returns whether or not this is a finite-volume hyperbolic manifold.

Returns: true if this is a finite-volume hyperbolic manifold, or false if not.

Implemented in regina::GraphLoop, regina::GraphPair, regina::GraphTriple, regina::Handlebody, regina::LensSpace, regina::SFSpace, regina::SimpleSurfaceBundle, regina::SnapPeaCensusManifold, and regina::TorusBundle.

◆ name()

std::string regina::Manifold::name ( ) const

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

Returns: the common name of this 3-manifold.

◆ operator<()

bool regina::Manifold::operator< ( const Manifold & compare ) const

Determines in a fairly ad-hoc fashion whether this representation of this 3-manifold is "smaller" than the given representation of the given 3-manifold.

The ordering imposed on 3-manifolds 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 3-manifold 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 well-defined way of ordering 3-manifold representations.

Warning: Currently this routine is only implemented in full for closed 3-manifolds. For most classes of bounded 3-manifolds, this routine simply compares the strings returned by name().

Parameters

compare the 3-manifold representation with which this will be compared.

Returns: true if and only if this is "smaller" than the given 3-manifold representation.

◆ operator=()

Manifold & regina::Manifold::operator= ( const Manifold & )

protecteddefault

A copy assignment operator.

This does nothing in the base Manifold class, and is not for public use. It is declared here so that subclasses can use it implicitly in their own copy assignment operators.

◆ str()

std::string regina::Output< Manifold , false >::str ( ) const

inherited

Returns a short text representation of this object.

This text should be human-readable, should use plain ASCII characters where possible, and should not contain any newlines.

Within these limits, this short text ouptut should be as information-rich as possible, since in most cases this forms the basis for the Python str() and repr() functions.

Python: The Python "stringification" function str() will use precisely this function, and for most classes the Python repr() function will incorporate this into its output.

Returns: a short text representation of this object.

◆ structure()

std::string regina::Manifold::structure ( ) 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.

◆ texName()

std::string regina::Manifold::texName ( ) const

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

No leading or trailing dollar signs will be included.

Warning: The behaviour of this routine has changed as of Regina 4.3; in earlier versions, leading and trailing dollar signs were provided.

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

◆ TeXName()

std::string regina::Manifold::TeXName ( ) const

inline

Deprecated routine that returns the common name of this 3-manifold in TeX format.

Deprecated:: This routine has been renamed to texName().

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

◆ utf8()

std::string regina::Output< Manifold , false >::utf8 ( ) const

inherited

Returns a short text representation of this object using unicode characters.

Like str(), this text should be human-readable, should not contain any newlines, and (within these constraints) should be as information-rich as is reasonable.

Unlike str(), this function may use unicode characters to make the output more pleasant to read. The string that is returned will be encoded in UTF-8.

Returns: a short text representation of this object.

◆ writeName()

virtual std::ostream & regina::Manifold::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: Not present; instead use the variant name() that takes no arguments and returns a string.

Parameters

out	the output stream to which to write.

Returns: a reference to the given output stream.

Implemented in regina::GraphLoop, regina::GraphPair, regina::GraphTriple, regina::Handlebody, regina::LensSpace, regina::SFSpace, regina::SimpleSurfaceBundle, regina::SnapPeaCensusManifold, and regina::TorusBundle.

◆ writeStructure()

std::ostream & regina::Manifold::writeStructure ( std::ostream & out ) const

inlinevirtual

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: Not present; instead use the variant structure() that takes no arguments and returns a string.

Parameters

out	the output stream to which to write.

Returns: a reference to the given output stream.

Reimplemented in regina::SFSpace, and regina::SnapPeaCensusManifold.

◆ writeTeXName()

virtual std::ostream & regina::Manifold::writeTeXName ( std::ostream & out ) const

pure virtual

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

No leading or trailing dollar signs will be included.

Warning: The behaviour of this routine has changed as of Regina 4.3; in earlier versions, leading and trailing dollar signs were provided.

Python: Not present; instead use the variant texName() that takes no arguments and returns a string.

Parameters

out	the output stream to which to write.

Returns: a reference to the given output stream.

Implemented in regina::GraphLoop, regina::GraphPair, regina::GraphTriple, regina::Handlebody, regina::LensSpace, regina::SFSpace, regina::SimpleSurfaceBundle, regina::SnapPeaCensusManifold, and regina::TorusBundle.

◆ writeTextLong()

void regina::Manifold::writeTextLong ( std::ostream & out ) const

inline

Writes a detailed text representation of this object to the given output stream.

Subclasses must not override this routine. They should override writeName() and writeStructure() instead.

Python: Not present; use detail() instead.

Parameters

out	the output stream to which to write.

◆ writeTextShort()

void regina::Manifold::writeTextShort ( std::ostream & out ) const

inline

Writes a short text representation of this object to the given output stream.

Subclasses must not override this routine. They should override writeName() instead.

Python: Not present; use str() instead.

Parameters

out	the output stream to which to write.

The documentation for this class was generated from the following file:

manifold/manifold.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Manifold()

◆ Manifold() [1/2]

◆ Manifold() [2/2]

Member Function Documentation

◆ construct()

◆ detail()

◆ homology()

◆ homologyH1()

◆ isHyperbolic()

◆ name()

◆ operator<()

◆ operator=()

◆ str()

◆ structure()

◆ texName()

◆ TeXName()

◆ utf8()

◆ writeName()

◆ writeStructure()

◆ writeTeXName()

◆ writeTextLong()

◆ writeTextShort()