LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
TemplateInvoker.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * See COPYRIGHT file at the top of the source tree.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_UTILS_PYTHON_TEMPLATEINVOKER_H
25 #define LSST_UTILS_PYTHON_TEMPLATEINVOKER_H
26 
27 #include "pybind11/pybind11.h"
28 #include "pybind11/numpy.h"
29 
30 #include <iostream>
31 
32 namespace lsst { namespace utils { namespace python {
33 
107 public:
108 
110  template <typename ...Types>
111  struct Tag {};
112 
114  using OnErrorCallback = std::function<pybind11::object(pybind11::dtype const & dtype)>;
115 
117  static pybind11::object handleErrorDefault(pybind11::dtype const & dtype) {
118  PyErr_Format(PyExc_TypeError, "dtype '%R' not supported.", dtype.ptr());
119  throw pybind11::error_already_set();
120  }
121 
129  explicit TemplateInvoker(OnErrorCallback onError) : _onError(std::move(onError)) {}
130 
133 
155  template <typename Function, typename ...TypesToTry>
156  pybind11::object apply(
157  Function function,
158  pybind11::dtype const & dtype,
159  Tag<TypesToTry...> typesToTry
160  ) const {
161  return _apply(function, dtype, typesToTry);
162  }
163 
164 private:
165 
166  template <typename Function>
167  pybind11::object _apply(Function & function, pybind11::dtype const & dtype, Tag<>) const {
168  return _onError(dtype);
169  }
170 
171  template <typename Function, typename T, typename ...A>
172  pybind11::object _apply(Function & function, pybind11::dtype const & dtype, Tag<T, A...>) const {
173  if (pybind11::detail::npy_api::get().PyArray_EquivTypes_(dtype.ptr(),
174  pybind11::dtype::of<T>().ptr())) {
175  return pybind11::cast(function(static_cast<T>(0)));
176  }
177  return _apply(function, dtype, Tag<A...>());
178  }
179 
180  OnErrorCallback _onError;
181 };
182 
183 }}} // namespace lsst::utils::python
184 
185 #endif
std::function< pybind11::object(pybind11::dtype const &dtype)>
lsst::utils::python::TemplateInvoker::Tag
A simple tag type used to pass one or more types as a function argument.
Definition: TemplateInvoker.h:111
lsst::utils::python::TemplateInvoker::apply
pybind11::object apply(Function function, pybind11::dtype const &dtype, Tag< TypesToTry... > typesToTry) const
Call and return function(static_cast<T>(0)) with the type T that matches a given NumPy dtype object.
Definition: TemplateInvoker.h:156
lsst::utils::python::TemplateInvoker
A helper class for wrapping C++ template functions as Python functions with dtype arguments.
Definition: TemplateInvoker.h:106
lsst::utils::python::TemplateInvoker::handleErrorDefault
static pybind11::object handleErrorDefault(pybind11::dtype const &dtype)
Callback used for handling unmatched-type errors by default.
Definition: TemplateInvoker.h:117
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::utils::python::TemplateInvoker::TemplateInvoker
TemplateInvoker()
Construct a TemplateInvoker that calls handleErrorDefault when no match is found.
Definition: TemplateInvoker.h:132
lsst::utils::python::TemplateInvoker::OnErrorCallback
std::function< pybind11::object(pybind11::dtype const &dtype)> OnErrorCallback
Callback type for handling unmatched-type errors.
Definition: TemplateInvoker.h:114
std
STL namespace.
lsst::utils::python::TemplateInvoker::TemplateInvoker
TemplateInvoker(OnErrorCallback onError)
Construct a TemplateInvoker that calls the given object when no match is found.
Definition: TemplateInvoker.h:129