Represents a particularly simple closed surface bundle over the circle.
More...
#include <manifold/nsimplesurfacebundle.h>
List of all members.
Public Member Functions |
| NSimpleSurfaceBundle (int newType) |
| Creates a new surface bundle of the given type.
|
| NSimpleSurfaceBundle (const NSimpleSurfaceBundle &cloneMe) |
| Creates a clone of the given surface bundle.
|
int | getType () const |
| Returns the specific type of surface bundle being represented.
|
bool | operator== (const NSimpleSurfaceBundle &compare) const |
| Determines whether this and the given surface bundle represent the same 3-manifold.
|
virtual NTriangulation * | construct () const |
| Returns a triangulation of this 3-manifold, if such a construction has been implemented.
|
NAbelianGroup * | getHomologyH1 () const |
| Returns the first homology group of this 3-manifold, if such a routine has been implemented.
|
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.
|
std::ostream & | writeTeXName (std::ostream &out) const |
| Writes the common name of this 3-manifold in TeX format to the given output stream.
|
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.
|
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.
|
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.
|
| ShareableObject () |
| Default constructor that does nothing.
|
virtual | ~ShareableObject () |
| Default destructor that does nothing.
|
std::string | toString () const |
| Returns the output from writeTextShort() as a string.
|
std::string | toStringLong () const |
| Returns the output from writeTextLong() as a string.
|
Static Public Attributes |
static const int | S2xS1 |
| Represents the orientable 2-sphere bundle over the circle.
|
static const int | S2xS1_TWISTED |
| Represents the non-orientable twisted 2-sphere bundle over the circle.
|
static const int | RP2xS1 |
| Represents the projective plane bundle over the circle.
|
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 NManifold routines are implemented for this class.
- Test:
- Included in the test suite.
Constructor & Destructor Documentation
regina::NSimpleSurfaceBundle::NSimpleSurfaceBundle |
( |
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. |
Creates a clone of the given surface bundle.
- Parameters:
-
cloneMe | the surface bundle to clone. |
Member Function Documentation
virtual NTriangulation* regina::NSimpleSurfaceBundle::construct |
( |
| ) |
const |
|
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 from regina::NManifold.
NAbelianGroup* regina::NSimpleSurfaceBundle::getHomologyH1 |
( |
| ) |
const |
|
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 from regina::NManifold.
int regina::NSimpleSurfaceBundle::getType |
( |
| ) |
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.
Determines whether this and the given surface bundle 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 homeomorphic.
std::ostream& regina::NSimpleSurfaceBundle::writeName |
( |
std::ostream & |
out | ) |
const |
|
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.
Implements regina::NManifold.
std::ostream& regina::NSimpleSurfaceBundle::writeTeXName |
( |
std::ostream & |
out | ) |
const |
|
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:
- 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.
Implements regina::NManifold.
Member Data Documentation
const int regina::NSimpleSurfaceBundle::RP2xS1 |
|
static |
Represents the projective plane bundle over the circle.
const int regina::NSimpleSurfaceBundle::S2xS1 |
|
static |
Represents the orientable 2-sphere bundle over the circle.
const int regina::NSimpleSurfaceBundle::S2xS1_TWISTED |
|
static |
Represents the non-orientable twisted 2-sphere bundle over the circle.
The documentation for this class was generated from the following file: