View source for TestNumericalNumber

<command>
<title>TestNumericalNumber</title>
<short_description>Compares two numerical numbers </short_description>
<syntax>
ApCoCoATest.TestNumericalNumber(Found: RAT, Expected: RAT, Eps: RAT):LIST
</syntax>

<description>
This function compares two numerical numbers. The difference between the two numbers must be smaller than eps.

<itemize>
<item>@param <em>Found</em>: The numerical value that was computed</item>
<item>@param <em>Expected</em>: The numerical value that should be computed</item>
<item>@param <em>Eps</em>: The allowed difference between the two values</item>
<item>@return A list. First entry is a boolean, its value is TRUE, if the test has been passed. If FALSE, the list contains also the expected and the found number.</item>
</itemize>

<example>
F := 3.14159265; E := 3.141;
ApCoCoATest.TestNumericalNumber(F,E,0.01);

[TRUE]
-------------------------------
F := 3.14159265; E := 3.141;
ApCoCoATest.TestNumericalNumber(F,E,0.0001);

[FALSE, 62831853/20000000, 3141/1000]
-------------------------------
</example>

</description>
<key>Testing</key>
<key>Numerical</key>
</command>