jax.numpy.clip

Contents

jax.numpy.clip#

jax.numpy.clip(x=None, /, min=None, max=None, *, a=Deprecated, a_min=Deprecated, a_max=Deprecated)[source]#

Clip (limit) the values in an array.

LAX-backend implementation of numpy.clip().

Original docstring below.

Given an interval, values outside the interval are clipped to the interval edges. For example, if an interval of [0, 1] is specified, values smaller than 0 become 0, and values larger than 1 become 1.

Equivalent to but faster than np.minimum(a_max, np.maximum(a, a_min)).

No check is performed to ensure a_min < a_max.

Parameters:
  • x (array_like) – Array containing elements to clip.

  • min (array_like, optional) – Minimum value. If None, clipping is not performed on the corresponding edge. The value of min is broadcast against x.

  • max (array_like, optional) – Maximum value. If None, clipping is not performed on the corresponding edge. The value of max is broadcast against x.

  • a (ArrayLike | DeprecatedArg) –

  • a_min (ArrayLike | None | DeprecatedArg) –

  • a_max (ArrayLike | None | DeprecatedArg) –

Returns:

clipped_array – An array with the elements of a, but where values < a_min are replaced with a_min, and those > a_max with a_max.

Return type:

ndarray