File size: 18,727 Bytes
712dbf0 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 |
// Copyright © 2023-2024 Apple Inc.
#include <nanobind/nanobind.h>
#include <nanobind/stl/optional.h>
#include <nanobind/stl/variant.h>
#include <nanobind/stl/vector.h>
#include <numeric>
#include "mlx/fft.h"
#include "mlx/ops.h"
#include "python/src/small_vector.h"
namespace mx = mlx::core;
namespace nb = nanobind;
using namespace nb::literals;
void init_fft(nb::module_& parent_module) {
auto m = parent_module.def_submodule(
"fft", "mlx.core.fft: Fast Fourier Transforms.");
m.def(
"fft",
[](const mx::array& a,
const std::optional<int>& n,
int axis,
mx::StreamOrDevice s) {
if (n.has_value()) {
return mx::fft::fft(a, n.value(), axis, s);
} else {
return mx::fft::fft(a, axis, s);
}
},
"a"_a,
"n"_a = nb::none(),
"axis"_a = -1,
"stream"_a = nb::none(),
R"pbdoc(
One dimensional discrete Fourier Transform.
Args:
a (array): The input array.
n (int, optional): Size of the transformed axis. The
corresponding axis in the input is truncated or padded with
zeros to match ``n``. The default value is ``a.shape[axis]``.
axis (int, optional): Axis along which to perform the FFT. The
default is ``-1``.
Returns:
array: The DFT of the input along the given axis.
)pbdoc");
m.def(
"ifft",
[](const mx::array& a,
const std::optional<int>& n,
int axis,
mx::StreamOrDevice s) {
if (n.has_value()) {
return mx::fft::ifft(a, n.value(), axis, s);
} else {
return mx::fft::ifft(a, axis, s);
}
},
"a"_a,
"n"_a = nb::none(),
"axis"_a = -1,
"stream"_a = nb::none(),
R"pbdoc(
One dimensional inverse discrete Fourier Transform.
Args:
a (array): The input array.
n (int, optional): Size of the transformed axis. The
corresponding axis in the input is truncated or padded with
zeros to match ``n``. The default value is ``a.shape[axis]``.
axis (int, optional): Axis along which to perform the FFT. The
default is ``-1``.
Returns:
array: The inverse DFT of the input along the given axis.
)pbdoc");
m.def(
"fft2",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::fftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::fftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[fft2] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::fftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a.none() = std::vector<int>{-2, -1},
"stream"_a = nb::none(),
R"pbdoc(
Two dimensional discrete Fourier Transform.
Args:
a (array): The input array.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``[-2, -1]``.
Returns:
array: The DFT of the input along the given axes.
)pbdoc");
m.def(
"ifft2",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::ifftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::ifftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[ifft2] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::ifftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a.none() = std::vector<int>{-2, -1},
"stream"_a = nb::none(),
R"pbdoc(
Two dimensional inverse discrete Fourier Transform.
Args:
a (array): The input array.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``[-2, -1]``.
Returns:
array: The inverse DFT of the input along the given axes.
)pbdoc");
m.def(
"fftn",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::fftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::fftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[fftn] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::fftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a = nb::none(),
"stream"_a = nb::none(),
R"pbdoc(
n-dimensional discrete Fourier Transform.
Args:
a (array): The input array.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``None`` in which case the FFT is over the last
``len(s)`` axes are or all axes if ``s`` is also ``None``.
Returns:
array: The DFT of the input along the given axes.
)pbdoc");
m.def(
"ifftn",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::ifftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::ifftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[ifftn] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::ifftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a = nb::none(),
"stream"_a = nb::none(),
R"pbdoc(
n-dimensional inverse discrete Fourier Transform.
Args:
a (array): The input array.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``None`` in which case the FFT is over the last
``len(s)`` axes or all axes if ``s`` is also ``None``.
Returns:
array: The inverse DFT of the input along the given axes.
)pbdoc");
m.def(
"rfft",
[](const mx::array& a,
const std::optional<int>& n,
int axis,
mx::StreamOrDevice s) {
if (n.has_value()) {
return mx::fft::rfft(a, n.value(), axis, s);
} else {
return mx::fft::rfft(a, axis, s);
}
},
"a"_a,
"n"_a = nb::none(),
"axis"_a = -1,
"stream"_a = nb::none(),
R"pbdoc(
One dimensional discrete Fourier Transform on a real input.
The output has the same shape as the input except along ``axis`` in
which case it has size ``n // 2 + 1``.
Args:
a (array): The input array. If the array is complex it will be silently
cast to a real type.
n (int, optional): Size of the transformed axis. The
corresponding axis in the input is truncated or padded with
zeros to match ``n``. The default value is ``a.shape[axis]``.
axis (int, optional): Axis along which to perform the FFT. The
default is ``-1``.
Returns:
array: The DFT of the input along the given axis. The output
data type will be complex.
)pbdoc");
m.def(
"irfft",
[](const mx::array& a,
const std::optional<int>& n,
int axis,
mx::StreamOrDevice s) {
if (n.has_value()) {
return mx::fft::irfft(a, n.value(), axis, s);
} else {
return mx::fft::irfft(a, axis, s);
}
},
"a"_a,
"n"_a = nb::none(),
"axis"_a = -1,
"stream"_a = nb::none(),
R"pbdoc(
The inverse of :func:`rfft`.
The output has the same shape as the input except along ``axis`` in
which case it has size ``n``.
Args:
a (array): The input array.
n (int, optional): Size of the transformed axis. The
corresponding axis in the input is truncated or padded with
zeros to match ``n // 2 + 1``. The default value is
``a.shape[axis] // 2 + 1``.
axis (int, optional): Axis along which to perform the FFT. The
default is ``-1``.
Returns:
array: The real array containing the inverse of :func:`rfft`.
)pbdoc");
m.def(
"rfft2",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::rfftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::rfftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[rfft2] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::rfftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a.none() = std::vector<int>{-2, -1},
"stream"_a = nb::none(),
R"pbdoc(
Two dimensional real discrete Fourier Transform.
The output has the same shape as the input except along the dimensions in
``axes`` in which case it has sizes from ``s``. The last axis in ``axes`` is
treated as the real axis and will have size ``s[-1] // 2 + 1``.
Args:
a (array): The input array. If the array is complex it will be silently
cast to a real type.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``[-2, -1]``.
Returns:
array: The real DFT of the input along the given axes. The output
data type will be complex.
)pbdoc");
m.def(
"irfft2",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::irfftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::irfftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[irfft2] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::irfftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a.none() = std::vector<int>{-2, -1},
"stream"_a = nb::none(),
R"pbdoc(
The inverse of :func:`rfft2`.
Note the input is generally complex. The dimensions of the input
specified in ``axes`` are padded or truncated to match the sizes
from ``s``. The last axis in ``axes`` is treated as the real axis
and will have size ``s[-1] // 2 + 1``.
Args:
a (array): The input array.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s`` except for the last axis
which has size ``s[-1] // 2 + 1``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``[-2, -1]``.
Returns:
array: The real array containing the inverse of :func:`rfft2`.
)pbdoc");
m.def(
"rfftn",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::rfftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::rfftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[rfftn] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::rfftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a = nb::none(),
"stream"_a = nb::none(),
R"pbdoc(
n-dimensional real discrete Fourier Transform.
The output has the same shape as the input except along the dimensions in
``axes`` in which case it has sizes from ``s``. The last axis in ``axes`` is
treated as the real axis and will have size ``s[-1] // 2 + 1``.
Args:
a (array): The input array. If the array is complex it will be silently
cast to a real type.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``None`` in which case the FFT is over the last
``len(s)`` axes or all axes if ``s`` is also ``None``.
Returns:
array: The real DFT of the input along the given axes. The output
)pbdoc");
m.def(
"irfftn",
[](const mx::array& a,
const std::optional<mx::Shape>& n,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value() && n.has_value()) {
return mx::fft::irfftn(a, n.value(), axes.value(), s);
} else if (axes.has_value()) {
return mx::fft::irfftn(a, axes.value(), s);
} else if (n.has_value()) {
throw std::invalid_argument(
"[irfftn] `axes` should not be `None` if `s` is not `None`.");
} else {
return mx::fft::irfftn(a, s);
}
},
"a"_a,
"s"_a = nb::none(),
"axes"_a = nb::none(),
"stream"_a = nb::none(),
R"pbdoc(
The inverse of :func:`rfftn`.
Note the input is generally complex. The dimensions of the input
specified in ``axes`` are padded or truncated to match the sizes
from ``s``. The last axis in ``axes`` is treated as the real axis
and will have size ``s[-1] // 2 + 1``.
Args:
a (array): The input array.
s (list(int), optional): Sizes of the transformed axes. The
corresponding axes in the input are truncated or padded with
zeros to match the sizes in ``s``. The default value is the
sizes of ``a`` along ``axes``.
axes (list(int), optional): Axes along which to perform the FFT.
The default is ``None`` in which case the FFT is over the last
``len(s)`` axes or all axes if ``s`` is also ``None``.
Returns:
array: The real array containing the inverse of :func:`rfftn`.
)pbdoc");
m.def(
"fftshift",
[](const mx::array& a,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value()) {
return mx::fft::fftshift(a, axes.value(), s);
} else {
return mx::fft::fftshift(a, s);
}
},
"a"_a,
"axes"_a = nb::none(),
"stream"_a = nb::none(),
R"pbdoc(
Shift the zero-frequency component to the center of the spectrum.
Args:
a (array): The input array.
axes (list(int), optional): Axes over which to perform the shift.
If ``None``, shift all axes.
Returns:
array: The shifted array with the same shape as the input.
)pbdoc");
m.def(
"ifftshift",
[](const mx::array& a,
const std::optional<std::vector<int>>& axes,
mx::StreamOrDevice s) {
if (axes.has_value()) {
return mx::fft::ifftshift(a, axes.value(), s);
} else {
return mx::fft::ifftshift(a, s);
}
},
"a"_a,
"axes"_a = nb::none(),
"stream"_a = nb::none(),
R"pbdoc(
The inverse of :func:`fftshift`. While identical to :func:`fftshift` for even-length axes,
the behavior differs for odd-length axes.
Args:
a (array): The input array.
axes (list(int), optional): Axes over which to perform the inverse shift.
If ``None``, shift all axes.
Returns:
array: The inverse-shifted array with the same shape as the input.
)pbdoc");
}
|