LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
A helper class for wrapping C++ template functions as Python functions with dtype arguments. More...
#include <TemplateInvoker.h>
Classes | |
struct | Tag |
A simple tag type used to pass one or more types as a function argument. More... | |
Public Types | |
using | OnErrorCallback = std::function< pybind11::object(pybind11::dtype const &dtype)> |
Callback type for handling unmatched-type errors. More... | |
Public Member Functions | |
TemplateInvoker (OnErrorCallback onError) | |
Construct a TemplateInvoker that calls the given object when no match is found. More... | |
TemplateInvoker () | |
Construct a TemplateInvoker that calls handleErrorDefault when no match is found. More... | |
template<typename Function , typename ... TypesToTry> | |
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. More... | |
Static Public Member Functions | |
static pybind11::object | handleErrorDefault (pybind11::dtype const &dtype) |
Callback used for handling unmatched-type errors by default. More... | |
A helper class for wrapping C++ template functions as Python functions with dtype arguments.
TemplateInvoker takes a templated callable object, a pybind11::dtype
object, and a sequence of supported C++ types via its nested Tag
struct. The callable is invoked with a scalar argument of the type matching the dtype
object. If none of the supported C++ types match, a different error callback is invoked instead.
As an example, we'll wrap this function:
TemplateInvoker provides a default error callback, which we'll use here (otherwise you'd need to pass one when constructing the TemplateInvoker).
For the main callback, we'll define this helper struct:
The pybind11 wrapper for doSomething
is then another lambda that uses TemplateInvoker::apply
to call the helper:
The type returned by the helper callable's operator()
can be anything pybind11 knows how to convert to Python.
While defining a full struct with a templated operator()
makes it more obvious what TemplateInvoker is doing, it's much more concise to use a universal lambda with the decltype
operator. This wrapper is equivalent to the one above, but it doesn't need DoSomethingHelper
:
Note that the value of t
here doesn't matter; what's important is that its C++ type corresponds to the type passed in the dtype
argument. So instead of using that value, we use the decltype
operator to extract that type and use it as a template parameter.
Definition at line 106 of file TemplateInvoker.h.
using lsst::utils::python::TemplateInvoker::OnErrorCallback = std::function<pybind11::object(pybind11::dtype const & dtype)> |
Callback type for handling unmatched-type errors.
Definition at line 114 of file TemplateInvoker.h.
|
inlineexplicit |
Construct a TemplateInvoker that calls the given object when no match is found.
The callback should have the same signature as handleErrorDefault; the dtype actually passed from Python is passed so it can be included in error messages.
Definition at line 129 of file TemplateInvoker.h.
|
inline |
Construct a TemplateInvoker that calls handleErrorDefault when no match is found.
Definition at line 132 of file TemplateInvoker.h.
|
inline |
Call and return function(static_cast<T>(0))
with the type T that matches a given NumPy dtype
object.
[in] | function | Callable object to invoke. Must have an overloaded operator() that takes any T in the sequence TypesToTry , and a fail(py::dtype) method to handle the case where none of the given types match. |
[in] | dtype | NumPy dtype object indicating the template specialization to invoke. |
[in] | typesToTry | A Tag instance parameterized with the list of types to try to match to dtype . |
function
with the matching type, after converting it into a Python object.function
Definition at line 156 of file TemplateInvoker.h.
|
inlinestatic |
Callback used for handling unmatched-type errors by default.
Definition at line 117 of file TemplateInvoker.h.