LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
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. | |
using | OnErrorCallback = std::function<pybind11::object(pybind11::dtype const & dtype)> |
Callback type for handling unmatched-type errors. | |
Public Member Functions | |
TemplateInvoker (OnErrorCallback onError) | |
Construct a TemplateInvoker that calls the given object when no match is found. | |
TemplateInvoker () | |
Construct a TemplateInvoker that calls handleErrorDefault when no match is found. | |
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. | |
TemplateInvoker (OnErrorCallback onError) | |
Construct a TemplateInvoker that calls the given object when no match is found. | |
TemplateInvoker () | |
Construct a TemplateInvoker that calls handleErrorDefault when no match is found. | |
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. | |
Static Public Member Functions | |
static pybind11::object | handleErrorDefault (pybind11::dtype const &dtype) |
Callback used for handling unmatched-type errors by default. | |
static pybind11::object | handleErrorDefault (pybind11::dtype const &dtype) |
Callback used for handling unmatched-type errors by default. | |
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.