X-Git-Url: https://gitweb.michael.orlitzky.com/?p=dunshire.git;a=blobdiff_plain;f=dunshire%2Fgames.py;h=ea7a64f6b8e6451a808b464494c11e9be9f0de78;hp=7dd280651fe954c6c1550a962bb2637f7122148a;hb=0274de467062ab29d2a41d2a91ec0b28fcd95c8d;hpb=8e261aea0119c04752bbb5925b4f4513f928271b diff --git a/dunshire/games.py b/dunshire/games.py index 7dd2806..ea7a64f 100644 --- a/dunshire/games.py +++ b/dunshire/games.py @@ -924,16 +924,18 @@ class SymmetricLinearGame: def tolerance_scale(self, solution): r""" - Return a scaling factor that should be applied to :const:`ABS_TOL` - for this game. + + Return a scaling factor that should be applied to + :const:`dunshire.options.ABS_TOL` for this game. When performing certain comparisons, the default tolerance - :const:`ABS_TOL` may not be appropriate. For example, if we expect - ``x`` and ``y`` to be within :const:`ABS_TOL` of each other, - than the inner product of ``L*x`` and ``y`` can be as far apart - as the spectral norm of ``L`` times the sum of the norms of - ``x`` and ``y``. Such a comparison is made in :meth:`solution`, - and in many of our unit tests. + :const:`dunshire.options.ABS_TOL` may not be appropriate. For + example, if we expect ``x`` and ``y`` to be within + :const:`dunshire.options.ABS_TOL` of each other, than the inner + product of ``L*x`` and ``y`` can be as far apart as the spectral + norm of ``L`` times the sum of the norms of ``x`` and + ``y``. Such a comparison is made in :meth:`solution`, and in + many of our unit tests. The returned scaling factor found from the inner product mentioned above is @@ -967,7 +969,8 @@ class SymmetricLinearGame: ------- float - A scaling factor to be multiplied by :const:`ABS_TOL` when + A scaling factor to be multiplied by + :const:`dunshire.options.ABS_TOL` when making comparisons involving solutions of this game. Examples @@ -1004,7 +1007,7 @@ class SymmetricLinearGame: Returns ------- - :class:`Solution` + Solution A :class:`Solution` object describing the game's value and the optimal strategies of both players.