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