File tree Expand file tree Collapse file tree 1 file changed +9
-0
lines changed
Expand file tree Collapse file tree 1 file changed +9
-0
lines changed Original file line number Diff line number Diff line change @@ -148,10 +148,19 @@ class _PYFFTW_SLIDING_DOT_PRODUCT:
148148 Cache of FFTW inverse transform objects with
149149 (next_fast_n, n_threads, planning_flag) as lookup keys.
150150
151+ Methods
152+ -------
153+ __call__(Q, T, n_threads=1, planning_flag="FFTW_ESTIMATE")
154+ Compute the sliding dot product between `Q` and `T` using FFTW
155+ via pyfftw, and cache FFTW objects if not already cached.
156+
151157 Notes
152158 -----
153159 The class maintains internal caches of FFTW objects to avoid redundant planning
154160 operations when called multiple times with similar-sized inputs and parameters.
161+ When `planning_flag=="FFTW_ESTIMATE"`, there will be no planning operation.
162+ However, caching FFTW objects is still beneficial as the overhead of creating
163+ those objects can be avoided in subsequent calls.
155164
156165 Examples
157166 --------
You can’t perform that action at this time.
0 commit comments