A bunch more doc fixes.

[dunshire.git] / dunshire / options.py

diff --git a/dunshire/options.py b/dunshire/options.py
index 2a57e270e6763ba087d361bb0d81e7f57bd0d5d4..a66abb7bc626f9793ec21b622b3b719ad5aa38cc 100644 (file)
--- a/dunshire/options.py
+++ b/dunshire/options.py
@@ -5,25 +5,26 @@ change them. But this makes the user interface real simple.
 """
 
 
 """
 
 

-ABS_TOL = 1e-7
+ABS_TOL = 1e-6

 """
 The absolute tolerance used in all "are these numbers equal" and "is
 this number less than (or equal to) that other number" tests. The CVXOPT
 """
 The absolute tolerance used in all "are these numbers equal" and "is
 this number less than (or equal to) that other number" tests. The CVXOPT

-default is ``1e-7``, so we use that. Where we need to be more lenient,
-we'll have to adjust it.
+default is ``1e-7``, but loosening that a little reduces the number of
+"unknown" solutions that we get during random testing. Whether or not it
+improves the solubility of real problems is a question for the
+philosophers.

 """
 
 """
 

-
-FLOAT_FORMAT = '%.7f'
+DEBUG_FLOAT_FORMAT = '%.20f'

 """
 """

-The default output format for floating point numbers. It has been
-chosen to match the ``ABS_TOL``, in the sense that if ``x != y``,
-then they would not appear different when printed.
+The float output format to use when something goes wrong. If we need to
+reproduce a random test case, for example, then we need all of the digits
+of the things involved. If we try to recreate the problem using only,
+say, the first seven digits of each number, then the resulting game
+might not reproduce the failure.

 """
 
 """
 

-
-VERBOSE = False
+FLOAT_FORMAT = '%.7f'

 """
 """

-The underlying CVXOPT solver can output debug information, and I
-guess, so could we. But we don't want to because it's ugly.
+The default output format for floating point numbers.

 """
 """