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
97
98
|
/**************************************************************************
* *
* 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/>. *
* *
**************************************************************************/
#ifndef __REGINA_COMPONENT_H
#ifndef __DOXYGEN
#define __REGINA_COMPONENT_H
#endif
/*! \file triangulation/generic/component.h
* \brief Internal header for connected components of triangulations of
* arbitrary dimension.
*
* This file is automatically included from triangulation/generic.h;
* there is no need for end users to include this header explicitly.
*/
#include "triangulation/detail/component.h"
namespace regina {
/**
* A connected component of a <i>dim</i>-manifold triangulation.
*
* Components are highly temporary: whenever a triangulation changes, all
* of its component objects will be deleted and new ones will be created
* in their place.
*
* For Regina's \ref stddim "standard dimensions", this template is specialised
* and offers more functionality. In order to use these specialised classes,
* you will need to include the corresponding triangulation headers (e.g.,
* triangulation/dim2.h for \a dim = 2, or triangulation/dim3.h
* for \a dim = 3).
*
* Components do not support value semantics: they cannot be copied, swapped,
* or manually constructed. Their location in memory defines them, and
* they are often passed and compared by pointer. End users are never
* responsible for their memory management; this is all taken care of by
* the Triangulation to which they belong.
*
* \python Python does not support templates. Instead
* this class can be used by appending the dimension as a suffix
* (e.g., Component2 and Component3 for dimensions 2 and 3).
*
* \tparam dim the dimension of the underlying triangulation.
* This must be between 2 and 15 inclusive.
*
* \headerfile triangulation/generic.h
*
* \ingroup generic
*/
template <int dim>
class Component : public detail::ComponentBase<dim> {
static_assert(! standardDim(dim),
"The generic implementation of Component<dim> "
"should not be used for Regina's standard dimensions.");
private:
/**
* Default constructor.
*
* Marks the component as orientable, with no boundary facets.
*/
Component() = default;
friend class detail::TriangulationBase<dim>;
};
} // namespace regina
#endif
|
