plan_fft should be more generic
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- julia
- Domain
- documentation
Research direction
Start by reading the plan_fft and related planning-function documentation and signatures in AbstractFFTs.jl. Compare them with the corresponding FFTW.jl documentation, then update both projects so the abstract API is backend-neutral and FFTW-specific defaults remain documented in FFTW.jl. Done means the two documentation sets no longer present FFTW options as universal.
Written by the indexing model from the issue text.
Description
The planning functions (plan_fft, plan_fft!, plan_ifft, etc) are currently derived from FFTW. The docs and method signature refer to library-specific options: the planning modes (e.g., FFTW.MEASURE) and timelimit. As I understand it, these are not universal standards: MKL can preallocate output and has other options (DFTI_ORDERING) and other back-ends may do something different---or even nothing at all.
Consequently, it might be clearer to describe the planning functions here as plan_fft(A, [dims]; kwargs...) and have FFTW.jl provide plan_fft(A, [dims]; flags=FFTW.ESTIMATE, timelimit=Inf).
This would not require any changes to the code but would require a concurrent change to the FFTW.jl docs. It already includes docs for some functions not represented in AbstractFFTs, so this seems feasible.
- Dominant language
- Julia
- Stars
- 135
- Forks
- 40
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from JuliaMath/AbstractFFTs.jl
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
JuliaMath/AbstractFFTs.jl#159 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
JuliaMath/AbstractFFTs.jl#135 ·
-
Difficulty 5/5 Over a week Newbie friendliness 28/100
JuliaMath/AbstractFFTs.jl#125 · 2 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
JuliaMath/AbstractFFTs.jl#122 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
JuliaMath/AbstractFFTs.jl#119 ·
All issues in JuliaMath/AbstractFFTs.jl
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
JuliaGenAI/HuggingFaceDatasets.jl#96 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
JuliaData/DBFTables.jl#50 ·
-
code-review
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
JuliaNLSolvers/Optim.jl#1296 ·
-
OptimizationCUTEst jobs fail: gfortran not installed on the runnerPossibly taken @ChrisRackauckas-Claude claimed this 1 day ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
SciML/SciMLBenchmarks.jl#1946 · 1 comment ·
Maintainers usually reply within 1 day