|
cannam@95
|
1 This directory contains a benchmarking and testing program
|
|
cannam@95
|
2 for fftw3.
|
|
cannam@95
|
3
|
|
cannam@95
|
4 The `bench' program has a zillion options, because we use it for
|
|
cannam@95
|
5 benchmarking other FFT libraries as well. This file only documents
|
|
cannam@95
|
6 the basic usage of bench.
|
|
cannam@95
|
7
|
|
cannam@95
|
8 Usage: bench <commands>
|
|
cannam@95
|
9
|
|
cannam@95
|
10 where each command is as follows:
|
|
cannam@95
|
11
|
|
cannam@95
|
12 -s <problem>
|
|
cannam@95
|
13 --speed <problem>
|
|
cannam@95
|
14
|
|
cannam@95
|
15 Benchmarks the speed of <problem>.
|
|
cannam@95
|
16
|
|
cannam@95
|
17 The syntax for problems is [i|o][r|c][f|b]<size>, where
|
|
cannam@95
|
18
|
|
cannam@95
|
19 i/o means in-place or out-of-place. Out of place is the default.
|
|
cannam@95
|
20 r/c means real or complex transform. Complex is the default.
|
|
cannam@95
|
21 f/b means forward or backward transform. Forward is the default.
|
|
cannam@95
|
22 <size> is an arbitrary multidimensional sequence of integers
|
|
cannam@95
|
23 separated by the character 'x'.
|
|
cannam@95
|
24
|
|
cannam@95
|
25 (The syntax for problems is actually richer, but we do not document
|
|
cannam@95
|
26 it here. See the man page for fftw-wisdom for more information.)
|
|
cannam@95
|
27
|
|
cannam@95
|
28 Example:
|
|
cannam@95
|
29
|
|
cannam@95
|
30 ib256 : in-place backward complex transform of size 256
|
|
cannam@95
|
31 32x64 : out-of-place forward complex 2D transform of 32 rows
|
|
cannam@95
|
32 and 64 columns.
|
|
cannam@95
|
33
|
|
cannam@95
|
34 -y <problem>
|
|
cannam@95
|
35 --verify <problem>
|
|
cannam@95
|
36
|
|
cannam@95
|
37 Verify that FFTW is computing the correct answer.
|
|
cannam@95
|
38
|
|
cannam@95
|
39 The program does not output anything unless an error occurs or
|
|
cannam@95
|
40 verbosity is at least one.
|
|
cannam@95
|
41
|
|
cannam@95
|
42 -v<n>
|
|
cannam@95
|
43
|
|
cannam@95
|
44 Set verbosity to <n>, or 1 if <n> is omitted. -v2 will output
|
|
cannam@95
|
45 the created plans with fftw_print_plan.
|
|
cannam@95
|
46
|
|
cannam@95
|
47 -oestimate
|
|
cannam@95
|
48 -opatient
|
|
cannam@95
|
49 -oexhaustive
|
|
cannam@95
|
50
|
|
cannam@95
|
51 Plan with FFTW_ESTIMATE, FFTW_PATIENT, or FFTW_EXHAUSTIVE, respectively.
|
|
cannam@95
|
52 The default is FFTW_MEASURE.
|
|
cannam@95
|
53
|
|
cannam@95
|
54 If you benchmark FFTW, please use -opatient.
|
|
cannam@95
|
55
|
|
cannam@95
|
56 -onthreads=N
|
|
cannam@95
|
57
|
|
cannam@95
|
58 Use N threads, if FFTW was compiled with --enable-threads. N
|
|
cannam@95
|
59 must be a positive integer; the default is N=1.
|
|
cannam@95
|
60
|
|
cannam@95
|
61 -onosimd
|
|
cannam@95
|
62
|
|
cannam@95
|
63 Disable SIMD instructions (e.g. SSE or SSE2).
|
|
cannam@95
|
64
|
|
cannam@95
|
65 -ounaligned
|
|
cannam@95
|
66
|
|
cannam@95
|
67 Plan with the FFTW_UNALIGNED flag.
|
|
cannam@95
|
68
|
|
cannam@95
|
69 -owisdom
|
|
cannam@95
|
70
|
|
cannam@95
|
71 On startup, read wisdom from a file wis.dat in the current directory
|
|
cannam@95
|
72 (if it exists). On completion, write accumulated wisdom to wis.dat
|
|
cannam@95
|
73 (overwriting any existing file of that name).
|
