LSST Applications 24.1.5,g02d81e74bb+fa3a7a026e,g180d380827+a53a32eff8,g2079a07aa2+86d27d4dc4,g2305ad1205+c0501b3732,g295015adf3+7d3e92f0ec,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g33d1c0ed96+0e5473021a,g3a166c0a6a+0e5473021a,g3ddfee87b4+5dd1654d75,g48712c4677+3bf1020dcb,g487adcacf7+065c13d9cf,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+d7ac436cfb,g5a732f18d5+53520f316c,g64a986408d+fa3a7a026e,g858d7b2824+fa3a7a026e,g8a8a8dda67+585e252eca,g99cad8db69+a5a909b84f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+4cf350ccb2,gb0e22166c9+60f28cb32d,gba4ed39666+c2a2e4ac27,gbb8dafda3b+f991a0b59f,gc120e1dc64+9ccbfdb8be,gc28159a63d+0e5473021a,gcf0d15dbbd+5dd1654d75,gd96a1ce819+42fd0ee607,gdaeeff99f8+f9a426f77a,ge6526c86ff+0d71447b4b,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gff1a9f87cc+fa3a7a026e
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.