]> gitweb.michael.orlitzky.com - dunshire.git/commitdiff
More minor doc cleanup.
authorMichael Orlitzky <michael@orlitzky.com>
Wed, 16 Nov 2016 00:08:17 +0000 (19:08 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Wed, 16 Nov 2016 00:08:17 +0000 (19:08 -0500)
dunshire/games.py

index e9ae21dd9fca7803ce0f67d5ba60f3d3555419c7..7dd280651fe954c6c1550a962bb2637f7122148a 100644 (file)
@@ -493,7 +493,6 @@ class SymmetricLinearGame:
         strategies::
 
             >>> from dunshire import *
         strategies::
 
             >>> from dunshire import *
-            >>> from dunshire.options import ABS_TOL
             >>> K = NonnegativeOrthant(3)
             >>> L = [[1,-5,-15],[-1,2,-3],[-12,-15,1]]
             >>> e1 = [1,1,1]
             >>> K = NonnegativeOrthant(3)
             >>> L = [[1,-5,-15],[-1,2,-3],[-12,-15,1]]
             >>> e1 = [1,1,1]
@@ -502,7 +501,7 @@ class SymmetricLinearGame:
             >>> soln = SLG.solution()
             >>> x_bar = soln.player1_optimal()
             >>> y_bar = soln.player2_optimal()
             >>> soln = SLG.solution()
             >>> x_bar = soln.player1_optimal()
             >>> y_bar = soln.player2_optimal()
-            >>> abs(SLG.payoff(x_bar, y_bar) - soln.game_value()) < ABS_TOL
+            >>> SLG.payoff(x_bar, y_bar) == soln.game_value()
             True
 
         """
             True
 
         """
@@ -584,8 +583,9 @@ class SymmetricLinearGame:
         r"""
         Return the matrix ``A`` used in our CVXOPT construction.
 
         r"""
         Return the matrix ``A`` used in our CVXOPT construction.
 
-        This matrix :math:`A` appears on the right-hand side of :math:`Ax
-        = b` in the statement of the CVXOPT conelp program.
+        This matrix :math:`A` appears on the right-hand side of
+        :math:`Ax = b` in the `statement of the CVXOPT conelp program
+        <http://cvxopt.org/userguide/coneprog.html#linear-cone-programs>`_.
 
         .. warning::
 
 
         .. warning::
 
@@ -622,7 +622,8 @@ class SymmetricLinearGame:
         Return the matrix ``G`` used in our CVXOPT construction.
 
         Thus matrix :math:`G` appears on the left-hand side of :math:`Gx
         Return the matrix ``G`` used in our CVXOPT construction.
 
         Thus matrix :math:`G` appears on the left-hand side of :math:`Gx
-        + s = h` in the statement of the CVXOPT conelp program.
+        + s = h` in the `statement of the CVXOPT conelp program
+        <http://cvxopt.org/userguide/coneprog.html#linear-cone-programs>`_.
 
         .. warning::
 
 
         .. warning::
 
@@ -664,8 +665,9 @@ class SymmetricLinearGame:
         Return the vector ``c`` used in our CVXOPT construction.
 
         The column vector :math:`c` appears in the objective function
         Return the vector ``c`` used in our CVXOPT construction.
 
         The column vector :math:`c` appears in the objective function
-        value :math:`\left\langle c,x \right\rangle` in the statement of
-        the CVXOPT conelp program.
+        value :math:`\left\langle c,x \right\rangle` in the `statement
+        of the CVXOPT conelp program
+        <http://cvxopt.org/userguide/coneprog.html#linear-cone-programs>`_.
 
         .. warning::
 
 
         .. warning::
 
@@ -702,7 +704,9 @@ class SymmetricLinearGame:
         """
         Return the cone ``C`` used in our CVXOPT construction.
 
         """
         Return the cone ``C`` used in our CVXOPT construction.
 
-        This is the cone over which the conelp program takes place.
+        This is the cone over which the `CVXOPT conelp program
+        <http://cvxopt.org/userguide/coneprog.html#linear-cone-programs>`_
+        takes place.
 
         Returns
         -------
 
         Returns
         -------
@@ -731,8 +735,9 @@ class SymmetricLinearGame:
         r"""
         Return the ``h`` vector used in our CVXOPT construction.
 
         r"""
         Return the ``h`` vector used in our CVXOPT construction.
 
-        The :math:`h` vector appears on the right-hand side of :math:`Gx + s
-        = h` in the statement of the CVXOPT conelp program.
+        The :math:`h` vector appears on the right-hand side of :math:`Gx
+        + s = h` in the `statement of the CVXOPT conelp program
+        <http://cvxopt.org/userguide/coneprog.html#linear-cone-programs>`_.
 
         .. warning::
 
 
         .. warning::
 
@@ -773,8 +778,9 @@ class SymmetricLinearGame:
         r"""
         Return the ``b`` vector used in our CVXOPT construction.
 
         r"""
         Return the ``b`` vector used in our CVXOPT construction.
 
-        The vector ``b`` appears on the right-hand side of :math:`Ax =
-        b` in the statement of the CVXOPT conelp program.
+        The vector :math:`b` appears on the right-hand side of :math:`Ax
+        = b` in the `statement of the CVXOPT conelp program
+        <http://cvxopt.org/userguide/coneprog.html#linear-cone-programs>`_.
 
         This method is static because the dimensions and entries of
         ``b`` are known beforehand, and don't depend on any other
 
         This method is static because the dimensions and entries of
         ``b`` are known beforehand, and don't depend on any other
@@ -1237,8 +1243,12 @@ class SymmetricLinearGame:
         can show up. We define the condition number of this game to be
         the average of the condition numbers of ``G`` and ``A`` in the
         CVXOPT construction. If the condition number of this game is
         can show up. We define the condition number of this game to be
         the average of the condition numbers of ``G`` and ``A`` in the
         CVXOPT construction. If the condition number of this game is
-        high, then you can expect numerical difficulty (such as
-        :class:`PoorScalingException`).
+        high, you can problems like :class:`PoorScalingException`.
+
+        Random testing shows that a condition number of around ``125``
+        is about the best that we can solve reliably. However, the
+        failures are intermittent, and you may get lucky with an
+        ill-conditioned game.
 
         Returns
         -------
 
         Returns
         -------