Represents a closed graph manifold formed by joining two bounded Seifert fibred spaces along a common torus. More...

#include <manifold/graphpair.h>

Inheritance diagram for regina::GraphPair:

Public Member Functions
	GraphPair (const SFSpace &sfs0, const SFSpace &sfs1, long mat00, long mat01, long mat10, long mat11)
	Creates a new graph manifold as a pair of joined Seifert fibred spaces. More...

	GraphPair (SFSpace &&sfs0, SFSpace &&sfs1, long mat00, long mat01, long mat10, long mat11)
	Creates a new graph manifold from a pair of bounded Seifert fibred spaces, which are moved instead of copied. More...

	GraphPair (const SFSpace &sfs0, const SFSpace &sfs1, const Matrix2 &matchingReln)
	Creates a new graph manifold as a pair of joined Seifert fibred spaces. More...

	GraphPair (SFSpace &&sfs0, SFSpace &&sfs1, const Matrix2 &matchingReln)
	Creates a new graph manifold from a pair of bounded Seifert fibred spaces, which are moved instead of copied. More...

	GraphPair (const GraphPair &)=default
	Creates a clone of the given graph manifold. More...

	GraphPair (GraphPair &&) noexcept=default
	Moves the contents of the given graph manifold into this new graph manifold. More...

const SFSpace &	sfs (unsigned which) const
	Returns a reference to one of the two bounded Seifert fibred spaces that are joined together. More...

const Matrix2 &	matchingReln () const
	Returns a reference to the 2-by-2 matrix describing how the two Seifert fibred spaces are joined together. More...

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

GraphPair &	operator= (const GraphPair &)=default
	Sets this to be a clone of the given graph manifold. More...

GraphPair &	operator= (GraphPair &&) noexcept=default
	Moves the contents of the given graph manifold into this graph manifold. More...

void	swap (GraphPair &other) noexcept
	Swaps the contents of this and the given graph manifold. More...

bool	operator== (const GraphPair &compare) const
	Determines whether this and the given object contain precisely the same presentations of the same graph manifold. More...

bool	operator!= (const GraphPair &compare) const
	Determines whether this and the given object do not contain precisely the same presentations of the same graph manifold. 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	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...

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

Detailed Description

Represents a closed graph manifold formed by joining two bounded Seifert fibred spaces along a common torus.

Each Seifert fibred space must have just one boundary component, corresponding to a puncture in the base orbifold (with no fibre-reversing twist as one travels around this boundary).

The way in which the two spaces are joined is specified by a 2-by-2 matrix M. This matrix expresses the locations of the fibres and base orbifold of the second Seifert fibred space in terms of the first.

More specifically, suppose that f0 and o0 are generators of the common torus, where f0 represents a directed fibre in the first Seifert fibred space and o0 represents the oriented boundary of the corresponding base orbifold. Likewise, let f1 and o1 be generators of the common torus representing a directed fibre and the base orbifold of the second Seifert fibred space. Then the curves f0, o0, f1 and o1 are related as follows:

    [f1]       [f0]
    [  ] = M * [  ]
    [o1]       [o0]

See the page on Notation for Seifert fibred spaces for details on some of the terminology used above.

The optional Manifold routine homology() is implemented, but the optional routine construct() is not.

This class implements C++ move semantics and adheres to the C++ Swappable requirement. It is designed to avoid deep copies wherever possible, even when passing or returning objects by value. Note, however, that GraphPair still requires a non-trivial (but constant sized) amount of data to be copied even in a move operation.

Todo:: Optimise: Speed up homology calculations involving orientable base spaces by adding rank afterwards, instead of adding generators for genus into the presentation matrix.

Constructor & Destructor Documentation

◆ GraphPair() [1/6]

regina::GraphPair::GraphPair	(	const SFSpace &	sfs0,
		const SFSpace &	sfs1,
		long	mat00,
		long	mat01,
		long	mat10,
		long	mat11
	)

inline

Creates a new graph manifold as a pair of joined Seifert fibred spaces.

The two bounded Seifert fibred spaces and the four elements of the 2-by-2 matching matrix are all passed separately. The elements of the matching matrix combine to give the full matrix M as follows:

          [ mat00  mat01 ]
    M  =  [              ]
          [ mat10  mat11 ]

Precondition: The given matching matrix has determinant +1 or -1.

Exceptions

InvalidArgument One of the given Seifert fibred spaces does not have precisely one torus boundary, corresponding to a single untwisted puncture in its base orbifold.

Parameters

sfs0	the first Seifert fibred space.
sfs1	the second Seifert fibred space.
mat00	the (0,0) element of the matching matrix.
mat01	the (0,1) element of the matching matrix.
mat10	the (1,0) element of the matching matrix.
mat11	the (1,1) element of the matching matrix.

◆ GraphPair() [2/6]

regina::GraphPair::GraphPair	(	SFSpace &&	sfs0,
		SFSpace &&	sfs1,
		long	mat00,
		long	mat01,
		long	mat10,
		long	mat11
	)

inline

Creates a new graph manifold from a pair of bounded Seifert fibred spaces, which are moved instead of copied.

Other than its use of move semantics, this behaves identically to the other constructor that takes the Seifert fibred spaces by const reference. See that constructor for further details.

Precondition: The given matching matrix has determinant +1 or -1.

Exceptions

InvalidArgument One of the given Seifert fibred spaces does not have precisely one torus boundary, corresponding to a single untwisted puncture in its base orbifold.

Parameters

sfs0	the first Seifert fibred space.
sfs1	the second Seifert fibred space.
mat00	the (0,0) element of the matching matrix.
mat01	the (0,1) element of the matching matrix.
mat10	the (1,0) element of the matching matrix.
mat11	the (1,1) element of the matching matrix.

