]> gitweb.michael.orlitzky.com - dunshire.git/blobdiff - doc/README.rst
MANIFEST.in,doc/COPYING: add COPYING
[dunshire.git] / doc / README.rst
index 6fe9ba6ca2f5c6db0e82979deab2c764f6a8d66d..afa8d4618ef30f3009b5f758515245f34763a4df 100644 (file)
@@ -1,21 +1,16 @@
-Overview
---------
+Dunshire is a `CVXOPT <https://cvxopt.org/>`_-based library for solving
+linear (cone) games. The notion of a symmetric linear (cone) game was
+introduced by Gowda and Ravindran in *On the game-theoretic value of a
+linear transformation relative to a self-dual cone*. I've extended
+their results to asymmetric cones and two interior points in my
+thesis, which does not exist yet.
 
-Dunshire is a CVXOPT-based library for solving linear (cone)
-games. The notion of a cone game was introduced by Gowda[1] and
-extended to asymmetric cones in my thesis[2].
+The main idea can be gleaned from Gowda and Ravindran, however.
+Additional details and our problem formulation can be found in the
+full Dunshire documentation. The state-of-the-art is that only
+symmetric games can be solved efficiently, and thus the linear games
+supported by Dunshire are a compromise between the two: the cones are
+symmetric, but the players get to choose two interior points.
 
-Requirements
-------------
-
-The only requirement is the CVXOPT library, available for most Linux
-distributions. Dunshire is targeted at python-3.x, but python-2.x will
-probably work too.
-
-[1] M. S. Gowda and G. Ravindran. On the game-theoretic value of a
-    linear transformation relative to a self-dual cone. Linear Algebra
-    and its Applications, 469:440-463, 2015.
-
-[2] You wish.
-
-[3] http://cvxopt.org/
+Only the nonnegative orthant and the ice-cream cone are supported at
+the moment. The symmetric positive-semidefinite cone is coming soon.