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

Represents a subset of a normal surface list. More...

#include <surfaces/nsurfacesubset.h>

Inheritance diagram for regina::NSurfaceSubset:
regina::ShareableObject regina::boost::noncopyable

Public Member Functions

 NSurfaceSubset (const NNormalSurfaceList &list, const NSurfaceFilter &filter)
 Creates a new normal surface subset. More...
 
virtual ~NSurfaceSubset ()
 Destroys this normal surface subset. More...
 
NormalCoords getFlavour () const
 Returns the coordinate system being used by the surfaces stored in this set. More...
 
NormalCoords coords () const
 Returns the coordinate system being used by the surfaces stored in this set. More...
 
bool allowsAlmostNormal () const
 Determines if the coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs. More...
 
bool allowsSpun () const
 Determines if the coordinate system being used allows for spun normal surfaces. More...
 
bool allowsOriented () const
 Determines if the coordinate system being used allows for transversely oriented normal surfaces. More...
 
bool isEmbeddedOnly () const
 Returns whether this set is known to contain only embedded normal surfaces. More...
 
NTriangulationgetTriangulation () const
 Returns the triangulation in which these normal surfaces live. More...
 
unsigned long getNumberOfSurfaces () const
 Returns the number of surfaces stored in this set. More...
 
const NNormalSurfacegetSurface (unsigned long index) const
 Returns the surface at the requested index in this set. More...
 
void writeAllSurfaces (std::ostream &out) const
 Writes the number of surfaces in this set followed by the details of each surface to the given output stream. More...
 
virtual void writeTextShort (std::ostream &out) const
 Writes this object in short text format to the given output stream. More...
 
virtual void writeTextLong (std::ostream &out) const
 Writes this object in long text format to the given output stream. More...
 
Input and Output
std::string str () const
 Returns the output from writeTextShort() as a string. More...
 
std::string toString () const
 A deprecated alias for str(), which returns the output from writeTextShort() as a string. More...
 
std::string detail () const
 Returns the output from writeTextLong() as a string. More...
 
std::string toStringLong () const
 A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More...
 

Detailed Description

Represents a subset of a normal surface list.

This subset merely contains pointers to some of the normal surfaces stored in the original list.

If the surfaces in the original list should change, the surfaces in this subset will thus change also. If the original list is deleted, this subset will become invalid.

Precondition
As long as this subset is in use, the surface list upon which this subset is based must never be deleted.

Constructor & Destructor Documentation

regina::NSurfaceSubset::NSurfaceSubset ( const NNormalSurfaceList list,
const NSurfaceFilter filter 
)

Creates a new normal surface subset.

The surfaces included in the subset will be those from the given set that are accepted by the given filter.

Parameters
listthe surface list for which this will be a subset.
filterthe filter that defines which surfaces in list will be included in this subset.
regina::NSurfaceSubset::~NSurfaceSubset ( )
inlinevirtual

Destroys this normal surface subset.

Member Function Documentation

bool regina::NSurfaceSubset::allowsAlmostNormal ( ) const
inline

Determines if the coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs.

Returns
true if and only if almost normal surfaces are allowed.
bool regina::NSurfaceSubset::allowsOriented ( ) const
inline

Determines if the coordinate system being used allows for transversely oriented normal surfaces.

Returns
true if and only if transverse orientations are supported.
bool regina::NSurfaceSubset::allowsSpun ( ) const
inline

Determines if the coordinate system being used allows for spun normal surfaces.

Returns
true if and only if spun normal surface are supported.
NormalCoords regina::NSurfaceSubset::coords ( ) const
inline

Returns the coordinate system being used by the surfaces stored in this set.

Returns
the coordinate system used.
std::string regina::ShareableObject::detail ( ) const
inherited

Returns the output from writeTextLong() as a string.

Returns
a long text representation of this object.
NormalCoords regina::NSurfaceSubset::getFlavour ( ) const
inline

Returns the coordinate system being used by the surfaces stored in this set.

Deprecated:
Users should switch to the identical routine coords() instead.
Returns
the coordinate system used.
unsigned long regina::NSurfaceSubset::getNumberOfSurfaces ( ) const
inline

Returns the number of surfaces stored in this set.

Returns
the number of surfaces.
const NNormalSurface * regina::NSurfaceSubset::getSurface ( unsigned long  index) const
inline

Returns the surface at the requested index in this set.

Parameters
indexthe index of the requested surface in this set; this must be between 0 and getNumberOfSurfaces()-1 inclusive.
Returns
the normal surface at the requested index in this set.
NTriangulation * regina::NSurfaceSubset::getTriangulation ( ) const
inline

Returns the triangulation in which these normal surfaces live.

Returns
the triangulation in which these surfaces live.
bool regina::NSurfaceSubset::isEmbeddedOnly ( ) const
inline

Returns whether this set is known to contain only embedded normal surfaces.

If it is possible that there are non-embedded surfaces in this set but it is not known whether any are actually present or not, this routine should return false.

Returns
true if it is known that only embedded normal surfaces exist in this list, or false if immersed and/or singular normal surfaces might be present.
std::string regina::ShareableObject::str ( ) const
inherited

Returns the output from writeTextShort() as a string.

Python:
This implements the __str__() function.
Returns
a short text representation of this object.
std::string regina::ShareableObject::toString ( ) const
inlineinherited

A deprecated alias for str(), which returns the output from writeTextShort() as a string.

Deprecated:
This routine has (at long last) been deprecated; use the simpler-to-type str() instead.
Returns
a short text representation of this object.
std::string regina::ShareableObject::toStringLong ( ) const
inlineinherited

A deprecated alias for detail(), which returns the output from writeTextLong() as a string.

Deprecated:
This routine has (at long last) been deprecated; use the simpler-to-type detail() instead.
Returns
a long text representation of this object.
void regina::NSurfaceSubset::writeAllSurfaces ( std::ostream &  out) const

Writes the number of surfaces in this set followed by the details of each surface to the given output stream.

Output will be over many lines.

Python:
Parameter out is not present and is assumed to be standard output.
Parameters
outthe output stream to which to write.
void regina::NSurfaceSubset::writeTextLong ( std::ostream &  out) const
inlinevirtual

Writes this object in long text format to the given output stream.

The output should provide the user with all the information they could want. The output should be human-readable, should not contain extremely long lines (so users can read the output in a terminal), and should end with a final newline.

The default implementation of this routine merely calls writeTextShort() and adds a newline.

Python:
The parameter out does not exist; standard output will be used.
Parameters
outthe output stream to which to write.

Reimplemented from regina::ShareableObject.

void regina::NSurfaceSubset::writeTextShort ( std::ostream &  out) const
inlinevirtual

Writes this object in short text format to the given output stream.

The output should be human-readable, should fit on a single line, and should not end with a newline.

Python:
The parameter out does not exist; standard output will be used.
Parameters
outthe output stream to which to write.

Implements regina::ShareableObject.


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

Copyright © 1999-2014, 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@debian.org).