cannam@127: This directory contains a benchmarking and testing program
cannam@127: for fftw3.
cannam@127: 
cannam@127: The `bench' program has a zillion options, because we use it for
cannam@127: benchmarking other FFT libraries as well.  This file only documents
cannam@127: the basic usage of bench.
cannam@127: 
cannam@127: Usage: bench <commands>
cannam@127: 
cannam@127: where each command is as follows:
cannam@127: 
cannam@127: -s <problem>
cannam@127: --speed <problem>
cannam@127: 
cannam@127:     Benchmarks the speed of <problem>.
cannam@127: 
cannam@127:     The syntax for problems is [i|o][r|c][f|b]<size>, where
cannam@127: 
cannam@127:       i/o means in-place or out-of-place.  Out of place is the default.
cannam@127:       r/c means real or complex transform.  Complex is the default.
cannam@127:       f/b means forward or backward transform.  Forward is the default.
cannam@127:       <size> is an arbitrary multidimensional sequence of integers
cannam@127:         separated by the character 'x'.
cannam@127: 
cannam@127:     (The syntax for problems is actually richer, but we do not document
cannam@127:     it here.  See the man page for fftw-wisdom for more information.)
cannam@127: 
cannam@127:     Example:
cannam@127: 
cannam@127:         ib256 : in-place backward complex transform of size 256
cannam@127:         32x64 : out-of-place forward complex 2D transform of 32 rows
cannam@127:                 and 64 columns.
cannam@127: 
cannam@127: -y <problem>
cannam@127: --verify <problem>
cannam@127: 
cannam@127:    Verify that FFTW is computing the correct answer.
cannam@127: 
cannam@127:    The program does not output anything unless an error occurs or
cannam@127:    verbosity is at least one.
cannam@127: 
cannam@127: -v<n>
cannam@127: 
cannam@127:    Set verbosity to <n>, or 1 if <n> is omitted.  -v2 will output
cannam@127:    the created plans with fftw_print_plan.
cannam@127:    
cannam@127: -oestimate
cannam@127: -opatient
cannam@127: -oexhaustive
cannam@127:  
cannam@127:   Plan with FFTW_ESTIMATE, FFTW_PATIENT, or FFTW_EXHAUSTIVE, respectively.
cannam@127:   The default is FFTW_MEASURE.
cannam@127: 
cannam@127:   If you benchmark FFTW, please use -opatient.
cannam@127:       
cannam@127: -onthreads=N
cannam@127: 
cannam@127:   Use N threads, if FFTW was compiled with --enable-threads.  N
cannam@127:   must be a positive integer; the default is N=1.
cannam@127: 
cannam@127: -onosimd
cannam@127: 
cannam@127:   Disable SIMD instructions (e.g. SSE or SSE2).
cannam@127: 
cannam@127: -ounaligned
cannam@127: 
cannam@127:   Plan with the FFTW_UNALIGNED flag.
cannam@127: 
cannam@127: -owisdom
cannam@127: 
cannam@127:   On startup, read wisdom from a file wis.dat in the current directory
cannam@127:   (if it exists).  On completion, write accumulated wisdom to wis.dat
cannam@127:   (overwriting any existing file of that name).