JuliaMath / JuliaMath/AbstractFFTs.jl

plan_fft should be more generic

Open
#147 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
134
Forks
40
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.