Add some info about this function to the docs.

jwg4 · Nov 30, 2023 · 81a908f · 81a908f
1 parent 134ddfc
commit 81a908f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -71,6 +71,11 @@ Now we can call `exact_cover`:
 This is telling us that the 0th row (i.e. A), the 2nd row (i.e. C),
 and the 3rd row (i.e. D) together form an exact cover.
 
+To see the total number of distinct solutions, we can use the function get_solution_count:
+
+    >>> ec.get_solution_count(S)
+    1
+
 See the file examples.md for more detailed examples of use.
 
 

diff --git a/examples.md b/examples.md
@@ -18,3 +18,8 @@ The numpy type to use is defined in the package for convenience and compatibilit
     >>> T = np.array([[1,0,0,1,0],[1,1,1,0,0],[0,1,1,0,0],[0,0,0,0,1]], dtype=DTYPE_FOR_ARRAY)
     >>> print(ec.get_exact_cover(T))
     [0 2 3]
+
+It's also possible to retrieve the total number of solutions to an exact cover problem:
+    >>> ec.get_solution_count(T)
+    1
+