From 1e30c9ab646c58ad31d9ece850bab0de56e3926b Mon Sep 17 00:00:00 2001
From: wheeheee <104880306+wheeheee@users.noreply.github.com>
Date: Mon, 11 Nov 2024 14:50:01 +0800
Subject: [PATCH] Deprecate only multi-arg `nextfastfft` (#580)

---
 src/deprecated.jl |  4 ++++
 src/util.jl       | 32 ++++++++++++++++++++++++--------
 2 files changed, 28 insertions(+), 8 deletions(-)

diff --git a/src/deprecated.jl b/src/deprecated.jl
index ed4a29ca0..728c9b67a 100644
--- a/src/deprecated.jl
+++ b/src/deprecated.jl
@@ -1,3 +1,7 @@
+# deprecations in 0.8
+import .Util.nextfastfft
+@deprecate nextfastfft(ns...) nextfastfft.(ns) false
+
 # deprecations after 0.6
 @deprecate freqz(filter::FilterCoefficients{:z}) freqresp(filter, range(0, stop=π, length=250))
 @deprecate freqz(filter::FilterCoefficients{:z}, w) freqresp(filter, w)
diff --git a/src/util.jl b/src/util.jl
index 757fbc6f1..ca0395d01 100644
--- a/src/util.jl
+++ b/src/util.jl
@@ -107,16 +107,32 @@ fftabs2type(::Type{T}) where {T<:Union{Real,Complex}} = Float64
 const FAST_FFT_SIZES = (2, 3, 5, 7)
 
 """
-    nextfastfft(n)
+    nextfastfft(n::Integer)
+    nextfastfft(ns::Tuple)
 
-Return the closest product of 2, 3, 5, and 7 greater than or equal
-to `n`. FFTW contains optimized kernels for these sizes and
-computes Fourier transforms of input that is a product of these
-sizes faster than for input of other sizes.
+Return an estimate for the padded size of an array that
+is optimal for the performance of an n-dimensional FFT.
+
+For `Tuple` inputs, this returns a `Tuple` that is the size
+of the padded array.
+
+For `Integer` inputs, this returns the closest product of 2, 3, 5, and 7
+greater than or equal to `n`.
+FFTW contains optimized kernels for these sizes and computes
+Fourier transforms of inputs that are a product of these
+sizes faster than for inputs of other sizes.
+
+!!! warning
+
+    Currently, `nextfastfft(ns::Tuple)` is implemented as
+    `nextfastfft.(ns)`. This may change in future releases if
+    a better estimation model is found.
+
+    It is recommended to use `nextfastfft.(ns)` to obtain
+    a tuple of padded lengths for 1D FFTs.
 """
-nextfastfft(n) = nextprod(FAST_FFT_SIZES, n)
-nextfastfft(ns::Tuple) = nextfastfft.(ns)
-nextfastfft(ns...) = nextfastfft(ns)
+nextfastfft(n::Integer) = nextprod(FAST_FFT_SIZES, n)
+nextfastfft(ns::Tuple{Vararg{Integer}}) = nextfastfft.(ns)
 
 
 ## COMMON DSP TOOLS