LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
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... | |
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... | |
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... | |
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::cpputils::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.
using lsst::cpputils::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.
|
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.
|
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.
|
inlinestatic |
Callback used for handling unmatched-type errors by default.
Definition at line 117 of file TemplateInvoker.h.