annotate src/fftw-3.3.8/tests/README @ 82:d0c2a83c1364

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