Changeset 1675

Timestamp:

Dec 23, 2008, 12:23:40 AM (14 years ago)

Author:

Peter

Message:

adding section on test::Suite::equal* functions. closes #470

File:

• trunk/test/README (modified) (1 diff)

trunk/test/README

@@ -74 +74 @@
   test::Suite class (see functions err() and out()).
 
+  When writing numerical tests, it is typically desired to allow for
+  some small errors in the comparisons. When comparing two doubles
+  computed within the same program, the error bound should scale with
+  the machine precision. See test::Suite::equal(3). In other case, for
+  example, when the comparison includes a double distributed in
+  'test/data' the error bound should be fixed and reflect the
+  precision in the distributed file. See test::Suite::equal_fix(3).
+
   If a test needs a data file, place the data in directory
   'test/data'. However, you should feel free to re-use the data files