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