Ctrl+K

jax.numpy.piecewise

Contents

jax.numpy.piecewise#

jax.numpy.piecewise(x, condlist, funclist, *args, **kw)[source]#

Evaluate a piecewise-defined function.

LAX-backend implementation of numpy.piecewise().

Unlike np.piecewise, jax.numpy.piecewise() requires functions in funclist to be traceable by JAX, as it is implemented via jax.lax.switch(). See the jax.lax.switch() documentation for more information.

Original docstring below.

Given a set of conditions and corresponding functions, evaluate each function on the input data wherever its condition is true.

Parameters:

  • x (ndarray or scalar) – The input domain.

  • condlist (list of bool arrays or bool scalars) –

    Each boolean array corresponds to a function in funclist. Wherever condlist[i] is True, funclist[i](x) is used as the output value.

    Each boolean array in condlist selects a piece of x, and should therefore be of the same shape as x.

    The length of condlist must correspond to that of funclist. If one extra function is given, i.e. if len(funclist) == len(condlist) + 1, then that extra function is the default value, used wherever all conditions are false.

  • funclist (list of callables, f(x,*args,**kw), or scalars) – Each function is evaluated over x wherever its corresponding condition is True. It should take a 1d array as input and give an 1d array or a scalar value as output. If, instead of a callable, a scalar is provided then a constant function (lambda x: scalar) is assumed.

  • args (tuple, optional) – Any further arguments given to piecewise are passed to the functions upon execution, i.e., if called piecewise(..., ..., 1, 'a'), then each function is called as f(x, 1, 'a').

  • kw (dict, optional) – Keyword arguments used in calling piecewise are passed to the functions upon execution, i.e., if called piecewise(..., ..., alpha=1), then each function is called as f(x, alpha=1).

Returns:

out – The output is the same shape and type as x and is found by calling the functions in funclist on the appropriate portions of x, as defined by the boolean arrays in condlist. Portions not covered by any condition have a default value of 0.

Return type:

ndarray

Contents