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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Python Interface *
* *
* 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 python/helpers/listview.h
* \brief Assists with wrapping instances of Regina's lightweight ListView
* template class.
*
* This header is _not_ included automatically by python/helpers.h.
* If you need it, you will need to include it yourself.
*/
#include "../helpers.h"
#include <pybind11/stl.h>
#include "utilities/tableview.h"
#include "../docstrings/utilities/tableview.h"
namespace regina::python {
/**
* A helper class used for building Python class names that wrap Regina's
* C++ TableView classes. This is internal to addTableView().
*/
template <typename Element>
inline constexpr const char* tableViewElementName = nullptr;
template <>
inline constexpr const char* tableViewElementName<int> = "int";
template <>
inline constexpr const char* tableViewElementName<std::string> = "str";
template <>
inline constexpr const char* tableViewElementName<regina::Perm<4>> = "Perm4";
/**
* Adds Python bindings for one of Regina's TableView classes, if this
* has not been done already.
*
* The class to be wrapped will be regina::TableView<Element, dim1, dim...>.
* The element type and the table dimensions must be explicitly specified
* in the template arguments for addTableView().
*
* The Python class corresponding to \a T will be given a name that is derived
* from the template variable `tableViewElementName<Element>`. This means that
* `tableViewElementName<Element>` _must_ have a corresponding specialisation.
* Otherwise this routine will crash (since the default value of
* `tableViewElementName<Element>` is a null pointer).
*
* Note that the Python module that is passed to addTableView() should be
* the submodule `regina.internal`, not the main module `regina`.
*
* If this TableView class has already been wrapped in Python, then this
* routine will do nothing (i.e., it is safe to call this routine
* multiple times for the same TableView class). This is to support
* wrapTableView(), which might be used to wrap several global constant
* arrays of the same type and dimensions. Note that this behaviour is
* different from addListView, which will throw an exception if called for
* the same type more than once.
*
* Return value policies work as follows:
*
* - When accessing a table element (e.g., via iteration or indexing), the
* relationship between the table element and the TableView will be as
* follows. Table elements that are pointers will use a \c reference_internal
* policy, and thus keep the TableView alive; table elements that are values
* will use a \c copy policy, and thus will have independent lifespans.
* At present, it is not possible to override these policies.
*
* - If you need the table elements to keep the underlying container alive,
* you will need to indicate this when wrapping whatever function returns a
* TableView. This is generally not necessary, since TableView objects
* in Regina typically refer to global constant arrays; however, for further
* discussion on this issue you can see the addListView() documentation.
*/
template <typename Element, int dim1, int... dim>
void addTableView(pybind11::module_& internal) {
static constexpr pybind11::return_value_policy Policy =
(std::is_pointer<Element>::value ?
pybind11::return_value_policy::reference_internal :
pybind11::return_value_policy::copy);
using T = regina::TableView<Element, dim1, dim...>;
// Do not wrap T if this has been done already.
if (pybind11::detail::get_type_info(typeid(T)))
return;
// Wrap any subtables as necessary.
if constexpr (T::dimension > 1)
addTableView<Element, dim...>(internal);
RDOC_SCOPE_BEGIN(TableView)
std::string prefix = std::string("TableView_") +
tableViewElementName<Element> + "_" + std::to_string(dim1);
auto c = pybind11::class_<T>(internal,
(prefix + ... + ("_" + std::to_string(dim))).c_str(),
rdoc_scope)
.def(pybind11::init<const T&>(), rdoc::__copy)
.def("size", &T::size, rdoc::size)
.def("__len__", [](const T& view) {
return view.size().front();
}, rdoc::size)
.def("__getitem__", [](const T& view, size_t index) {
if (index >= view.size().front())
throw pybind11::index_error("TableView index out of range");
return view[index];
}, Policy, rdoc::__array)
.def("__iter__", [](const T& view) {
return pybind11::make_iterator<Policy>(view.begin(), view.end());
}, pybind11::keep_alive<0, 1>(), // iterator keeps ListView alive
rdoc::__iter__)
;
c.attr("dimension") = T::dimension;
regina::python::add_output_custom(c, [](const T& view, std::ostream& out) {
out << "[ ";
// For very small arrays, output the entire array.
// For larger arrays, do not output everything.
if (view.size().front() == 0) {
out << "[ ]";
} else if (view.size().front() <= 5) {
bool started = false;
for (size_t i = 0; i < view.size().front(); ++i) {
if (started)
out << ", ";
else
started = true;
regina::python::writeStr(out, view[i]);
}
out << ' ';
} else {
for (int i = 0; i < 3; ++i) {
regina::python::writeStr(out, view[i]);
out << ", ";
}
out << "..., ";
regina::python::writeStr(out, view[view.size().front() - 1]);
out << ' ';
}
out << ']';
}, "<internal>.TableView");
regina::python::add_eq_operators(c, rdoc::__eq);
RDOC_SCOPE_END
}
/**
* Adds Python bindings for one of Regina's 1-D TableView classes, and wraps
* the given fixed-size C-style array in such a TableView. Typically the
* given array would be a global constant array.
*
* The given array should be a C-style array of compile-time-constant
* dimension \a dim, whose elements are of type \a Element.
* Typically these template arguments \a Element and \a dim would be deduced
* automatically, and would not need to be supplied with this function call.
*
* This routine has the effect of (i) creating a TableView of the appropriate
* type to wrap \a array; (ii) wrapping this TableView class in Python, if
* it has not been wrapped already; and then (iii) returning this TableView
* object so that it can be set as a class attribute or global constant.
*
* The default return value policies supplied by addTableView() will be used,
* and it is not possible to override them here. See addTableView() for
* further details.
*
* Note that the Python module that is passed to addTableView() should be
* the submodule `regina.internal`, not the main module `regina`.
*/
template <typename Element, int dim1>
regina::TableView<Element, dim1> wrapTableView(pybind11::module_& internal,
const Element (&array)[dim1]) {
addTableView<Element, dim1>(internal);
// Remember: TableView is lightweight and cheap to pass by value.
return regina::TableView(array);
}
/**
* Adds Python bindings for one of Regina's 2-D TableView classes, and wraps
* the given fixed-size C-style array in such a TableView. Typically the
* given array would be a global constant array.
*
* The given array should be a C-style 3-D array of compile-time-constant
* dimensions \a dim1 and \a dim2, whose elements are of type \a Element.
* Typically these template arguments \a Element, \a dim1 and \a dim2 would
* be deduced automatically, and would not need to be supplied with this
* function call.
*
* This routine has the effect of (i) creating a TableView of the appropriate
* type to wrap \a array; (ii) wrapping this TableView class and all necessary
* sub-table classes in Python, if they have not been wrapped already; and
* then (iii) returning this TableView object so that it can be set as a
* class attribute or global constant.
*
* The default return value policies supplied by addTableView() will be used,
* and it is not possible to override them here. See addTableView() for
* further details.
*
* Note that the Python module that is passed to addTableView() should be
* the submodule `regina.internal`, not the main module `regina`.
*/
template <typename Element, int dim1, int dim2>
regina::TableView<Element, dim1, dim2> wrapTableView(
pybind11::module_& internal, const Element (&array)[dim1][dim2]) {
addTableView<Element, dim1, dim2>(internal);
// Remember: TableView is lightweight and cheap to pass by value.
return regina::TableView(array);
}
/**
* Adds Python bindings for one of Regina's 3-D TableView classes, and wraps
* the given fixed-size C-style array in such a TableView. Typically the
* given array would be a global constant array.
*
* The given array should be a C-style 3-D array of compile-time-constant
* dimensions \a dim1, \a dim2 and \a dim3, whose elements are of type
* \a Element. Typically these template arguments \a Element, \a dim1,
* \a dim2 and \a dim3 would be deduced automatically, and would not need
* to be supplied with this function call.
*
* This routine has the effect of (i) creating a TableView of the appropriate
* type to wrap \a array; (ii) wrapping this TableView class and all necessary
* sub-table classes in Python, if they have not been wrapped already; and
* then (iii) returning this TableView object so that it can be set as a
* class attribute or global constant.
*
* The default return value policies supplied by addTableView() will be used,
* and it is not possible to override them here. See addTableView() for
* further details.
*
* Note that the Python module that is passed to addTableView() should be
* the submodule `regina.internal`, not the main module `regina`.
*/
template <typename Element, int dim1, int dim2, int dim3>
regina::TableView<Element, dim1, dim2, dim3> wrapTableView(
pybind11::module_& internal, const Element (&array)[dim1][dim2][dim3]) {
addTableView<Element, dim1, dim2, dim3>(internal);
// Remember: TableView is lightweight and cheap to pass by value.
return regina::TableView(array);
}
} // namespace regina::python
|
