roll

paddle. roll ( x, shifts, axis=None, name=None ) [源代码]

沿着指定维度 axis 对输入 x 进行循环滚动，当元素移动到最后位置时，会从第一个位置重新插入。如果 axis 为 None，则输入在被循环滚动之前，会先展平成 1-D Tensor，滚动操作完成后恢复成原来的形状。

备注

别名支持: 参数名 input 可替代 x 和 dim 可替代 axis，如 input=tensor_x 等价于 x=tensor_x， dim=1 等价于 axis=1。

参数

  • x （Tensor）– 输入的 Tensor。 别名： input

  • shifts (int|list|tuple) - 滚动位移。如果 shifts 是一个元组或者列表，则 axis 必须是相同大小的元组或者列表，输入 Tensor 将依次沿着每个维度滚动相应的数值。

  • axis (int|list|tuple，可选) – 滚动轴。默认值为 None。 别名： dim

  • name (str，可选) - 具体用法请参见 api_guide_Name，一般无需设置，默认值为 None。

下图展示了一个形状为 [[1,2,3],[4,5,6],[7,8,9]] 的二维张量通过 roll 操作转变为形状不同的张量。

图例

  • 当 axis = None 时，张量会被展平成一维，然后进行循环滚动，再恢复原状

  • 当 axis=0 时，张量沿着 0 轴方向进行循环滚动

  • 当 axis=1 时，张量沿着 1 轴方向进行循环滚动

由于 axis 参数的取值不同，对应的滚动操作也不同，由图可以看到每个元素在不同滚动操作下的位置变化。

返回

  • Tensor，数据类型同输入。

代码示例

>>> import paddle
>>> x = paddle.to_tensor([[1.0, 2.0, 3.0],
...                       [4.0, 5.0, 6.0],
...                       [7.0, 8.0, 9.0]])
>>> out_z1 = paddle.roll(x, shifts=1)
>>> print(out_z1.numpy())
[[9. 1. 2.]
 [3. 4. 5.]
 [6. 7. 8.]]
>>> out_z2 = paddle.roll(x, shifts=1, axis=0)
>>> print(out_z2.numpy())
[[7. 8. 9.]
 [1. 2. 3.]
 [4. 5. 6.]]
>>> out_z3 = paddle.roll(x, shifts=1, axis=1)
>>> print(out_z3.numpy())
[[3. 1. 2.]
 [6. 4. 5.]
 [9. 7. 8.]]