diff --git a/docs/api/paddle/fft/hfft_cn.rst b/docs/api/paddle/fft/hfft_cn.rst index 275b148b846..cba179c8622 100644 --- a/docs/api/paddle/fft/hfft_cn.rst +++ b/docs/api/paddle/fft/hfft_cn.rst @@ -13,14 +13,9 @@ hfft ::::::::: - **x** (Tensor) - 输入数据,其数据类型为复数。 -- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为 - ``n//2+1``,如果输入 Tensor 的长度大于 ``n//2+1``,输入 Tensor 会被截断。如果输入 - Tensor 的长度小于 ``n//2+1``,则输入 Tensor 会被补零。如果 ``n`` 没有被指定,则取 - ``2*(m-1)``,其中,``m`` 是输入 Tensor 在 ``axis`` 维的长度。 +- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为 ``n//2+1``,如果输入 Tensor 的长度大于 ``n//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``n//2+1``,则输入 Tensor 会被补零。如果 ``n`` 没有被指定,则取 ``2*(m-1)``,其中, ``m`` 是输入 Tensor 在 ``axis`` 维的长度。 - **axis** (int,可选) - 傅里叶变换的轴。如果没有指定,默认是使用最后一维。 -- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取 - 值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对 - 应的行为如下: +- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对应的行为如下: - "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n``; - "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1``; @@ -31,9 +26,7 @@ hfft 返回 ::::::::: -Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输 -出。如果指定 n,则输出 Tensor 在傅立叶变换轴的长度为 n,否则为 ``2*(m-1)``,其中``m`` -是输入 Tensor 在 ``axis`` 维的长度。 +Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输出。如果指定 ``n`` ,则输出 Tensor 在傅立叶变换轴的长度为 ``n`` ,否则为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在 ``axis`` 维的长度。 代码示例 ::::::::: diff --git a/docs/api/paddle/fft/irfft_cn.rst b/docs/api/paddle/fft/irfft_cn.rst index d4193356421..d2e21a648e8 100644 --- a/docs/api/paddle/fft/irfft_cn.rst +++ b/docs/api/paddle/fft/irfft_cn.rst @@ -13,27 +13,20 @@ irfft ::::::::: - **x** (Tensor) - 输入数据,其数据类型为复数。 -- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为 - ``n//2+1``,如果输入 Tensor 的长度大于 ``n//2+1``,输入 Tensor 会被截断。如果输入 - Tensor 的长度小于 ``n//2+1``,则输入 Tensor 会被补零。如果 ``n`` - 没有被指定,则取 ``2*(m-1)``,其中,``m`` 是输入 Tensor 在 ``axis`` 维的长度。 +- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为 ``n//2+1`` ,如果输入 Tensor 的长度大于 ``n//2+1`` ,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``n//2+1`` ,则输入 Tensor 会被补零。如果 ``n`` 没有被指定,则取 ``2*(m-1)`` ,其中, ``m`` 是输入 Tensor 在 ``axis`` 维的长度。 - **axis** (int,可选) - 傅里叶变换的轴。如果没有指定,默认是使用最后一维。 -- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取 - 值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对 - 应的行为如下: +- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对应的行为如下: - - "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n``; - - "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1``; - - "ortho":正向和逆向变换的缩放系数均为 ``1/sqrt(n)``; + - "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n`` ; + - "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1`` ; + - "ortho":正向和逆向变换的缩放系数均为 ``1/sqrt(n)`` ; - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 返回 ::::::::: -Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输 -出。如果指定 n,则输出 Tensor 在傅立叶变换轴的长度为 n,否则为 ``2*(m-1)``,其中``m`` -是输入 Tensor 在 ``axis`` 维的长度。 +Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输出。如果指定 ``n`` ,则输出 Tensor 在傅立叶变换轴的长度为 ``n`` ,否则为 ``2*(m-1)`` ,其中 ``m`` 是输入 Tensor 在 ``axis`` 维的长度。 代码示例 ::::::::: diff --git a/docs/api/paddle/fft/irfftn_cn.rst b/docs/api/paddle/fft/irfftn_cn.rst index 0774e649a3f..185a067b01b 100644 --- a/docs/api/paddle/fft/irfftn_cn.rst +++ b/docs/api/paddle/fft/irfftn_cn.rst @@ -8,25 +8,20 @@ irfftn 通过快速傅里叶变换(FFT)算法计算 N 维实数傅里叶变换 (rfftn)的逆变换。 该函数通过快速傅立叶变换(FFT)计算 M-D 矩阵中任意轴上实输入的 N-D 离散傅立叶变换的逆。即,在计算精度内 ``irfftn(rfftn(x), x.shape) == x`` 成立。( ``x.shape`` 的信息是必要的,其存在原因与 `irfft` 中的 ``len(x)`` 相同)。 - -此函数输入的排序方式应与 rfftn 返回的方式相同。 +此函数输入的排序方式应与 `irfft` 返回的方式相同。 参数 ::::::::: - **x** (Tensor) - 输入数据,其数据类型为复数。 -- **s** (Sequence[int],可选) - 输出 Tensor 在每一个傅里叶变换轴上的长度(类似一维傅里 - 叶变换中的参数 ``n``)。 +- **s** (Sequence[int],可选) - 输出 Tensor 在每一个傅里叶变换轴上的长度(类似一维傅里叶变换中的参数 ``n``)。 - - 对于傅里叶变换的最后一个轴,输入长度要求是 ``s[-1]//2+1``,如果输入 Tensor 的长度大于``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``,则输入 Tensor 会被补零; + - 对于傅里叶变换的最后一个轴,输入长度要求是 ``s[-1]//2+1``,如果输入 Tensor 的长度大于 ``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``,则输入 Tensor 会被补零; - 对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零; - 如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。 -- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最后 - ``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。 -- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取 - 值必须是 "forward","backward","ortho"之一,默认值为 "backward"。三种缩放模式对应的 - 行为如下: +- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最后 ``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。 +- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取值必须是 "forward","backward","ortho"之一,默认值为 "backward"。三种缩放模式对应的行为如下: - "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n``; - "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1``;