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
|
/**************************************************************************
* *
* 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/operators.h>
#include <pybind11/stl.h>
#include "maths/vector.h"
#include "../helpers.h"
#include "../docstrings/maths/vector.h"
using pybind11::overload_cast;
template <typename T>
void addVectorOf(pybind11::module_& m, const char* className) {
using Vec = regina::Vector<T>;
// For now, T is one of Regina's arbitrary-precision integer classes.
// Fetch the _other_ integer type, for use with our constructors.
using T_Alt = regina::IntegerBase<! T::supportsInfinity>;
RDOC_SCOPE_BEGIN(Vector)
auto c = pybind11::class_<Vec>(m, className, rdoc_scope)
.def(pybind11::init<size_t>(), rdoc::__init)
.def(pybind11::init<size_t, const T&>(), rdoc::__init_2)
.def(pybind11::init<const Vec&>(), rdoc::__copy)
.def(pybind11::init([](const std::vector<T> v) {
return new Vec(v.begin(), v.end());
}), pybind11::arg("elements"), rdoc::__init_3)
.def(pybind11::init<const regina::Vector<T_Alt>&>(), rdoc::__init_4)
.def("size", &Vec::size, rdoc::size)
.def("__len__", &Vec::size, rdoc::size)
.def("__getitem__", [](Vec& v, size_t index) -> T& {
return v[index];
}, pybind11::return_value_policy::reference_internal, rdoc::__array)
.def("__setitem__", [](Vec& v, size_t index, const T& value) {
v[index] = value;
}, rdoc::__array_2)
.def("__iter__", [](const Vec& list) {
return pybind11::make_iterator(list);
}, pybind11::keep_alive<0, 1>(), // iterator keeps vector alive
rdoc::__iter__)
.def(pybind11::self += pybind11::self, rdoc::__iadd)
.def(pybind11::self -= pybind11::self, rdoc::__isub)
.def(pybind11::self *= T(), rdoc::__imul)
.def(pybind11::self + pybind11::self, rdoc::__add)
.def(pybind11::self - pybind11::self, rdoc::__sub)
.def(pybind11::self * T(), rdoc::__mul)
.def(pybind11::self * pybind11::self, rdoc::__mul_2)
.def("swap", &Vec::swap, rdoc::swap)
.def("negate", &Vec::negate, rdoc::negate)
.def("norm", &Vec::norm, rdoc::norm)
.def("elementSum", &Vec::elementSum, rdoc::elementSum)
.def("addCopies", &Vec::addCopies, rdoc::addCopies)
.def("subtractCopies", &Vec::subtractCopies, rdoc::subtractCopies)
.def("isZero", &Vec::isZero, rdoc::isZero)
.def("scaleDown", &Vec::scaleDown, rdoc::scaleDown)
.def_static("unit", &Vec::unit, rdoc::unit)
;
regina::python::add_output(c);
regina::python::add_tight_encoding(c);
regina::python::add_eq_operators(c, rdoc::__eq);
regina::python::add_global_swap<Vec>(m, rdoc::global_swap);
RDOC_SCOPE_END
pybind11::implicitly_convertible<std::vector<int>, Vec>();
pybind11::implicitly_convertible<std::vector<T>, Vec>();
}
void addVector(pybind11::module_& m) {
addVectorOf<regina::Integer>(m, "VectorInt");
addVectorOf<regina::LargeInteger>(m, "VectorLarge");
}
|