Represents a particularly simple closed surface bundle over the circle. More...

#include <manifold/simplesurfacebundle.h>

Inheritance diagram for regina::SimpleSurfaceBundle:

Public Member Functions
	SimpleSurfaceBundle (int newType)
	Creates a new surface bundle of the given type. More...

	SimpleSurfaceBundle (const SimpleSurfaceBundle &)=default
	Creates a new copy of the given surface bundle. More...

int	type () const
	Returns the specific type of surface bundle being represented. More...

bool	operator== (const SimpleSurfaceBundle &compare) const
	Determines whether this and the given surface bundle are of the same type (i.e., they represent the same 3-manifold). More...

bool	operator!= (const SimpleSurfaceBundle &compare) const
	Determines whether this and the given surface bundle are of different types (i.e., they represent different 3-manifolds). More...

SimpleSurfaceBundle &	operator= (const SimpleSurfaceBundle &)=default
	Sets this to be a copy of the given surface bundle. More...

void	swap (SimpleSurfaceBundle &other) noexcept
	Swaps the contents of this and the given surface bundle. More...

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

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

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

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

std::ostream &	writeTeXName (std::ostream &out) const override
	Writes the common name of this 3-manifold in TeX format to the given output stream. 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...

AbelianGroup	homologyH1 () const
	A deprecated alias for homology(). 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 &	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...

Static Public Attributes
static constexpr int	S2xS1 = 1
	Represents the orientable 2-sphere bundle over the circle. More...

static constexpr int	S2xS1_TWISTED = 2
	Represents the non-orientable twisted 2-sphere bundle over the circle. More...

static constexpr int	RP2xS1 = 3
	Represents the projective plane bundle over the circle. More...

Detailed Description

Represents a particularly simple closed surface bundle over the circle.

Only 2-sphere bundles, twisted 2-sphere bundles and projective plane bundles are considered.

All optional Manifold routines are implemented for this class.

This class supports copying but does not implement separate move operations, since its internal data is so small that copying is just as efficient. It implements the C++ Swappable requirement via its own member and global swap() functions, for consistency with the other manifold classes.

Constructor & Destructor Documentation

◆ SimpleSurfaceBundle() [1/2]

regina::SimpleSurfaceBundle::SimpleSurfaceBundle ( int newType )

inline

Creates a new surface bundle of the given type.

Parameters

newType the specific type of surface bundle to represent. This must be one of the 3-manifold constants defined in this class.

◆ SimpleSurfaceBundle() [2/2]

regina::SimpleSurfaceBundle::SimpleSurfaceBundle ( const SimpleSurfaceBundle & )

default

Creates a new copy of the given surface bundle.

Member Function Documentation

◆ construct()

Triangulation< 3 > regina::SimpleSurfaceBundle::construct ( ) const

overridevirtual

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 from regina::Manifold.

◆ 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()

AbelianGroup regina::SimpleSurfaceBundle::homology ( ) const

overridevirtual

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 from regina::Manifold.

◆ homologyH1()

AbelianGroup regina::Manifold::homologyH1 ( ) const

inlineinherited

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()

bool regina::SimpleSurfaceBundle::isHyperbolic ( ) const

inlineoverridevirtual

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.

Implements regina::Manifold.

◆ name()

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

inherited

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

Returns: the common name of this 3-manifold.

◆ operator!=()

bool regina::SimpleSurfaceBundle::operator!= ( const SimpleSurfaceBundle & compare ) const

inline

Determines whether this and the given surface bundle are of different types (i.e., they represent different 3-manifolds).

Parameters

compare the surface bundle with which this will be compared.

Returns: true if and only if this and the given surface bundle are of different types.

◆ operator<()

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

inherited

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=()

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

default

Sets this to be a copy of the given surface bundle.

Returns: a reference to this surface bundle.

◆ operator==()

bool regina::SimpleSurfaceBundle::operator== ( const SimpleSurfaceBundle & compare ) const

inline

Determines whether this and the given surface bundle are of the same type (i.e., they represent the same 3-manifold).

Parameters

compare the surface bundle with which this will be compared.

Returns: true if and only if this and the given surface bundle are of the same type.

◆ 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

inherited

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.

◆ swap()

void regina::SimpleSurfaceBundle::swap ( SimpleSurfaceBundle & other )

inlinenoexcept

Swaps the contents of this and the given surface bundle.

Parameters

other the surface bundle whose contents should be swapped with this.

◆ texName()

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

inherited

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

inlineinherited

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.

◆ type()

int regina::SimpleSurfaceBundle::type ( ) const

inline

Returns the specific type of surface bundle being represented.

Returns: the type of surface bundle. This will be one of the 3-manifold constants defined in this class.

◆ 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()

std::ostream & regina::SimpleSurfaceBundle::writeName ( std::ostream & out ) const

overridevirtual

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.

Implements regina::Manifold.

◆ writeStructure()

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

inlinevirtualinherited

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()

std::ostream & regina::SimpleSurfaceBundle::writeTeXName ( std::ostream & out ) const

overridevirtual

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.

Implements regina::Manifold.

◆ writeTextLong()

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

inlineinherited

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

inlineinherited

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.

Member Data Documentation

◆ RP2xS1

constexpr int regina::SimpleSurfaceBundle::RP2xS1 = 3

staticconstexpr

Represents the projective plane bundle over the circle.

◆ S2xS1

constexpr int regina::SimpleSurfaceBundle::S2xS1 = 1

staticconstexpr

Represents the orientable 2-sphere bundle over the circle.

◆ S2xS1_TWISTED

constexpr int regina::SimpleSurfaceBundle::S2xS1_TWISTED = 2

staticconstexpr

Represents the non-orientable twisted 2-sphere bundle over the circle.

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

manifold/simplesurfacebundle.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SimpleSurfaceBundle() [1/2]

◆ SimpleSurfaceBundle() [2/2]

Member Function Documentation

◆ construct()

◆ detail()

◆ homology()

◆ homologyH1()

◆ isHyperbolic()

◆ name()

◆ operator!=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ str()

◆ structure()

◆ swap()

◆ texName()

◆ TeXName()

◆ type()

◆ utf8()

◆ writeName()

◆ writeStructure()

◆ writeTeXName()

◆ writeTextLong()

◆ writeTextShort()

Member Data Documentation

◆ RP2xS1

◆ S2xS1

◆ S2xS1_TWISTED