annotate src/fftw-3.3.3/tests/README @ 10:37bf6b4a2645

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