Revisit usage of overwrite_x parameter
#185
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vtavana
force-pushed
the
revisit_overwrite_x
branch
2 times, most recently
from
13c6fa0 to
99dfd9d
Compare
vtavana
requested review from
ndgrigorian,
antonwolfy,
xaleryb and
ekomarova
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR removes the deprecated overwrite_x parameter, drops the old scipy.fftpack interface, and switches all internal and user-facing calls to use the new out keyword; it also fixes a bug when both s and out are provided for N-D FFTs.
- Remove entire
scipy.fftpackinterface and its tests - Replace
overwrite_xwithoutin all APIs, implementations, and tests - Add new tests covering the
outparameter and update documentation and changelog
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mkl_fft/tests/test_fftnd.py | Removed overwrite_x, swapped call order, and added out tests |
| mkl_fft/tests/test_fft1d.py | Replaced in-place overwrite_x tests with out, removed old pack tests |
| mkl_fft/interfaces/_scipy_fftpack.py | Dropped legacy scipy.fftpack wrapper |
| mkl_fft/interfaces/_scipy_fft.py | Added helper to translate overwrite_x into out, updated calls |
| mkl_fft/_mkl_fft.py | Removed overwrite_x from public FFT function signatures |
| mkl_fft/_fft_utils.py | Refactored internal loops to use out and dropped overwrite_x |
| mkl_fft/init.py | Removed rfftpack/irfftpack exports |
| README.md | Updated signatures to remove overwrite_x |
| CHANGELOG.md | Documented dropped support and bug fix related to out |
Files not reviewed (1)
- mkl_fft/_pydfti.pyx: Language not supported
vtavana
force-pushed
the
revisit_overwrite_x
branch
2 times, most recently
from
9fe528b to
0040c94
Compare
vtavana
force-pushed
the
revisit_overwrite_x
branch
2 times, most recently
from
31e17ab to
eadecd3
Compare
vtavana
force-pushed
the
revisit_overwrite_x
branch
from
eadecd3 to
12677c0
Compare
ndgrigorian
reviewed
Jun 16, 2025
Co-authored-by: ndgrigorian <46709016+ndgrigorian@users.noreply.github.com>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
scipy.fftpackis deprecated and with the following changesmkl_fftinterface forscipy.fftpackstops working properly therefore the support forscipy.fftpackis dropped.With introducing
outkwarg in add support foroutkeyword #157, havingoverwrite_xkwarg becomes redundant therefore it is removed andmkl_fft.interfaces.scipy_fftis appropriately adjusted for this change.mkl_fftincludes a bug similar to what explained here in NumPy which is resolved in this PR.