copapy.clamp

copapy.clamp(x, min_value, max_value)

Clamp function to limit a value between a minimum and maximum.

Overloads:

• x (value[U]), min_value (U | value[U]), max_value (U | value[U]) → value[U]

• x (U | value[U]), min_value (value[U]), max_value (U | value[U]) → value[U]

• x (U | value[U]), min_value (U | value[U]), max_value (value[U]) → value[U]

• x (U), min_value (U), max_value (U) → U

• x (vector[U]), min_value (U | value[U]), max_value (U | value[U]) → vector[U]

• x (tensor[U]), min_value (U | value[U]), max_value (U | value[U]) → tensor[U]

• x (array[Any]), min_value (array[Any] | value[int] | value[float] | int | float), max_value (array[Any] | value[int] | value[float] | int | float) → array[Any]

The elements of a vector, tensor or array are clamped by array stencils for arrays and packed vectors or tensors. For x = nan the result is min_value.

Parameters:

• x (Any) – Input value, vector, tensor or array

• min_value (Any) – Minimum limit

• max_value (Any) – Maximum limit

Returns:

Clamped value of x