【Hackathon 5th No.34】为 Paddle 新增 bitwise_right_shift / bitwise_right_shift_ / bitwise_left_shift / bitwise_left_shift_ API 中文文档

docs/api/paddle/Overview_cn.rst

@@ -88,6 +88,8 @@ tensor 数学操作
     " :ref:`paddle.bitwise_not <cn_api_paddle_bitwise_not>` ", "逐元素的对 X Tensor 进行按位取反运算"
     " :ref:`paddle.bitwise_or <cn_api_paddle_bitwise_or>` ", "逐元素的对 X 和 Y 进行按位或运算"
     " :ref:`paddle.bitwise_xor <cn_api_paddle_bitwise_xor>` ", "逐元素的对 X 和 Y 进行按位异或运算"
+    " :ref:`paddle.bitwise_left_shift <cn_api_paddle_bitwise_left_shift>` ", "逐元素的对 X 和 Y 进行按位算术(或逻辑)左移"
+    " :ref:`paddle.bitwise_right_shift <cn_api_paddle_bitwise_right_shift>` ", "逐元素的对 X 和 Y 进行按位算术(或逻辑)右移"
     " :ref:`paddle.logsumexp <cn_api_paddle_logsumexp>` ", "沿着 axis 计算 x 的以 e 为底的指数的和的自然对数"
     " :ref:`paddle.max <cn_api_paddle_max>` ", "对指定维度上的 Tensor 元素求最大值运算"
     " :ref:`paddle.amax <cn_api_paddle_max>` ", "对指定维度上的 Tensor 元素求最大值运算"
@@ -198,6 +200,8 @@ tensor 数学操作原位（inplace）版本
     " :ref:`paddle.masked_fill_ <cn_api_paddle_masked_fill_>` ", "Inplace 版本的 masked_fill API，对输入 x 采用 Inplace 策略"
     " :ref:`paddle.masked_scatter_ <cn_api_paddle_masked_scatter_>` ", "Inplace 版本的 masked_scatter API，对输入 x 采用 Inplace 策略"
     " :ref:`paddle.index_fill_ <cn_api_paddle_index_fill_>` ", "Inplace 版本的 index_fill API，对输入 x 采用 Inplace 策略"
+    " :ref:`paddle.bitwise_left_shift_ <cn_api_paddle_bitwise_left_shift_>` ", "Inplace 版本的 bitwise_left_shift API，对输入 x 采用 Inplace 策略"
+    " :ref:`paddle.bitwise_right_shift_ <cn_api_paddle_bitwise_right_shift_>` ", "Inplace 版本的 bitwise_right_shift API，对输入 x 采用 Inplace 策略"
     " :ref:`paddle.sin_ <cn_api_paddle_sin_>` ", "Inplace 版本的 sin API，对输入 x 采用 Inplace 策略"
 
 .. _tensor_logic:

docs/api/paddle/bitwise_left_shift__cn.rst

@@ -0,0 +1,12 @@
+.. _cn_api_paddle_bitwise_left_shift_:
+
+bitwise_left_shift\_
+-------------------------------
+
+.. py:function:: paddle.bitwise_left_shift_(x, y, is_arithmetic=True, out=None, name=None)
+
+Inplace 版本的 :ref:`cn_api_paddle_bitwise_left_shift` API，对输入 `x` 采用 Inplace 策略。
+
+更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。
+
+.. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/bitwise_left_shift_cn.rst

