Regina 7.3 Calculation Engine
Classes | Functions
SnapPea Triangulations

Interfaces for accessing the SnapPea kernel. More...

Classes

class  regina::ExampleSnapPea
 This class offers routines for constructing various example SnapPea triangulations. More...
 
class  regina::SnapPeaFatalError
 An exception that is thrown when the SnapPea kernel encounters a fatal error. More...
 
class  regina::SnapPeaMemoryFull
 An exception that is thrown when the SnapPea kernel finds that all available memory has been exhausted. More...
 
class  regina::Cusp
 Used to return information about a single cusp of a SnapPea triangulation. More...
 
class  regina::SnapPeaTriangulation
 Offers direct access to the SnapPea kernel from within Regina. More...
 
class  regina::SnapPeaUnsolvedCase
 An exception thrown when the SnapPea kernel is not able to perform some computation. More...
 
class  regina::SnapPeaIsNull
 An exception thrown when the SnapPea kernel is asked to work with a null SnapPea triangulation. More...
 

Functions

void regina::swap (SnapPeaTriangulation &lhs, SnapPeaTriangulation &rhs)
 Swaps the contents of the two given SnapPea triangulations. More...
 

Detailed Description

Interfaces for accessing the SnapPea kernel.

Function Documentation

◆ swap()

void regina::swap ( SnapPeaTriangulation lhs,
SnapPeaTriangulation rhs 
)
inline

Swaps the contents of the two given SnapPea triangulations.

This global routine simply calls SnapPeaTriangulation::swap(); it is provided so that SnapPeaTriangulation meets the C++ Swappable requirements.

See SnapPeaTriangulation::swap() for more details and caveats.

Warning
If you wish to swap the contents of two SnapPea triangulations, you must cast both to SnapPeaTriangulation before calling swap(). If either argument is presented as the parent class Triangulation<3>, then the Triangulation<3> swap() will be called instead; the result will be that (just like when you call any of the Triangulation<3> edit routines) both SnapPea triangulations will be reset to null triangulations. See the SnapPeaTriangulation class notes for further discussion.
Note
This swap function is not marked noexcept, since it fires change events which may in turn call arbitrary code via any registered packet listeners.
Parameters
lhsthe triangulation whose contents should be swapped with rhs.
rhsthe triangulation whose contents should be swapped with lhs.

Copyright © 1999-2023, 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).