]> gitweb.michael.orlitzky.com - dunshire.git/blob - src/dunshire/options.py
More "easy" docs work in matrices.py/options.py.
[dunshire.git] / src / dunshire / options.py
1 """
2 A place to collect the various options that "can be passed to the
3 underlying engine." Just kidding, they're constants and you can't
4 change them. But this makes the user interface real simple.
5
6 .. data:: ABS_TOL
7
8 The absolute tolerance used in all "are these numbers equal" and "is
9 this number less than (or equal to) that other number" tests.
10
11 .. data:: FLOAT_FORMAT
12
13 The default output format for floating point numbers. It has been
14 chosen to match the ``ABS_TOL``, in the sense that if ``x != y``,
15 then they would not appear different when printed.
16
17 .. data:: VERBOSE
18
19 The underlying CVXOPT solver can output debug information, and I
20 guess, so could we. But we don't want to because it's ugly.
21
22 """
23 ABS_TOL = 1e-7
24 FLOAT_FORMAT = '%.7f'
25 VERBOSE = False