@@ -0,0 +1,74 @@
+.. _cn_api_paddle_bitwise_left_shift:
+
+bitwise_left_shift
+-------------------------------
+
+.. py:function:: paddle.bitwise_left_shift(x, y, is_arithmetic=True, out=None, name=None)
+
+对 Tensor ``x`` 和 ``y`` 逐元素进行 ``按位算术(或逻辑)左移`` 运算。
+
+关于 **有符号数的符号位** 在不同情景下的行为：
+  1. 算术左移时，符号位同其他位一样，一起左移，右边补 0；
+  2. 逻辑左移时，符号位同其他位一样，一起左移，右边补 0；
+  3. 算术右移时，符号位同其他位一样，一起右移，左边补符号位；
+  4. 逻辑右移时，符号位同其他位一样，一起右移，左边补 0；
+
+.. note::
+    当有符号数左移发生溢出时，其值不可控，可能会在左移时突然变号，这是因为在左移时，有符号数的符号位同样进行左移，会导致符号位右侧的值不断成为符号位，例如
+
+    example1:
+
+    .. code-block:: text
+
+        int8_t x = -45; // 补码为 1101,0011      表示-45
+
+        int8_t y = x << 2;   //补码为 0100,1100  表示 76
+
+        int8_t z = x << 3;   //补码为 1001,1000  表示-104
+
+    example2:
+
+    .. code-block:: text
+
+        int8_t x = -86; // 补码为 1010,1010      表示-86
+
+        int8_t y = x << 1;   //补码为 0101,0100  表示 84
+
+        int8_t z = x << 2;   //补码为 1010,1000  表示-88
+
+    以上为溢出导致的符号突变。
+
+.. math::
+        Out = X \ll Y
+
+.. note::
+    ``paddle.bitwise_left_shift`` 遵守 broadcasting，如您想了解更多，请参见 `Tensor 介绍`_ .
+
+    .. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
+参数
+::::::::::::
+
+        - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：uint8，int8，int16，int32，int64。
+        - **y** （Tensor）- 输入的 N-D `Tensor`，数据类型为：uint8，int8，int16，int32，int64。
+        - **is_arithmetic** （bool） - 用于表明是否执行算术位移，True 表示算术位移，False 表示逻辑位移。默认值为 True，表示算术位移。
+        - **out** （Tensor，可选）- 输出的结果 `Tensor`，是与输入数据类型相同的 N-D `Tensor`。默认值为 None，此时将创建新的 Tensor 来保存输出结果。
+        - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+
+返回
+::::::::::::
+ ``按位算术(逻辑)左移`` 运算后的结果 ``Tensor``，数据类型与 ``x`` 相同。
+
+代码示例 1
+::::::::::::
+
+算术左移
+
+COPY-FROM: paddle.bitwise_left_shift:bitwise_left_shift_example1
+
+代码示例 2
+::::::::::::
+
+逻辑左移
+
+COPY-FROM: paddle.bitwise_left_shift:bitwise_left_shift_example2

docs/api/paddle/bitwise_right_shift__cn.rst

@@ -0,0 +1,12 @@
+.. _cn_api_paddle_bitwise_right_shift_:
+
+bitwise_right_shift\_
+-------------------------------
+
+.. py:function:: paddle.bitwise_right_shift_(x, y, is_arithmetic=True, out=None, name=None)
+
+Inplace 版本的 :ref:`cn_api_paddle_bitwise_right_shift` API，对输入 `x` 采用 Inplace 策略。
+
+更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。
+
+.. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/bitwise_right_shift_cn.rst

@@ -0,0 +1,42 @@
+.. _cn_api_paddle_bitwise_right_shift:
+
+bitwise_right_shift
+-------------------------------
+
+.. py:function:: paddle.bitwise_right_shift(x, y, is_arithmetic=True, out=None, name=None)
+
+对 Tensor ``x`` 和 ``y`` 逐元素进行 ``按位算术(或逻辑)右移`` 运算。
+
+.. math::
+        Out = X \gg Y
+
+.. note::
+    ``paddle.bitwise_right_shift`` 遵守 broadcasting，如您想了解更多，请参见 `Tensor 介绍`_ .
+
+    .. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
+参数
+::::::::::::
+
+        - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：uint8，int8，int16，int32，int64。
+        - **y** （Tensor）- 输入的 N-D `Tensor`，数据类型为：uint8，int8，int16，int32，int64。
+        - **is_arithmetic** （bool） - 用于表明是否执行算术位移，True 表示算术位移，False 表示逻辑位移。默认值为 True，表示算术位移。
+        - **out** （Tensor，可选）- 输出的结果 `Tensor`，是与输入数据类型相同的 N-D `Tensor`。默认值为 None，此时将创建新的 Tensor 来保存输出结果。
+        - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+返回
+::::::::::::
+ ``按位算术(逻辑)右移`` 运算后的结果 ``Tensor``，数据类型与 ``x`` 相同。
+
+代码示例 1
+::::::::::::
+
+算术右移
+
+COPY-FROM: paddle.bitwise_right_shift:bitwise_right_shift_example1
+
+代码示例 2
+::::::::::::
+
+逻辑右移
+
+COPY-FROM: paddle.bitwise_right_shift:bitwise_right_shift_example2