File: isosig-bindings.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 (191 lines) | stat: -rw-r--r-- 8,157 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
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

/**************************************************************************
 *                                                                        *
 *  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/>. *
 *                                                                        *
 **************************************************************************/

#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include "triangulation/forward.h"
#include "triangulation/isosigencoding.h"
#include "triangulation/isosigtype.h"
#include "utilities/exception.h"
#include "../helpers.h"
#include "../docstrings/triangulation/isosigencoding.h"
#include "../docstrings/triangulation/isosigtype.h"

using regina::Perm;

namespace regina::python {

/**
 * Adds all of the available variants of isoSig() to the python bindings for a
 * C++ triangulation class.
 *
 * To use this for the C++ class `Triangulation<dim>`, simply call
 * `regina::python::isosig_options<dim>(c)`, where \a c is the
 * pybind11::class_ object that wraps `Triangulation<dim>`.
 */
template <int dim, typename PythonClass>
void isosig_options(PythonClass& classWrapper) {
    RDOC_SCOPE_BASE(detail::TriangulationBase)

    using LockFree = regina::IsoSigPrintableLockFree<dim>;

    classWrapper
        .def("isoSig",
            &Triangulation<dim>::template isoSig<>,
            rbase::isoSig)
        .def("isoSig_LockFree",
            &Triangulation<dim>::template isoSig<
                regina::IsoSigClassic<dim>, LockFree>,
            rbase::isoSig)
        .def("isoSig_EdgeDegrees",
            &Triangulation<dim>::template isoSig<
                regina::IsoSigEdgeDegrees<dim>>,
            rbase::isoSig)
        .def("isoSig_EdgeDegrees_LockFree",
            &Triangulation<dim>::template isoSig<
                regina::IsoSigEdgeDegrees<dim>, LockFree>,
            rbase::isoSig)
        .def("isoSig_RidgeDegrees",
            &Triangulation<dim>::template isoSig<
                regina::IsoSigRidgeDegrees<dim>>,
            rbase::isoSig)
        .def("isoSig_RidgeDegrees_LockFree",
            &Triangulation<dim>::template isoSig<
                regina::IsoSigRidgeDegrees<dim>, LockFree>,
            rbase::isoSig)

        .def("isoSigDetail",
            &Triangulation<dim>::template isoSigDetail<>,
            rbase::isoSigDetail)
        .def("isoSigDetail_LockFree",
            &Triangulation<dim>::template isoSigDetail<
                regina::IsoSigClassic<dim>, LockFree>,
            rbase::isoSigDetail)
        .def("isoSigDetail_EdgeDegrees",
            &Triangulation<dim>::template isoSigDetail<
                regina::IsoSigEdgeDegrees<dim>>,
            rbase::isoSigDetail)
        .def("isoSigDetail_EdgeDegrees_LockFree",
            &Triangulation<dim>::template isoSigDetail<
                regina::IsoSigEdgeDegrees<dim>, LockFree>,
            rbase::isoSigDetail)
        .def("isoSigDetail_RidgeDegrees",
            &Triangulation<dim>::template isoSigDetail<
                regina::IsoSigRidgeDegrees<dim>>,
            rbase::isoSigDetail)
        .def("isoSigDetail_RidgeDegrees_LockFree",
            &Triangulation<dim>::template isoSigDetail<
                regina::IsoSigRidgeDegrees<dim>, LockFree>,
            rbase::isoSigDetail)
        ;
}

} // namespace regina::python

template <int dim>
void addIsoSigClassic(pybind11::module_& m, const char* name) {
    RDOC_SCOPE_BEGIN(IsoSigClassic)

    using Type = regina::IsoSigClassic<dim>;
    auto s = pybind11::class_<Type>(m, name, rdoc_scope)
        .def(pybind11::init<const regina::Component<dim>&>(), rdoc::__init)
        .def("simplex", &Type::simplex, rdoc::simplex)
        .def("perm", &Type::perm, rdoc::perm)
        .def("next", &Type::next, rdoc::next)
        ;
    regina::python::disable_eq_operators(s);

    RDOC_SCOPE_END
}

template <int dim>
void addIsoSigEdgeDegrees(pybind11::module_& m, const char* name) {
    RDOC_SCOPE_BEGIN(IsoSigDegrees)

    using Type = regina::IsoSigEdgeDegrees<dim>;
    auto s = pybind11::class_<Type>(m, name, rdoc_scope)
        .def(pybind11::init<const regina::Component<dim>&>(), rdoc::__init)
        .def("simplex", &Type::simplex, rdoc::simplex)
        .def("perm", &Type::perm, rdoc::perm)
        .def("next", &Type::next, rdoc::next)
        ;
    regina::python::disable_eq_operators(s);

    RDOC_SCOPE_END
}

template <int dim>
void addIsoSigRidgeDegrees(pybind11::module_& m, const char* name) {
    RDOC_SCOPE_BEGIN(IsoSigDegrees)

    using Type = regina::IsoSigRidgeDegrees<dim>;
    auto s = pybind11::class_<Type>(m, name, rdoc_scope)
        .def(pybind11::init<const regina::Component<dim>&>(), rdoc::__init)
        .def("simplex", &Type::simplex, rdoc::simplex)
        .def("perm", &Type::perm, rdoc::perm)
        .def("next", &Type::next, rdoc::next)
        ;
    regina::python::disable_eq_operators(s);

    RDOC_SCOPE_END
}

template <int dim, bool supportLocks>
void addIsoSigPrintable(pybind11::module_& m, const char* name) {
    RDOC_SCOPE_BEGIN(IsoSigPrintable)

    using Encoding = regina::IsoSigPrintable<dim, supportLocks>;
    auto s = pybind11::class_<Encoding>(m, name, rdoc_scope)
        .def_readonly_static("charsPerPerm", &Encoding::charsPerPerm)
        .def_static("emptySig", &Encoding::emptySig, rdoc::emptySig)
        .def_static("encode", [](
                size_t size,
                const std::vector<uint8_t>& facetAction,
                const std::vector<size_t>& joinDest,
                const std::vector<typename Perm<dim+1>::Index>& joinGluing,
                const std::optional<std::vector<
                    typename regina::Simplex<dim>::LockMask>> lockMasks) {
            if (joinDest.size() != joinGluing.size())
                throw regina::InvalidArgument("The arguments "
                    "joinDest and joinGluing must be lists of the same size");
            return Encoding::encode(size, facetAction.size(),
                facetAction.data(), joinDest.size(), joinDest.data(),
                joinGluing.data(),
                (lockMasks ? lockMasks->data() : nullptr));
        }, pybind11::arg("size"), pybind11::arg("facetAction"),
            pybind11::arg("joinDest"), pybind11::arg("joinGluing"),
            pybind11::arg("lockMasks"),
            rdoc::encode)
        ;
    regina::python::no_eq_static(s);

    RDOC_SCOPE_END
}