This documentation describes the functions, classes and related entities in the C++ calculation engine, as well as the mirroring of these in Python.

Citation

If you find Regina useful in your research, please consider citing it as you would any other paper that you use. The introductory chapter of the Regina handbook includes a suggested form of reference.

Copying and Modification

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.

SnapPea Kernel

Since version 4.2 (July 2005), Regina includes portions of the SnapPea kernel which it uses for certain geometric calculations. SnapPea is copyright © 1991-2005 by Jeff Weeks, who has graciously given permission for it to be distributed under the terms of the GNU General Public License as described above.

Orb Kernel

Since version 4.3.1 (May 2006), Regina includes snippets of code from Orb for use in importing and exporting files in Orb / Casson format. Orb is based on SnapPea (see above) with additional code written by Damian Heard, who has also given permission for his code to be distributed under the terms of the GNU General Public License.

Acknowledgements

Many people have been of assistance with this project, be it through time, knowledge, testing or code. Please see the full list of acknowledgements in the final chapter of the Regina handbook.