File: examplesnappea.h

package info (click to toggle)
regina-normal 7.4.1-1.1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 154,244 kB
  • sloc: cpp: 295,026; xml: 9,992; sh: 1,344; python: 1,225; perl: 616; ansic: 138; makefile: 26
file content (96 lines) | stat: -rw-r--r-- 3,778 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

/**************************************************************************
 *                                                                        *
 *  Regina - A Normal Surface Theory Calculator                           *
 *  Computational Engine                                                  *
 *                                                                        *
 *  Copyright (c) 1999-2025, Ben Burton                                   *
 *  For further details contact Ben Burton (bab@debian.org).              *
 *                                                                        *
 *  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.                       *
 *                                                                        *
 *  As an exception, when this program is distributed through (i) the     *
 *  App Store by Apple Inc.; (ii) the Mac App Store by Apple Inc.; or     *
 *  (iii) Google Play by Google Inc., then that store may impose any      *
 *  digital rights management, device limits and/or redistribution        *
 *  restrictions that are required by its terms of service.               *
 *                                                                        *
 *  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, see <https://www.gnu.org/licenses/>. *
 *                                                                        *
 **************************************************************************/

/*! \file snappea/examplesnappea.h
 *  \brief Offers several ready-made example SnapPea triangulations.
 */

#ifndef __REGINA_EXAMPLESNAPPEA_H
#ifndef __DOXYGEN
#define __REGINA_EXAMPLESNAPPEA_H
#endif

#include "regina-core.h"

namespace regina {

class SnapPeaTriangulation;

/**
 * This class offers routines for constructing various example SnapPea
 * triangulations.  This is analagous to the (much richer) Example<3> class.
 *
 * \ingroup snappea
 */
class ExampleSnapPea {
    public:
        /**
         * Returns a new triangulation of the Gieseking manifold.
         *
         * \return the Gieseking manifold.
         */
        static SnapPeaTriangulation gieseking();

        /**
         * Returns a new triangulation of the figure eight knot complement.
         *
         * \return the figure eight knot complement.
         */
        static SnapPeaTriangulation figureEight();

        /**
         * Returns a new triangulation of the trefoil knot complement.
         *
         * \return the trefoil knot complement.
         */
        static SnapPeaTriangulation trefoil();

        /**
         * Returns a new triangulation of the Whitehead link complement.
         *
         * \return the Whitehead link complement.
         */
        static SnapPeaTriangulation whiteheadLink();

        /**
         * Returns a new triangulation of the SnapPea census manifold \c x101.
         *
         * \return the SnapPea census manifold \c x101.
         */
        static SnapPeaTriangulation x101();

        // Make this class non-constructible.
        ExampleSnapPea() = delete;
};

} // namespace regina

#endif