annotate fft/fftw/fftw-3.3.4/tests/README @ 40:223f770b5341 kissfft-double tip

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