mindspore.ops.clamp

mindspore.ops.clamp(input, min=None, max=None)

将输入Tensor的值裁剪到指定的最小值和最大值之间。

限制 \(input\) 的范围，其最小值为 min ，最大值为 max 。

\[\begin{split}out_i= \left\{ \begin{array}{align} max & \text{ if } input_i\ge max \\ input_i & \text{ if } min \lt input_i \lt max \\ min & \text{ if } input_i \le min \\ \end{array}\right.\end{split}\]

说明

• min 和 max 不能同时为None；

• 当 min 为None，max 不为None时，Tensor中大于 max 的元素会变为 max；

• 当 min 不为None，max 为None时，Tensor中小于 min 的元素会变为 min；

• 当 min 大于 max 时，Tensor中所有元素的值会被置为 max；

• input，min 和 max 的数据类型需支持隐式类型转换，且不能为布尔型。

参数：

• input (Union(Tensor, list[Tensor], tuple[Tensor])) - clamp 的输入，类型为Tensor、Tensor的列表或元组。支持任意维度的Tensor。

• min (Union(Tensor, float, int)，可选) - 指定最小值。默认值为 None 。

• max (Union(Tensor, float, int)，可选) - 指定最大值。默认值为 None 。

返回：

Tensor、Tensor的列表或元组，表示裁剪后的Tensor。其shape和数据类型和 input 相同。

异常：

• ValueError - 如果 min 和 max 都为None。

• TypeError - 如果 input 的数据类型不在Tensor、list[Tensor]或tuple[Tensor]中。

• TypeError - 如果 min 的数据类型不为None、Tensor、float或int。

• TypeError - 如果 max 的数据类型不为None、Tensor、float或int。

支持平台：

Ascend GPU CPU

样例：

>>> # case 1: the data type of input is Tensor
>>> import mindspore
>>> from mindspore import Tensor, ops
>>> import numpy as np
>>> min_value = Tensor(5, mindspore.float32)
>>> max_value = Tensor(20, mindspore.float32)
>>> input = Tensor(np.array([[1., 25., 5., 7.], [4., 11., 6., 21.]]), mindspore.float32)
>>> output = ops.clamp(input, min_value, max_value)
>>> print(output)
[[ 5. 20.  5.  7.]
 [ 5. 11.  6. 20.]]
>>> # case 2: the data type of input is list[Tensor]
>>> min_value = 5
>>> max_value = 20
>>> input_x = Tensor(np.array([[1., 25., 5., 7.], [4., 11., 6., 21.]]), mindspore.float32)
>>> input_y = Tensor(np.array([[1., 25., 5., 7.], [4., 11., 6., 21.]]), mindspore.float32)
>>> output = ops.clamp([input_x,input_y], min_value, max_value)
>>> for out in output:
...     print(out)
[[ 5. 20.  5.  7.]
 [ 5. 11.  6. 20.]]
[[ 5. 20.  5.  7.]
 [ 5. 11.  6. 20.]]