Update FFT warning doc format
@@ -703,7 +703,6 @@ def irfft(a, n=None, axis=-1, norm=None):
Args:
a (cupy.ndarray): Array to be transform.
- WARNING: May be modified in CUDA 10.1 and above.
n (None or int): Length of the transformed axis of the output. For
``n`` output points, ``n//2+1`` input points are necessary. If
``n`` is not given, it is determined from the length of the input
@@ -718,6 +717,8 @@ def irfft(a, n=None, axis=-1, norm=None):
given, the length of the transformed axis is`2*(m-1)` where `m`
is the length of the transformed axis of the input.
+ .. warning:: The input array may be modified in CUDA 10.1 and above.
+
.. seealso:: :func:`numpy.fft.irfft`
"""
return _fft(a, (n,), (axis,), norm, cufft.CUFFT_INVERSE, 'C2R')
@@ -751,7 +752,6 @@ def irfft2(a, s=None, axes=(-2, -1), norm=None):
Args:
a (cupy.ndarray): Array to be transform.
- WARNING: May be modified in CUDA 10.1 and above.
s (None or tuple of ints): Shape of the output. If ``s`` is not given,
they are determined from the lengths of the input along the axes
specified by ``axes``.
@@ -766,6 +766,8 @@ def irfft2(a, s=None, axes=(-2, -1), norm=None):
`2*(m-1)` where `m` is the length of the final transformed axis of
the input.
+ .. warning:: The input array may be modified in CUDA 10.1 and above.
+
.. seealso:: :func:`numpy.fft.irfft2`
"""
func = _default_fft_func(a, s, axes, value_type='C2R')
@@ -823,6 +825,8 @@ def irfftn(a, s=None, axes=None, norm=None):
``2*(m-1)`` where `m` is the length of the final transformed axis
of the input.
+ .. warning:: The input array may be modified in CUDA 10.1 and above.
+
.. seealso:: :func:`numpy.fft.irfftn`
"""
if (10020 >= cupy.cuda.runtime.runtimeGetVersion() >= 10010
