You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Computes the one-dimensional discrete Fourier transform. The expected behavior includes a round-trip transform using the inverse function, `fft(ifft(a)) == a`.
20
+
Computes the one-dimensional discrete Fourier transform. The expected behavior includes a round-trip transform using the inverse function, `ifft(fft(a)) == a` within numerical accuracy.
21
21
22
22
#### Parameters
23
23
@@ -47,7 +47,7 @@ Computes the one-dimensional discrete Fourier transform. The expected behavior i
47
47
48
48
-**out**: _<array>_
49
49
50
-
-An array transformed along the axis indicated by the `axis` keyword.
50
+
-A complex-valued array transformed along the axis indicated by the `axis` keyword. The length along the transformed axis is `n//2+1`.
51
51
52
52
#### Raises
53
53
@@ -56,7 +56,7 @@ Computes the one-dimensional discrete Fourier transform. The expected behavior i
Computes the one-dimensional inverse discrete Fourier transform.
59
+
Computes the one-dimensional inverse discrete Fourier transform. The expected behavior includes a round-trip transform using the inverse function, `ifft(fft(a)) == a` within numerical accuracy.
Computes the n-dimensional discrete Fourier transform.
98
+
Computes the n-dimensional discrete Fourier transform. The expected behavior includes a round-trip transform using the inverse function, `ifftn(fftn(a)) == a` within numerical accuracy.
99
99
100
100
#### Parameters
101
101
@@ -105,7 +105,7 @@ Computes the n-dimensional discrete Fourier transform.
105
105
106
106
-**s**: _Union\[ Sequence\[ int ], Tuple\[ int, ... ]]_
107
107
108
-
- Size of each transformed axis of the output. If given, each axis will be either zero-padded or trimmed to the length `s[i]` before computing the Fourier transform. Otherwise, the length of the input along the axis given by the `axes` keyword. Default: `None`.
108
+
- Size of each transformed axis of the output. If given, each axis `i`will be either zero-padded or trimmed to the length `s[i]` before computing the Fourier transform. Otherwise, the shape of the input along the axes given by the `axes` keyword. Default: `None`.
109
109
110
110
-**axes**: _Union\[ Sequence\[ int ], Tuple\[ int, ... ]]_
111
111
@@ -130,12 +130,12 @@ Computes the n-dimensional discrete Fourier transform.
130
130
#### Raises
131
131
132
132
- If `s` and `axes` have different lengths.
133
-
- If an element of `axes`is larger than the number of axes of `a`.
Computes the n-dimensional inverse discrete Fourier transform.
138
+
Computes the n-dimensional inverse discrete Fourier transform. The expected behavior includes a round-trip transform using the inverse function, `ifftn(fftn(a)) == a` within numerical accuracy.
Computes the one-dimensional discrete Fourier transform for real-valued input.
178
+
Computes the one-dimensional discrete Fourier transform for real-valued input. The expected behavior includes a round-trip transform using the inverse function, `irfft(rfft(a), n=a.shape[axis]) == a` within numerical accuracy.
179
179
180
180
#### Parameters
181
181
@@ -185,7 +185,7 @@ Computes the one-dimensional discrete Fourier transform for real-valued input.
185
185
186
186
-**n**: _int_
187
187
188
-
- Length of the input array. If given, the input will be either zero-padded or trimmed to this length before computing the real Fourier transform. Otherwise, the length of the input along the axis specified by the `axis` keyword is used. Default: `None`.
188
+
- Length of the transformed axis of the *input*. If given, the input will be either zero-padded or trimmed to this length before computing the real Fourier transform. Otherwise, the length of the input along the axis specified by the `axis` keyword is used. Default: `None`.
189
189
190
190
-**axis**: _int_
191
191
@@ -205,7 +205,7 @@ Computes the one-dimensional discrete Fourier transform for real-valued input.
205
205
206
206
-**out**: _<array>_
207
207
208
-
-An array transformed along the axis indicated by the `axis` keyword.
208
+
-A complex-valued array transformed along the axis indicated by the `axis` keyword. The length along the transformed axis is `n//2+1`.
209
209
210
210
#### Raises
211
211
@@ -214,7 +214,7 @@ Computes the one-dimensional discrete Fourier transform for real-valued input.
Computes the one-dimensional inverse discrete Fourier transform for real-valued input.
217
+
Computes the one-dimensional inverse of `rfft`. The expected behavior includes a round-trip transform using the inverse function, `irfft(rfft(a), n=a.shape[axis]) == a` within numerical accuracy.
218
218
219
219
#### Parameters
220
220
@@ -224,7 +224,7 @@ Computes the one-dimensional inverse discrete Fourier transform for real-valued
224
224
225
225
-**n**: _int_
226
226
227
-
- Length of the transformed axis of the output. If given, the input will be either zero-padded or trimmed to this length before computing the real Fourier transform. Otherwise, it will default to `2 * (m - 1)` where `m` is the length of the input along the axis given by the `axis` keyword. Default: `None`.
227
+
- Length of the transformed axis of the *output*. If given, the input will be either zero-padded or trimmed to `n//2+1`before computing the inverse of `rfft`. Otherwise, it will default to `2 * (m - 1)` where `m` is the length of the input along the axis given by the `axis` keyword. Default: `None`.
228
228
229
229
-**axis**: _int_
230
230
@@ -244,7 +244,7 @@ Computes the one-dimensional inverse discrete Fourier transform for real-valued
244
244
245
245
-**out**: _<array>_
246
246
247
-
-An array transformed along the axis indicated by the `axis` keyword.
247
+
-A real-valued array transformed along the axis indicated by the `axis` keyword. The length along the transformed axis is `n` (if given) or `2 * (m - 1)`.
248
248
249
249
#### Raises
250
250
@@ -253,7 +253,7 @@ Computes the one-dimensional inverse discrete Fourier transform for real-valued
Computes the n-dimensional discrete Fourier transform for real-valued input.
256
+
Computes the n-dimensional discrete Fourier transform for real-valued input. The expected behavior includes a round-trip transform using the inverse function, `irfftn(rfftn(a), s=a.shape) == a` within numerical accuracy.
257
257
258
258
#### Parameters
259
259
@@ -263,7 +263,7 @@ Computes the n-dimensional discrete Fourier transform for real-valued input.
263
263
264
264
-**s**: _Union\[ Sequence\[ int ], Tuple\[ int, ... ]]_
265
265
266
-
- Size of each transformed axis of the output. If given, each axis will be either zero-padded or trimmed to the length `s[i]` before computing the real Fourier transform. Otherwise, no padding will be performed in each dimension. Default: `None`.
266
+
- Size of each transformed axis of the output. If given, each axis `i`will be either zero-padded or trimmed to the length `s[i]` before computing the real Fourier transform. Otherwise, the shape of the input along the axes given by the `axes` keyword. The last element `s[-1]` is for computing `rfft(a[axes[-1]], n=s[-1])` whereas other elements for `fft(a[axes[i]], n=s[i])`. Default: `None`.
267
267
268
268
-**axes**: _Union\[ Sequence\[ int ], Tuple\[ int, ... ]]_
269
269
@@ -283,17 +283,17 @@ Computes the n-dimensional discrete Fourier transform for real-valued input.
283
283
284
284
-**out**: _<array>_
285
285
286
-
-An array transformed along the axes indicated by the `axes` keyword.
286
+
-A complex-valued array transformed along the axes indicated by the `axes` keyword. The length along the last transformed axis is `s[-1]//2+1` and along other axes `s[i]`.
287
287
288
288
#### Raises
289
289
290
290
- If `s` and `axes` have different lengths.
291
-
- If an element of `axes`is larger than the number of axes of `a`.
Computes the n-dimensional inverse discrete Fourier transform for real-valued input.
296
+
Computes the n-dimensional inverse of `rfftn`. The expected behavior includes a round-trip transform using the inverse function, `irfftn(rfftn(a), s=a.shape) == a` within numerical accuracy.
297
297
298
298
#### Parameters
299
299
@@ -303,7 +303,7 @@ Computes the n-dimensional inverse discrete Fourier transform for real-valued in
303
303
304
304
-**s**: _Union\[ Sequence\[ int ], Tuple\[ int, ... ]]_
305
305
306
-
- Size of each transformed axis of the output. If given, each axis will be either zero-padded or trimmed to the length `s[i]` before computing the Fourier transform. Otherwise, no padding will be performed in each dimension. Default: `None`.
306
+
- Size of each transformed axis of the *output*. If given, the last axis will be either zero-padded or trimmed to `s[-1]//2+1`, whereas all other axes `i` are either zero-padded or trimmed to the length `s[i]`, before computing the inverse of `rfftn`. Otherwise, the last axis is either zero-padded or trimmed to `2 * (m - 1)`, where `m` is the length of the input along the axis, and all other axes use the input shape. The last element `s[-1]` is for computing `irfft(a[axes[-1]], n=s[-1])` whereas other elements for `ifft(a[axes[i]], n=s[i])`. Default: `None`.
307
307
308
308
-**axes**: _Union\[ Sequence\[ int ], Tuple\[ int, ... ]]_
309
309
@@ -323,12 +323,12 @@ Computes the n-dimensional inverse discrete Fourier transform for real-valued in
323
323
324
324
-**out**: _<array>_
325
325
326
-
-An array transformed along the axes indicated by the `axes` keyword.
326
+
-A real-valued array transformed along the axes indicated by the `axes` keyword. The length along the last transformed axis is `s[-1]` (if given) or `2 * (m - 1)`, and all other axes `s[i]`.
327
327
328
328
#### Raises
329
329
330
330
- If `s` and `axes` have different lengths.
331
-
- If an element of `axes`is larger than the number of axes of `a`.
0 commit comments