EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / StdLib / LibC / Softfloat / timesoftfloat.txt

$NetBSD: timesoftfloat.txt,v 1.1 2000/06/06 08:15:11 bjh21 Exp $\r
\r
Documentation for the `timesoftfloat' Program of SoftFloat Release 2a\r
\r
John R. Hauser\r
1998 December 14\r
\r
\r
-------------------------------------------------------------------------------\r
Introduction\r
\r
The `timesoftfloat' program evaluates the speed of SoftFloat's floating-\r
point routines.  Each routine can be evaluated for every relevant rounding\r
mode, tininess mode, and/or rounding precision.\r
\r
\r
-------------------------------------------------------------------------------\r
Contents\r
\r
    Introduction\r
    Contents\r
    Legal Notice\r
    Executing `timesoftfloat'\r
    Options\r
        -help\r
        -precision32, -precision64, -precision80\r
        -nearesteven, -tozero, -down, -up\r
        -tininessbefore, -tininessafter\r
    Function Sets\r
\r
\r
\r
-------------------------------------------------------------------------------\r
Legal Notice\r
\r
The `timesoftfloat' program was written by John R. Hauser.\r
\r
THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE.  Although reasonable effort\r
has been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT WILL AT\r
TIMES RESULT IN INCORRECT BEHAVIOR.  USE OF THIS SOFTWARE IS RESTRICTED TO\r
PERSONS AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL RESPONSIBILITY FOR ANY\r
AND ALL LOSSES, COSTS, OR OTHER PROBLEMS ARISING FROM ITS USE.\r
\r
\r
-------------------------------------------------------------------------------\r
Executing `timesoftfloat'\r
\r
The `timesoftfloat' program is intended to be invoked from a command line\r
interpreter as follows:\r
\r
    timesoftfloat [<option>...] <function>\r
\r
Here square brackets ([]) indicate optional items, while angled brackets\r
(<>) denote parameters to be filled in.  The `<function>' argument is\r
the name of the SoftFloat routine to evaluate, such as `float32_add' or\r
`float64_to_int32'.  The allowed options are detailed in the next section,\r
_Options_.  If `timesoftfloat' is executed without any arguments, a summary\r
of usage is written.  It is also possible to evaluate all machine functions\r
in a single invocation as explained in the section _Function_Sets_ later in\r
this document.\r
\r
Ordinarily, a function's speed will be evaulated separately for each of\r
the four rounding modes, one after the other.  If the rounding mode is not\r
supposed to have any affect on the results of a function--for instance,\r
some operations do not require rounding--only the nearest/even rounding mode\r
is timed.  In the same way, if a function is affected by the way in which\r
underflow tininess is detected, `timesoftfloat' times the function both with\r
tininess detected before rounding and after rounding.  For extended double-\r
precision operations affected by rounding precision control, `timesoftfloat'\r
also times the function for all three rounding precision modes, one after\r
the other.  Evaluation of a function can be limited to a single rounding\r
mode, a single tininess mode, and/or a single rounding precision with\r
appropriate options (see _Options_).\r
\r
For each function and mode evaluated, `timesoftfloat' reports the speed of\r
the function in kops/s, or ``thousands of operations per second''.  This\r
unit of measure differs from the traditional MFLOPS (``millions of floating-\r
point operations per second'') only in being a factor of 1000 smaller.\r
(1000 kops/s is exactly 1 MFLOPS.)  Speeds are reported in thousands instead\r
of millions because software floating-point often executes at less than\r
1 MFLOPS.\r
\r
The speeds reported by `timesoftfloat' may be affected somewhat by other\r
programs executing at the same time as `timesoftfloat'.\r
\r
Note that the remainder operations (`float32_rem', `float64_rem',\r
`floatx80_rem' and `float128_rem') will be markedly slower than other\r
operations, particularly for extended double precision (`floatx80') and\r
quadruple precision (`float128').  This is inherent to the remainder\r
function itself and is not a failing of the SoftFloat implementation.\r
\r
\r
-------------------------------------------------------------------------------\r
Options\r
\r
The `timesoftfloat' program accepts several command options.  If mutually\r
contradictory options are given, the last one has priority.\r
\r
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
-help\r
\r
The `-help' option causes a summary of program usage to be written, after\r
which the program exits.\r
\r
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
-precision32, -precision64, -precision80\r
\r
For extended double-precision functions affected by rounding precision\r
control, the `-precision32' option restricts evaluation to only the cases\r
in which rounding precision is equivalent to single precision.  The other\r
rounding precision options are not timed.  Likewise, the `-precision64'\r
and `-precision80' options fix the rounding precision equivalent to double\r
precision or extended double precision, respectively.  These options are\r
ignored for functions not affected by rounding precision control.\r
\r
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
-nearesteven, -tozero, -down, -up\r
\r
The `-nearesteven' option restricts evaluation to only the cases in which\r
the rounding mode is nearest/even.  The other rounding mode options are not\r
timed.  Likewise, `-tozero' forces rounding to zero; `-down' forces rounding\r
down; and `-up' forces rounding up.  These options are ignored for functions\r
that are exact and thus do not round.\r
\r
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
-tininessbefore, -tininessafter\r
\r
The `-tininessbefore' option restricts evaluation to only the cases\r
detecting underflow tininess before rounding.  Tininess after rounding\r
is not timed.  Likewise, `-tininessafter' forces underflow tininess to be\r
detected after rounding only.  These options are ignored for functions not\r
affected by the way in which underflow tininess is detected.\r
\r
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
\r
\r
-------------------------------------------------------------------------------\r
Function Sets\r
\r
Just as `timesoftfloat' can test an operation for all four rounding modes in\r
sequence, multiple operations can also be tested with a single invocation.\r
Three sets are recognized:  `-all1', `-all2', and `-all'.  The set `-all1'\r
comprises all one-operand functions; `-all2' is all two-operand functions;\r
and `-all' is all functions.  A function set can be used in place of a\r
function name in the command line, as in\r
\r
    timesoftfloat [<option>...] -all\r
\r
\r