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