◆ GraphPair() [3/6]

regina::GraphPair::GraphPair	(	const SFSpace &	sfs0,
		const SFSpace &	sfs1,
		const Matrix2 &	matchingReln
	)

inline

Creates a new graph manifold as a pair of joined Seifert fibred spaces.

The two bounded Seifert fibred spaces and the entire 2-by-2 matching matrix are each passed separately.

Precondition: The given matching matrix has determinant +1 or -1.

Exceptions

InvalidArgument One of the given Seifert fibred spaces does not have precisely one torus boundary, corresponding to a single untwisted puncture in its base orbifold.

Parameters

sfs0	the first Seifert fibred space.
sfs1	the second Seifert fibred space.
matchingReln	the 2-by-2 matching matrix.

◆ GraphPair() [4/6]

regina::GraphPair::GraphPair	(	SFSpace &&	sfs0,
		SFSpace &&	sfs1,
		const Matrix2 &	matchingReln
	)

inline

Creates a new graph manifold from a pair of bounded Seifert fibred spaces, which are moved instead of copied.

Other than its use of move semantics, this behaves identically to the other constructor that takes the Seifert fibred spaces by const reference. See that constructor for further details.

Precondition: The given matching matrix has determinant +1 or -1.

Exceptions

InvalidArgument One of the given Seifert fibred spaces does not have precisely one torus boundary, corresponding to a single untwisted puncture in its base orbifold.

Parameters

sfs0	the first Seifert fibred space.
sfs1	the second Seifert fibred space.
matchingReln	the 2-by-2 matching matrix.

◆ GraphPair() [5/6]

regina::GraphPair::GraphPair ( const GraphPair & )

default

Creates a clone of the given graph manifold.

◆ GraphPair() [6/6]

regina::GraphPair::GraphPair ( GraphPair && )

defaultnoexcept

Moves the contents of the given graph manifold into this new graph manifold.

This is a constant time operation.

The graph manifold that was passed will no longer be usable.

Member Function Documentation

◆ construct()

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

virtualinherited

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::Handlebody, 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()

AbelianGroup regina::GraphPair::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.

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.

◆ isHyperbolic()

bool regina::GraphPair::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.

◆ matchingReln()

const Matrix2 & regina::GraphPair::matchingReln ( ) const

inline

Returns a reference to the 2-by-2 matrix describing how the two Seifert fibred spaces are joined together.

See the class notes for details on precisely how this matrix is represented.

Returns: a reference to the matching matrix.

◆ 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::GraphPair::operator!= ( const GraphPair & compare ) const

inline

Determines whether this and the given object do not contain precisely the same presentations of the same graph manifold.

This routine does not test for homeomorphism. Instead it compares the exact presentations, including the matching matrix and the specific presentations of the bounded Seifert fibred spaces, and determines whether or not these presentations are identical. If you have two different presentations of the same graph manifold, they will be treated as not equal by this routine.

Parameters

compare the presentation with which this will be compared.

Returns: true if and only if this and the given object do not contain identical presentations of the same graph manifold.

◆ operator<() [1/2]

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

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

The ordering imposed on graph manifolds is purely aesthetic on the part of the author, and is subject to change in future versions of Regina. It also depends upon the particular representation, so that different representations of the same space may be ordered differently.

All that this routine really offers is a well-defined way of ordering graph manifold representations.

Parameters

compare the representation with which this will be compared.

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

◆ operator<() [2/2]

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=() [1/2]

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

default

Sets this to be a clone of the given graph manifold.

Returns: a reference to this graph manifold.

◆ operator=() [2/2]

GraphPair & regina::GraphPair::operator= ( GraphPair && )

defaultnoexcept

Moves the contents of the given graph manifold into this graph manifold.

This is a constant time operation.

The graph manifold that was passed will no longer be usable.

Returns: a reference to this graph manifold.

◆ operator==()

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

inline

Determines whether this and the given object contain precisely the same presentations of the same graph manifold.

This routine does not test for homeomorphism. Instead it compares the exact presentations, including the matching matrix and the specific presentations of the bounded Seifert fibred spaces, and determines whether or not these presentations are identical. If you have two different presentations of the same graph manifold, they will be treated as not equal by this routine.

Parameters

compare the presentation with which this will be compared.

Returns: true if and only if this and the given object contain identical presentations of the same graph manifold.

◆ sfs()

const SFSpace & regina::GraphPair::sfs ( unsigned which ) const

inline

Returns a reference to one of the two bounded Seifert fibred spaces that are joined together.

Parameters

which 0 if the first Seifert fibred space is to be returned, or 1 if the second space is to be returned.

Returns: a reference to the requested Seifert fibred space.

◆ 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³/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::GraphPair::swap ( GraphPair & other )

inlinenoexcept

Swaps the contents of this and the given graph manifold.

Parameters

other the graph manifold 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.

◆ 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::GraphPair::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³/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::GraphPair::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.

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

manifold/graphpair.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GraphPair() [1/6]

◆ GraphPair() [2/6]

◆ GraphPair() [3/6]

◆ GraphPair() [4/6]

◆ GraphPair() [5/6]

◆ GraphPair() [6/6]

Member Function Documentation

◆ construct()

◆ detail()

◆ homology()

◆ isHyperbolic()

◆ matchingReln()

◆ name()

◆ operator!=()

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ sfs()

◆ str()

◆ structure()

◆ swap()

◆ texName()

◆ utf8()

◆ writeName()

◆ writeStructure()

◆ writeTeXName()

◆ writeTextLong()

◆ writeTextShort()