Skip to content

Commit b38df6b

Browse files
committed
revert matlab doc opts12 vs opts docsrc ordering since opts needs to come before opts.modeord
1 parent e7ae27d commit b38df6b

13 files changed

+18
-18
lines changed

docs/matlabhelp.doc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
eps relative precision requested (generally between 1e-15 and 1e-1)
2020
ms number of Fourier modes computed, may be even or odd;
2121
in either case, mode range is integers lying in [-ms/2, (ms-1)/2]
22-
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
2322
opts optional struct with optional fields controlling the following:
2423
opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
2524
opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -31,6 +30,7 @@
3130
opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
3231
opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
3332
opts.nthreads: number of threads, or 0: use all available (default)
33+
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
3434
Outputs:
3535
f size-ms complex column vector of Fourier coefficients, or, if
3636
ntrans>1, a matrix of size (ms,ntrans).
@@ -65,7 +65,6 @@
6565
of ntrans columns is transformed with the same nonuniform targets.
6666
isign if >=0, uses + sign in exponential, otherwise - sign.
6767
eps relative precision requested (generally between 1e-15 and 1e-1)
68-
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
6968
opts optional struct with optional fields controlling the following:
7069
opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
7170
opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -77,6 +76,7 @@
7776
opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
7877
opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
7978
opts.nthreads: number of threads, or 0: use all available (default)
79+
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
8080
Outputs:
8181
c complex column vector of nj answers at targets, or,
8282
if ntrans>1, matrix of size (nj,ntrans).
@@ -161,7 +161,6 @@
161161
eps relative precision requested (generally between 1e-15 and 1e-1)
162162
ms,mt number of Fourier modes requested in x & y; each may be even or odd.
163163
In either case the mode range is integers lying in [-m/2, (m-1)/2]
164-
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
165164
opts optional struct with optional fields controlling the following:
166165
opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
167166
opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -173,6 +172,7 @@
173172
opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
174173
opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
175174
opts.nthreads: number of threads, or 0: use all available (default)
175+
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
176176
Outputs:
177177
f size (ms,mt) complex matrix of Fourier coefficients
178178
(ordering given by opts.modeord in each dimension; ms fast, mt slow),
@@ -210,7 +210,6 @@
210210
matrices is transformed with the same nonuniform targets.
211211
isign if >=0, uses + sign in exponential, otherwise - sign.
212212
eps relative precision requested (generally between 1e-15 and 1e-1)
213-
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
214213
opts optional struct with optional fields controlling the following:
215214
opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
216215
opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -222,6 +221,7 @@
222221
opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
223222
opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
224223
opts.nthreads: number of threads, or 0: use all available (default)
224+
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
225225
Outputs:
226226
c complex column vector of nj answers at targets, or,
227227
if ntrans>1, matrix of size (nj,ntrans).
@@ -309,7 +309,6 @@
309309
ms,mt,mu number of Fourier modes requested in x,y and z; each may be
310310
even or odd.
311311
In either case the mode range is integers lying in [-m/2, (m-1)/2]
312-
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
313312
opts optional struct with optional fields controlling the following:
314313
opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
315314
opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -321,6 +320,7 @@
321320
opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
322321
opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
323322
opts.nthreads: number of threads, or 0: use all available (default)
323+
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
324324
Outputs:
325325
f size (ms,mt,mu) complex array of Fourier coefficients
326326
(ordering given by opts.modeord in each dimension; ms fastest, mu
@@ -360,7 +360,6 @@
360360
3D arrays is transformed with the same nonuniform targets.
361361
isign if >=0, uses + sign in exponential, otherwise - sign.
362362
eps relative precision requested (generally between 1e-15 and 1e-1)
363-
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
364363
opts optional struct with optional fields controlling the following:
365364
opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
366365
opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -372,6 +371,7 @@
372371
opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
373372
opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
374373
opts.nthreads: number of threads, or 0: use all available (default)
374+
opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
375375
Outputs:
376376
c complex column vector of nj answers at targets, or,
377377
if ntrans>1, matrix of size (nj,ntrans).

matlab/finufft1d1.docsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
ISIGNEPS
1717
% ms number of Fourier modes computed, may be even or odd;
1818
% in either case, mode range is integers lying in [-ms/2, (ms-1)/2]
19-
OPTS12
2019
OPTS
20+
OPTS12
2121
% Outputs:
2222
% f size-ms complex column vector of Fourier coefficients, or, if
2323
% ntrans>1, a matrix of size (ms,ntrans).

matlab/finufft1d1.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
% eps relative precision requested (generally between 1e-15 and 1e-1)
1818
% ms number of Fourier modes computed, may be even or odd;
1919
% in either case, mode range is integers lying in [-ms/2, (ms-1)/2]
20-
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
2120
% opts optional struct with optional fields controlling the following:
2221
% opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
2322
% opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -29,6 +28,7 @@
2928
% opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
3029
% opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
3130
% opts.nthreads: number of threads, or 0: use all available (default)
31+
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
3232
% Outputs:
3333
% f size-ms complex column vector of Fourier coefficients, or, if
3434
% ntrans>1, a matrix of size (ms,ntrans).

matlab/finufft1d2.docsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
% (with mode ordering given by opts.modeord). If a matrix, each
1616
% of ntrans columns is transformed with the same nonuniform targets.
1717
ISIGNEPS
18-
OPTS12
1918
OPTS
19+
OPTS12
2020
% Outputs:
2121
% c complex column vector of nj answers at targets, or,
2222
% if ntrans>1, matrix of size (nj,ntrans).

matlab/finufft1d2.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
% of ntrans columns is transformed with the same nonuniform targets.
1717
% isign if >=0, uses + sign in exponential, otherwise - sign.
1818
% eps relative precision requested (generally between 1e-15 and 1e-1)
19-
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
2019
% opts optional struct with optional fields controlling the following:
2120
% opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
2221
% opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -28,6 +27,7 @@
2827
% opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
2928
% opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
3029
% opts.nthreads: number of threads, or 0: use all available (default)
30+
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
3131
% Outputs:
3232
% c complex column vector of nj answers at targets, or,
3333
% if ntrans>1, matrix of size (nj,ntrans).

matlab/finufft2d1.docsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
ISIGNEPS
2121
% ms,mt number of Fourier modes requested in x & y; each may be even or odd.
2222
% In either case the mode range is integers lying in [-m/2, (m-1)/2]
23-
OPTS12
2423
OPTS
24+
OPTS12
2525
% Outputs:
2626
% f size (ms,mt) complex matrix of Fourier coefficients
2727
% (ordering given by opts.modeord in each dimension; ms fast, mt slow),

matlab/finufft2d1.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
% eps relative precision requested (generally between 1e-15 and 1e-1)
2222
% ms,mt number of Fourier modes requested in x & y; each may be even or odd.
2323
% In either case the mode range is integers lying in [-m/2, (m-1)/2]
24-
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
2524
% opts optional struct with optional fields controlling the following:
2625
% opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
2726
% opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -33,6 +32,7 @@
3332
% opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
3433
% opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
3534
% opts.nthreads: number of threads, or 0: use all available (default)
35+
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
3636
% Outputs:
3737
% f size (ms,mt) complex matrix of Fourier coefficients
3838
% (ordering given by opts.modeord in each dimension; ms fast, mt slow),

matlab/finufft2d2.docsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
% If a 3D array, 3rd dimension sets ntrans, and each of ntrans
1818
% matrices is transformed with the same nonuniform targets.
1919
ISIGNEPS
20-
OPTS12
2120
OPTS
21+
OPTS12
2222
% Outputs:
2323
% c complex column vector of nj answers at targets, or,
2424
% if ntrans>1, matrix of size (nj,ntrans).

matlab/finufft2d2.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
% matrices is transformed with the same nonuniform targets.
1919
% isign if >=0, uses + sign in exponential, otherwise - sign.
2020
% eps relative precision requested (generally between 1e-15 and 1e-1)
21-
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
2221
% opts optional struct with optional fields controlling the following:
2322
% opts.debug: 0 (silent, default), 1 (timing breakdown), 2 (debug info).
2423
% opts.spread_debug: spreader: 0 (no text, default), 1 (some), or 2 (lots)
@@ -30,6 +29,7 @@
3029
% opts.spread_thread: for ntrans>1 only. 0:auto, 1:seq multi, 2:par, etc
3130
% opts.maxbatchsize: for ntrans>1 only. max blocking size, or 0 for auto.
3231
% opts.nthreads: number of threads, or 0: use all available (default)
32+
% opts.modeord: 0 (CMCL increasing mode ordering, default), 1 (FFT ordering)
3333
% Outputs:
3434
% c complex column vector of nj answers at targets, or,
3535
% if ntrans>1, matrix of size (nj,ntrans).

matlab/finufft3d1.docsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ ISIGNEPS
2222
% ms,mt,mu number of Fourier modes requested in x,y and z; each may be
2323
% even or odd.
2424
% In either case the mode range is integers lying in [-m/2, (m-1)/2]
25-
OPTS12
2625
OPTS
26+
OPTS12
2727
% Outputs:
2828
% f size (ms,mt,mu) complex array of Fourier coefficients
2929
% (ordering given by opts.modeord in each dimension; ms fastest, mu

0 commit comments

Comments
 (0)