Regina Calculation Engine
|
Represents a torus bundle over the circle. More...
#include <manifold/ntorusbundle.h>
Public Member Functions | |
NTorusBundle () | |
Creates a new trivial torus bundle over the circle. More... | |
NTorusBundle (const NMatrix2 &newMonodromy) | |
Creates a new torus bundle over the circle using the given monodromy. More... | |
NTorusBundle (long mon00, long mon01, long mon10, long mon11) | |
Creates a new torus bundle over the circle using the given monodromy. More... | |
NTorusBundle (const NTorusBundle &cloneMe) | |
Creates a clone of the given torus bundle. More... | |
const NMatrix2 & | monodromy () const |
Returns the monodromy describing how the upper and lower torus boundaries are identified. More... | |
REGINA_DEPRECATED const NMatrix2 & | getMonodromy () const |
Deprecated routine that returns the monodromy describing how the upper and lower torus boundaries are identified. More... | |
NAbelianGroup * | homology () const |
Returns the first homology group of this 3-manifold, if such a routine has been implemented. More... | |
bool | isHyperbolic () const |
Returns whether or not this is a finite-volume hyperbolic manifold. More... | |
std::ostream & | writeName (std::ostream &out) const |
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 |
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... | |
REGINA_DEPRECATED std::string | getName () const |
Deprecated routine that 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... | |
REGINA_DEPRECATED std::string | getTeXName () 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... | |
REGINA_DEPRECATED std::string | getStructure () const |
Deprecated routine that returns details of the structure of this 3-manifold that might not be evident from its common name. More... | |
virtual NTriangulation * | construct () const |
Returns a triangulation of this 3-manifold, if such a construction has been implemented. More... | |
NAbelianGroup * | homologyH1 () const |
Returns the first homology group of this 3-manifold, if such a routine has been implemented. More... | |
REGINA_DEPRECATED NAbelianGroup * | getHomologyH1 () const |
Deprecated routine that returns the first homology group of this 3-manifold, if such a routine has been implemented. More... | |
bool | operator< (const NManifold &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... | |
REGINA_DEPRECATED std::string | toString () const |
A deprecated alias for str(). More... | |
REGINA_DEPRECATED std::string | toStringLong () const |
A deprecated alias for detail(). More... | |
Represents a torus bundle over the circle.
This is expressed as the product of the torus and the interval, with the two torus boundaries identified according to some specified monodromy.
The monodromy is described by a 2-by-2 matrix M as follows. Let a and b be generating curves of the upper torus boundary, and let p and q be the corresponding curves on the lower torus boundary (so that a and p are parallel and b and q are parallel). Then we identify the torus boundaries so that, in additive terms:
[a] [p] [ ] = M * [ ] [b] [q]
All optional NManifold routines except for construct() are implemented for this class.
|
inline |
Creates a new trivial torus bundle over the circle.
In other words, this routine creates a torus bundle with the identity monodromy.
|
inline |
Creates a new torus bundle over the circle using the given monodromy.
newMonodromy | describes precisely how the upper and lower torus boundaries are identified. See the class notes for details. |
|
inline |
Creates a new torus bundle over the circle using the given monodromy.
The four elements of the monodromy matrix are passed separately. They combine to give the full monodromy matrix M as follows:
[ mon00 mon01 ] M = [ ] [ mon10 mon11 ]
mon00 | the (0,0) element of the monodromy matrix. |
mon01 | the (0,1) element of the monodromy matrix. |
mon10 | the (1,0) element of the monodromy matrix. |
mon11 | the (1,1) element of the monodromy matrix. |
|
inline |
Creates a clone of the given torus bundle.
cloneMe | the torus bundle to clone. |
|
inlinevirtualinherited |
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.
Reimplemented in regina::NSFSpace, regina::NSnapPeaCensusManifold, regina::NLensSpace, and regina::NSimpleSurfaceBundle.
|
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.
|
inlineinherited |
Deprecated routine that returns the first homology group of this 3-manifold, if such a routine has been implemented.
|
inline |
Deprecated routine that returns the monodromy describing how the upper and lower torus boundaries are identified.
|
inlineinherited |
Deprecated routine that returns the common name of this 3-manifold as a human-readable string.
|
inlineinherited |
Deprecated routine that returns details of the structure of this 3-manifold that might not be evident from its common name.
|
inlineinherited |
Deprecated routine that returns the common name of this 3-manifold in TeX format.
|
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.
This routine can also be accessed via the alias homologyH1() (a name that is more specific, but a little longer to type).
Reimplemented from regina::NManifold.
|
inlineinherited |
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.
This routine can also be accessed via the alias homology() (a name that is less specific, but a little easier to type).
|
inlinevirtual |
Returns whether or not this is a finite-volume hyperbolic manifold.
true
if this is a finite-volume hyperbolic manifold, or false
if not. Implements regina::NManifold.
|
inline |
Returns the monodromy describing how the upper and lower torus boundaries are identified.
See the class notes for details.
|
inherited |
Returns the common name of this 3-manifold as a human-readable string.
|
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.
compare | the 3-manifold representation with which this will be compared. |
true
if and only if this is "smaller" than the given 3-manifold representation.
|
inherited |
Returns a short text representation of this object.
This text should be human-readable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.
__str__()
.
|
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.
|
inherited |
Returns the common name of this 3-manifold in TeX format.
No leading or trailing dollar signs will be included.
|
inherited |
A deprecated alias for str().
|
inherited |
A deprecated alias for detail().
|
inherited |
Returns a short text representation of this object using unicode characters.
Like str(), this text should be human-readable, should fit on a single line, and should not end with a newline. In addition, it may use unicode characters to make the output more pleasant to read. This string will be encoded in UTF-8.
|
virtual |
Writes the common name of this 3-manifold as a human-readable string to the given output stream.
None
.out | the output stream to which to write. |
Implements regina::NManifold.
|
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.
None
.out | the output stream to which to write. |
Reimplemented in regina::NSFSpace, and regina::NSnapPeaCensusManifold.
|
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.
None
.out | the output stream to which to write. |
Implements regina::NManifold.
|
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.
out | the output stream to which to write. |
|
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.
out | the output stream to which to write. |