decorators#

handle_0D_1D_input#

pyvbmc.decorators.handle_0D_1D_input(patched_kwargs: [], patched_argpos: [], return_scalar=False)[source]#

A decorator that handles 0D, 1D inputs and transforms them to 2D.

Parameters:
kwarglist of str

The names of the keyword arguments that should be handeled.

argposlist of int

The positions of the arguments that should be handeled.

return_scalarbool, optional

If the input is 1D the function should return a scalar, by default False.