Make the _C(), _A(), and _b() methods for games public.

[dunshire.git] / dunshire / games.py

diff --git a/dunshire/games.py b/dunshire/games.py
index ff3ec0001b4c3508ceef2c43afb6d13ffb7d403f..672810de8094df7c37005cd5106fe5b8175888c4 100644 (file)
--- a/dunshire/games.py
+++ b/dunshire/games.py
@@ -335,12 +335,12 @@ class SymmetricLinearGame:
               '  e1 = {:s},\n' \
               '  e2 = {:s},\n' \
               '  Condition((L, K, e1, e2)) = {:f}.'
-        indented_L = '\n      '.join(str(self._L).splitlines())
-        indented_e1 = '\n       '.join(str(self._e1).splitlines())
-        indented_e2 = '\n       '.join(str(self._e2).splitlines())
+        indented_L = '\n      '.join(str(self.L()).splitlines())
+        indented_e1 = '\n       '.join(str(self.e1()).splitlines())
+        indented_e2 = '\n       '.join(str(self.e2()).splitlines())
 
         return tpl.format(indented_L,
-                          str(self._K),
+                          str(self.K()),
                           indented_e1,
                           indented_e2,
                           self.condition())
@@ -581,7 +581,7 @@ class SymmetricLinearGame:
         return matrix(0, (self.dimension(), 1), tc='d')
 
 
-    def _A(self):
+    def A(self):
         """
         Return the matrix ``A`` used in our CVXOPT construction.
 
@@ -609,12 +609,12 @@ class SymmetricLinearGame:
             >>> e1 = [1,1,1]
             >>> e2 = [1,2,3]
             >>> SLG = SymmetricLinearGame(L, K, e1, e2)
-            >>> print(SLG._A())
+            >>> print(SLG.A())
             [0.0000000 1.0000000 2.0000000 3.0000000]
             <BLANKLINE>
 
         """
-        return matrix([0, self._e2], (1, self.dimension() + 1), 'd')
+        return matrix([0, self.e2()], (1, self.dimension() + 1), 'd')
 
 
 
@@ -657,7 +657,7 @@ class SymmetricLinearGame:
         """
         identity_matrix = identity(self.dimension())
         return append_row(append_col(self._zero(), -identity_matrix),
-                          append_col(self._e1, -self._L))
+                          append_col(self.e1(), -self.L()))
 
 
     def _c(self):
@@ -698,7 +698,7 @@ class SymmetricLinearGame:
         return matrix([-1, self._zero()])
 
 
-    def _C(self):
+    def C(self):
         """
         Return the cone ``C`` used in our CVXOPT construction.
 
@@ -720,7 +720,7 @@ class SymmetricLinearGame:
             >>> e1 = [1,2,3]
             >>> e2 = [1,1,1]
             >>> SLG = SymmetricLinearGame(L, K, e1, e2)
-            >>> print(SLG._C())
+            >>> print(SLG.C())
             Cartesian product of dimension 6 with 2 factors:
               * Nonnegative orthant in the real 3-space
               * Nonnegative orthant in the real 3-space
@@ -770,7 +770,7 @@ class SymmetricLinearGame:
 
 
     @staticmethod
-    def _b():
+    def b():
         """
         Return the ``b`` vector used in our CVXOPT construction.
 
@@ -801,7 +801,7 @@ class SymmetricLinearGame:
             >>> e1 = [1,2,3]
             >>> e2 = [1,1,1]
             >>> SLG = SymmetricLinearGame(L, K, e1, e2)
-            >>> print(SLG._b())
+            >>> print(SLG.b())
             [1.0000000]
             <BLANKLINE>
 
@@ -926,13 +926,13 @@ class SymmetricLinearGame:
 
         """
         try:
-            opts = {'show_progress': options.VERBOSE}
+            opts = {'show_progress': False}
             soln_dict = solvers.conelp(self._c(),
                                        self._G(),
                                        self._h(),
-                                       self._C().cvxopt_dims(),
-                                       self._A(),
-                                       self._b(),
+                                       self.C().cvxopt_dims(),
+                                       self.A(),
+                                       self.b(),
                                        options=opts)
         except ValueError as error:
             if str(error) == 'math domain error':
@@ -1036,7 +1036,7 @@ class SymmetricLinearGame:
         True
 
         """
-        return (condition_number(self._G()) + condition_number(self._A()))/2
+        return (condition_number(self._G()) + condition_number(self.A()))/2
 
 
     def dual(self):
@@ -1072,10 +1072,10 @@ class SymmetricLinearGame:
               Condition((L, K, e1, e2)) = 44.476...
 
         """
-        # We pass ``self._L`` right back into the constructor, because
+        # We pass ``self.L()`` right back into the constructor, because
         # it will be transposed there. And keep in mind that ``self._K``
         # is its own dual.
-        return SymmetricLinearGame(self._L,
-                                   self._K,
-                                   self._e2,
-                                   self._e1)
+        return SymmetricLinearGame(self.L(),
+                                   self.K(),
+                                   self.e2(),
+                                   self.e1())