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