Skip to content

Revisit usage of overwrite_x parameter #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

vtavana
Copy link
Collaborator

@vtavana vtavana commented May 15, 2025

  1. scipy.fftpack is deprecated and with the following changes mkl_fft interface for scipy.fftpack stops working properly therefore the support for scipy.fftpack is dropped.

  2. With introducing out kwarg in add support for out keyword #157, having overwrite_x kwarg becomes redundant therefore it is removed and mkl_fft.interfaces.scipy_fft is appropriately adjusted for this change.

  3. mkl_fft includes a bug similar to what explained here in NumPy which is resolved in this PR.

@vtavana vtavana self-assigned this May 15, 2025
@vtavana vtavana force-pushed the revisit_overwrite_x branch 2 times, most recently from 13c6fa0 to 99dfd9d Compare May 16, 2025 15:17
@vtavana vtavana marked this pull request as ready for review May 16, 2025 18:23
@Copilot Copilot AI review requested due to automatic review settings May 16, 2025 18:23
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.fftpack interface and its tests
  • Replace overwrite_x with out in all APIs, implementations, and tests
  • Add new tests covering the out parameter 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

@IntelPython IntelPython deleted a comment from Copilot AI May 16, 2025
@vtavana vtavana force-pushed the revisit_overwrite_x branch from c165129 to 9fe528b Compare May 16, 2025 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant