_compoundRegion.cc

Go to the documentation of this file.

/*
 * This file is part of sphgeom.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (http://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This software is dual licensed under the GNU General Public License and also
 * under a 3-clause BSD license. Recipients may choose which of these licenses
 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
 * respectively.  If you choose the GPL option then the following text applies
 * (but note that there is still no warranty even if you opt for BSD instead):
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * 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 <http://www.gnu.org/licenses/>.
 */
#include "pybind11/pybind11.h"
#include "pybind11/stl.h"
 
#include "lsst/sphgeom/python.h"
#include "lsst/sphgeom/python/utils.h"
#include "lsst/sphgeom/CompoundRegion.h"
 
namespace py = pybind11;
using namespace pybind11::literals;
 
namespace lsst {
namespace sphgeom {
 
namespace {
 
py::str _repr(const char *class_name, CompoundRegion const &self) {
    std::string format = class_name;
    format += "(";
    py::tuple operands(self.nOperands());
    for (unsigned i = 0; i != self.nOperands(); i++) {
        py::object operand = py::cast(self.getOperand(i), py::return_value_policy::reference);
        operands[i] = operand;
        if (i != 0) {
            format += ", ";
        }
        format += "{!r}";
    }
    format += ")";
    return py::str(format).format(*operands);
}
 
template <typename _CompoundRegion>
std::unique_ptr<_CompoundRegion> _args_factory(const py::args& args) {
    std::vector<std::unique_ptr<Region>> operands;
    for (auto&& item: args) {
        Region* region = item.cast<Region*>();
        operands.emplace_back(region->clone());
    }
    return std::make_unique<_CompoundRegion>(std::move(operands));
}
 
// Iterator for CompoundRegion.
class CompoundIterator {
public:
    CompoundIterator(CompoundRegion const& compound, size_t pos) : _compound(compound), _pos(pos) {}
 
    Region const& operator*() const { return _compound.getOperand(_pos); }
 
    CompoundIterator& operator++() {
        ++ _pos;
        return *this;
    }
 
    bool operator==(CompoundIterator const& other) const {
        return &_compound == &other._compound and _pos == other._pos;
    }
 
private:
    CompoundRegion const& _compound;
    size_t _pos;
};
 
}  // namespace
 
template <>
void defineClass(py::classh<CompoundRegion, Region> &cls) {
    cls.def("nOperands", &CompoundRegion::nOperands);
    cls.def("__len__", &CompoundRegion::nOperands);
    cls.def(
        "__iter__",
        [](CompoundRegion const& region) {
            return py::make_iterator(
                CompoundIterator(region, 0U), CompoundIterator(region, region.nOperands())
            );
        },
        py::return_value_policy::reference_internal  // Keeps region alive while iterator is in use.
    );
    cls.def(
        "cloneOperand",
        [](CompoundRegion const &self, std::ptrdiff_t n) {
            int nOperands = self.nOperands();
            return self.getOperand(python::convertIndex(nOperands, n)).clone();
        }
    );
}
 
template <>
void defineClass(py::classh<UnionRegion, CompoundRegion> &cls) {
    cls.attr("TYPE_CODE") = py::int_(UnionRegion::TYPE_CODE);
    cls.def(py::init(&_args_factory<UnionRegion>));
    cls.def(py::pickle(&python::encode, &python::decode<UnionRegion>));
    cls.def("__repr__", [](CompoundRegion const &self) { return _repr("UnionRegion", self); });
}
 
template <>
void defineClass(py::classh<IntersectionRegion, CompoundRegion> &cls) {
    cls.attr("TYPE_CODE") = py::int_(IntersectionRegion::TYPE_CODE);
    cls.def(py::init(&_args_factory<IntersectionRegion>));
    cls.def(py::pickle(&python::encode, &python::decode<IntersectionRegion>));
    cls.def("__repr__", [](CompoundRegion const &self) { return _repr("IntersectionRegion", self); });
}
 
}  // namespace sphgeom
}  // namespace lsst