Regina Calculation Engine
Public Member Functions | List of all members
regina::Handlebody Class Reference

Represents an arbitrary handlebody. More...

#include <manifold/handlebody.h>

Inheritance diagram for regina::Handlebody:
regina::Manifold regina::Output< Manifold >

Public Member Functions

 Handlebody (unsigned long newHandles, bool newOrientable)
 Creates a new handlebody with the given parameters. More...
 
 Handlebody (const Handlebody &cloneMe)=default
 Creates a clone of the given handlebody. More...
 
virtual ~Handlebody ()
 Destroys this handlebody. More...
 
unsigned long handles () const
 Returns the number of handles of this handlebody. More...
 
bool isOrientable () const
 Returns whether this handlebody is orientable. More...
 
bool operator== (const Handlebody &compare) const
 Determines whether this and the given handlebody represent the same 3-manifold. More...
 
bool operator!= (const Handlebody &compare) const
 Determines whether this and the given handlebody represent different 3-manifolds. More...
 
Handlebodyoperator= (const Handlebody &cloneMe)=default
 Sets this to be a clone of the given handlebody. More...
 
AbelianGrouphomology () 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...
 
AbelianGrouphomologyH1 () const
 Returns the first homology group of this 3-manifold, if such a routine 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 an arbitrary handlebody.

All optional Manifold routines except for Manifold::construct() are implemented for this class.

Member Function Documentation

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

◆ 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 fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.

Python
In addition to str(), this is also used as the Python "stringification" function str().
Returns
a short text representation of this object.

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

Returns
a short text representation of this object.

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

Copyright © 1999-2021, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).