doc/source/user-api.rst

   1 User API Documentation
   2 ---------------------------
   3
   4 You should only need to work with two modules, :mod:`dunshire.cones` and
   5 :mod:`dunshire.games`. For convenience, you can import everything from
   6 the :mod:`dunshire` package, and it will re-export what you need. For
   7 example,
   8
   9 .. testcode::
  10
  11   from dunshire import *
  12   K = IceCream(3)
  13   L = [[1,-1,12],[0,1,22],[-17,1,0]]
  14   e1 = [1,0.5,0.25]
  15   e2 = [1,0.25,0.5]
  16   G = SymmetricLinearGame(L,K,e1,e2)
  17   G.solution()
  18
  19 dunshire.cones module
  20 ~~~~~~~~~~~~~~~~~~~~~
  21
  22 .. automodule:: dunshire.cones
  23     :members:
  24     :undoc-members:
  25     :show-inheritance:
  26
  27 dunshire.games module
  28 ~~~~~~~~~~~~~~~~~~~~~
  29
  30 .. automodule:: dunshire.games
  31     :members:
  32     :undoc-members:
  33     :show-inheritance: