annotate src/fftw-3.3.5/tests/README @ 42:2cd0e3b3e1fd

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