testsuite for flating point module
[libfirm] / ir / tv / IeeeCC754 / readme.usage
1 How to call the driver program IeeeCC754
2 ========================================
3
4 Summary:
5
6 IeeeCC754  -c {-s|-d|-l|-q|-m|{-e <int> -t <int> [-h]}}
7               -r {n|p|m|z}  -i -n {i|o|x|z|u|tiny|nan|inf|snz}
8               -f logfile  testfile
9
10 IeeeCC754  -u -r {n|p|m|z} -i -n {i|o|x|z|u|tiny|nan|inf|snz}
11               -f logfile  testfile
12
13 IeeeCC754  -o <file> {-s|-d|-l|-q|-m|{-e <int> -t <int> [-h]}}
14               -r {n|p|m|z}  -i -n {i|o|x|z|u|tiny|nan|inf|snz}
15               -f logfile  testfile
16
17 The required argument 'testfile' is a file of test vectors in extended
18 Coonen syntax (the default) or SUN-UCB format.
19
20 The options of the driver program can be subdivided in three categories,
21 listed below.
22
23 (1) Options to specify the purpose of the run. Use precisely one of the
24     following three options:
25          -c : perform testing: file of test vectors is in Coonen syntax
26          -u : perform testing: file of test vectors is in SUN-UCB format
27          -o <file> : do not perform testing but only translate testdata from
28                      Coonen syntax to hexadecimal SUN-UCB format and output
29                      to <file>
30
31 (2) Options to specify the precision and exponent range of the source (and
32     for some conversions also the destination) floating-point format, when
33     the file of test vectors is in extended Coonen syntax.
34     When the file of test vectors is in SUN-UCB format, the precision and
35     exponent range are specified in the testfile itself, and the options
36     below should be skipped.
37          -s : single precision (same as -e 8 -t 24 -h)
38          -d : double precision (same as -e 11 -t 53 -h)
39          -l : long double precision (same as -e 15 -t 64)
40          -q : quadruple precision (same as -e 15 -t 113 -h)
41          -m : 240 bit multiprecision (same as  -e 15 -t 240)
42          -e <int> : provide <int> bits to represent exponent
43          -t <int> : provide <int> bits precision
44          -h : leading bit is hidden
45          -ds : single precision destination
46          -dd : double precision destination
47          -dl : long double precision destination
48          -dq : quadruple precision destination
49          -dm : 240 bit multiprecision destination
50          -de <int> : size of destination exponent
51          -dt <int> : destination precision
52          -dh : leading bit is hidden in destination
53
54 (3) Options to influence the actual testing phase (optional)
55          -r {n|p|m|z}: test only the specified rounding modes
56          -n {i|o|x|z|u|tiny|nan|inf|snz}: do not test the specified
57                   exceptions, denormalized numbers, NaNs, signed
58                   infinities or signed zeroes
59          -j {o|u|i|z}: jump/skip test vectors raising the overflow, underflow,
60                   invalid or divide by zero exception
61          -ieee: test conversions only within range specified by IEEE
62          -i: idem as -ieee
63          -f logfile: output log of testing to 'logfile'; the default value
64                   for 'logfile' is ieee.log