Regina Calculation Engine
|
Represents a subset of a normal surface list. More...
#include <surfaces/nsurfacesubset.h>
Public Member Functions | |
NSurfaceSubset (const NNormalSurfaceList &list, const NSurfaceFilter &filter) | |
Creates a new normal surface subset. More... | |
REGINA_DEPRECATED 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... | |
NTriangulation * | triangulation () const |
Returns the triangulation in which these normal surfaces live. More... | |
REGINA_DEPRECATED NTriangulation * | getTriangulation () const |
Deprecated routine that returns the triangulation in which these normal surfaces live. More... | |
size_t | size () const |
Returns the number of surfaces stored in this list. More... | |
REGINA_DEPRECATED size_t | getNumberOfSurfaces () const |
Deprecated routine to return the number of surfaces stored in this list. More... | |
const NNormalSurface * | surface (size_t index) const |
Returns the surface at the requested index in this set. More... | |
REGINA_DEPRECATED const NNormalSurface * | getSurface (size_t index) const |
Deprecated routine that 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... | |
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 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.
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.
list | the surface list for which this will be a subset. |
filter | the filter that defines which surfaces in list will be included in this subset. |
|
inline |
Determines if the coordinate system being used allows for almost normal surfaces, that is, allows for octagonal discs.
true
if and only if almost normal surfaces are allowed.
|
inline |
Determines if the coordinate system being used allows for transversely oriented normal surfaces.
true
if and only if transverse orientations are supported.
|
inline |
Determines if the coordinate system being used allows for spun normal surfaces.
true
if and only if spun normal surface are supported.
|
inline |
Returns the coordinate system being used by the surfaces stored in this set.
|
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.
|
inline |
Returns the coordinate system being used by the surfaces stored in this set.
|
inline |
Deprecated routine to return the number of surfaces stored in this list.
|
inline |
Deprecated routine that returns the surface at the requested index in this set.
|
inline |
Deprecated routine that returns the triangulation in which these normal surfaces live.
|
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
.
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.
|
inline |
Returns the number of surfaces stored in this list.
|
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__()
.
|
inline |
|
inherited |
A deprecated alias for str().
|
inherited |
A deprecated alias for detail().
|
inline |
Returns the triangulation in which these normal surfaces live.
|
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.
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.
out | the output stream to which to write. |
|
inline |
Writes a detailed text representation of this object to the given output stream.
out | the output stream to which to write. |
|
inline |
Writes a short text representation of this object to the given output stream.
out | the output stream to which to write. |