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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/**************************************************************************
* *
* 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 angle/angleflags.h
* \brief Defines constants and flags for angle structure enumeration.
*/
#ifndef __REGINA_ANGLEFLAGS_H
#ifndef __DOXYGEN
#define __REGINA_ANGLEFLAGS_H
#endif
#include "regina-core.h"
#include "utilities/flags.h"
namespace regina {
/**
* Represents options and variants of algorithms for enumerating various
* types of angle structures on 3-manifold triangulations. This enumeration
* type is used with angle structure enumeration routines, such as the
* AngleStructures class constructor.
*
* These values can be combined using the bitwise OR operator (resulting in an
* object of type `Flags<AngleAlg>`). In particular, if a hypersurface
* enumeration function takes an argument of type `Flags<AngleAlg>`, then you
* can pass a single AngleAlg constant, or a bitwise combination of such
* constants `(flag1 | flag2)`, or empty braces `{}` to indicate no flags at
* all (which is equivalent to passing `AngleAlg::Default`).
*
* \ingroup angle
*/
enum class AngleAlg {
/**
* An empty flag, indicating to an enumeration routine that it
* should use its default behaviour.
* The numeric value of this flag is zero (i.e., it has no effect
* when combined with other flags using bitwise OR).
*/
Default = 0x0000,
/**
* When enumerating taut angle structures, this flag indicates that
* the tree traversal algorithm should be used.
*
* This algorithm is based on linear and integer programming
* techniques, and has many desirable properties including a
* relatively low overhead. Enumeration algorithms will use it if
* possible unless a different method is explicitly requested.
*
* This is a variant of the tree traversal algorithm from B. A. Burton
* and M. Ozlen, "A tree traversal algorithm for decision problems in
* knot theory and 3-manifold topology", Algorithmica 65 (2013),
* pp. 772-801.
*
* This flag is incompatible with DD.
*/
Tree = 0x0010,
/**
* When enumerating vertex or taut angle structures, this flag indicates
* that a modified double description method should be used.
*
* This is currently the only supported algorithm for enumerating
* all vertex angle structures (not just taut structures).
*
* This flag is incompatible with Tree.
*/
DD = 0x0020,
/**
* Indicates that an angle structure list was enumerated using an
* older version of Regina (6.0.1 or earlier).
*
* These older versions did not retain details of the algorithm
* used to build each list, and so in such cases no further
* algorithmic information is available.
*
* If this flag is passed to an enumeration algorithm, it will be ignored.
*/
Legacy = 0x4000,
/**
* Indicates that an angle structure list was built using a customised
* algorithm. In such cases, no further details on the algorithm are
* available.
*
* If this flag is passed to an enumeration algorithm, it will be ignored.
*/
Custom = 0x8000
};
/**
* A deprecated type alias representing options and variants of algorithms for
* enumerating angle structures on 3-manifold triangulations.
*
* \deprecated As of Regina 7.4, AngleAlgFlags is simply an alias for the
* enumeration type AngleAlg. A bitwise _combination_ of such values will
* have the type `Flags<AngleAlg>`, though there is usually no need for end
* users to explicitly refer to the flags type by name.
*
* \ingroup angle
*/
using AngleAlgFlags [[deprecated]] = AngleAlg;
/**
* A deprecated constant indicating an algorithm variant for enumerating
* angle structures on a 3-manifold triangulation.
*
* \deprecated This has been renamed to the scoped enumeration constant
* AngleAlg::Default.
*/
[[deprecated]] inline static constexpr AngleAlg AS_ALG_DEFAULT =
AngleAlg::Default;
/**
* A deprecated constant indicating an algorithm variant for enumerating
* angle structures on a 3-manifold triangulation.
*
* \deprecated This has been renamed to the scoped enumeration constant
* AngleAlg::Tree.
*/
[[deprecated]] inline static constexpr AngleAlg AS_ALG_TREE =
AngleAlg::Tree;
/**
* A deprecated constant indicating an algorithm variant for enumerating
* angle structures on a 3-manifold triangulation.
*
* \deprecated This has been renamed to the scoped enumeration constant
* AngleAlg::DD.
*/
[[deprecated]] inline static constexpr AngleAlg AS_ALG_DD =
AngleAlg::DD;
/**
* A deprecated constant indicating an algorithm variant for enumerating
* angle structures on a 3-manifold triangulation.
*
* \deprecated This has been renamed to the scoped enumeration constant
* AngleAlg::Legacy.
*/
[[deprecated]] inline static constexpr AngleAlg AS_ALG_LEGACY =
AngleAlg::Legacy;
/**
* A deprecated constant indicating an algorithm variant for enumerating
* angle structures on a 3-manifold triangulation.
*
* \deprecated This has been renamed to the scoped enumeration constant
* AngleAlg::Custom.
*/
[[deprecated]] inline static constexpr AngleAlg AS_ALG_CUSTOM =
AngleAlg::Custom;
/**
* Returns the bitwise OR of the two given flags.
*
* \param lhs the first flag to combine.
* \param rhs the second flag to combine.
* \return the combination of both flags.
*
* \ingroup angle
*/
inline Flags<AngleAlg> operator | (AngleAlg lhs, AngleAlg rhs) {
return Flags<AngleAlg>(lhs) | rhs;
}
} // namespace regina
#endif
|
