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
|
/**************************************************************************
* *
* 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 triangulation/example.h
* \brief Offers some example higher-dimensional triangulations as
* starting points for testing code or getting used to Regina.
*/
#ifndef __REGINA_EXAMPLE_H
#ifndef __DOXYGEN
#define __REGINA_EXAMPLE_H
#endif
#include "regina-core.h"
#include "triangulation/forward.h"
#include "triangulation/detail/example.h"
namespace regina {
/**
* This class offers static routines for constructing a variety of sample
* <i>dim</i>-dimensional triangulations. These triangulations may be useful
* for testing new code, or for simply getting a feel for how Regina works.
*
* In higher dimensions, only a handful of triangulations are available
* (in contrast to the 3-dimensional class Example<3>, which offers
* many interesting examples). The authors hope to expand this list
* in future releases of Regina.
*
* The sample triangulations offered here may prove especially useful in
* Regina's scripting interface, where working with pre-existing files
* is more complicated than in the GUI.
*
* For Regina's \ref stddim "standard dimensions", this template is
* specialised and offers many more example triangulations. In order to
* use these specialised classes, you will need to include the corresponding
* headers (e.g., triangulation/example2.h for \a dim = 2, or
* triangulation/example3.h for \a dim = 3).
*
* \python Python does not support templates. Instead this class
* can be used by appending the dimension as a suffix (e.g., Example2
* and Example3 for dimensions 2 and 3).
*
* \tparam dim the dimension of the example triangulations to construct.
* This must be between 2 and 15 inclusive.
*
* \headerfile triangulation/generic.h
*
* \ingroup triangulation
*/
template <int dim>
class Example : public detail::ExampleBase<dim> {
static_assert(! standardDim(dim),
"The generic implementation of Example<dim> "
"should not be used for Regina's standard dimensions.");
};
} // namespace regina
#endif
|
