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