Skip to content

Commit bdfb5f0

Browse files
committed
changelog and docs to match nthr-capping done in PR #431; fixes #430
1 parent 0fd60a0 commit bdfb5f0

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

CHANGELOG

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
List of features / changes made / release notes, in reverse chronological order.
22
If not stated, FINUFFT is assumed (cuFINUFFT <=1.3 is listed separately).
33

4+
* CPU plan stage prevents now caps # threads at omp_get_max_threads (being 1
5+
for single-thread build); warns if this cap was activated (PR 431)
46
* new docs troubleshooting accuracy limitations due to condition number of the
57
NUFFT problem.
68
* new sanity check on nj and nk (<0 or too big); new err code, tester, doc.

docs/opts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Diagnostic options
128128
Algorithm performance options
129129
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130130

131-
**nthreads**: Number of threads to use. This sets the number of threads FINUFFT will use in FFTW, bin-sorting, and spreading/interpolation steps. This number of threads also controls the batch size for vectorized transforms (ie ``ntr>1`` :ref:`here <c>`). Setting ``nthreads=0`` uses all threads available. For repeated small problems it can be advantageous to use a small number, such as 1.
131+
**nthreads**: Number of threads to use. This is capped at the number of available threads (eg, to prevent misuse of a single-threaded code). It then sets the number of threads FINUFFT will use in FFTW, bin-sorting, and spreading/interpolation steps. This number of threads also controls the batch size for vectorized transforms (ie ``ntr>1`` :ref:`here <c>`). Setting ``nthreads=0`` uses all threads available, usually recommended. However, for repeated small problems it can be advantageous to use a small number, even as small as 1.
132132

133133
**fftw**: FFTW planner flags. This number is simply passed to FFTW's planner;
134134
the flags are documented `here <http://www.fftw.org/fftw3_doc/Planner-Flags.html#Planner-Flags>`_.

0 commit comments

Comments
 (0)