Add sample game generators from bimatrix-generators

docs/qe_apidoc.py

@@ -62,6 +62,15 @@
     :show-inheritance:
 """
 
+game_generators_module_template = """{mod_name}
+{equals}
+
+.. automodule:: quantecon.game_theory.game_generators.{mod_name}
+    :members:
+    :undoc-members:
+    :show-inheritance:
+"""
+
 markov_module_template = """{mod_name}
 {equals}
 
@@ -189,6 +198,13 @@ def model_tool():
     # Alphabetize
     game_theory.sort()
 
+    # list file names with game_theory/game_generators
+    game_generators_files = glob("../quantecon/game_theory/game_generators/[a-z0-9]*.py")
+    game_generators = list(
+        map(lambda x: x.split('/')[-1][:-3], game_generators_files))
+    # Alphabetize
+    game_generators.sort()
+
     # list file names with markov
     markov_files = glob("../quantecon/markov/[a-z0-9]*.py")
     markov = list(map(lambda x: x.split('/')[-1][:-3], markov_files))
@@ -225,6 +241,15 @@ def model_tool():
             equals = "=" * len(mod)
             f.write(game_theory_module_template.format(mod_name=mod, equals=equals))
 
+    for mod in game_generators:
+        new_path = os.path.join("source", "game_theory", "game_generators", mod + ".rst")
+        with open(new_path, "w") as f:
+            equals = "=" * len(mod)
+            f.write(game_generators_module_template.format(
+                mod_name=mod, equals=equals))
+        #Add sudirectory to flat game_theory list for index file
+        game_theory.append("game_generators/{}".format(mod))
+
     # Write file for each markov file
     for mod in markov:
         new_path = os.path.join("source", "markov", mod + ".rst")

docs/source/game_theory.rst

@@ -12,3 +12,4 @@ Game theory
    game_theory/support_enumeration
    game_theory/utilities
    game_theory/vertex_enumeration
+   game_theory/game_generators/bimatrix_generators

docs/source/game_theory/game_generators/bimatrix_generators.rst

@@ -0,0 +1,7 @@
+bimatrix_generators
+===================
+
+.. automodule:: quantecon.game_theory.game_generators.bimatrix_generators
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/util.rst

@@ -5,6 +5,7 @@ Utilities
    :maxdepth: 2
 
    util/array
+   util/combinatorics
    util/common_messages
    util/notebooks
    util/numba

docs/source/util/combinatorics.rst

@@ -0,0 +1,7 @@
+combinatorics
+=============
+
+.. automodule:: quantecon.util.combinatorics
+    :members:
+    :undoc-members:
+    :show-inheritance:

quantecon/game_theory/__init__.py

@@ -10,3 +10,4 @@
 from .lemke_howson import lemke_howson
 from .mclennan_tourky import mclennan_tourky
 from .vertex_enumeration import vertex_enumeration, vertex_enumeration_gen
+from .game_generators import *

quantecon/game_theory/game_generators/__init__.py

@@ -0,0 +1,7 @@
+"""
+game_theory.game_generators
+
+"""
+from .bimatrix_generators import (
+	blotto_game, ranking_game, sgc_game, tournament_game, unit_vector_game
+)