Action renovation x3

Author: james-d-mitchell

docs/source/_ext/libsemigroups_pybind11_extensions.py

@@ -60,9 +60,7 @@ def doc_only_run(self):
         docstring = list(node.findall(condition=desc_content))
 
         if not docstring:
-            logger.warning(
-                f"The docstring for {self.arguments[0]} cannot be found."
-            )
+            logger.warning(f"The docstring for {self.arguments[0]} cannot be found.")
             return []
 
         return docstring
@@ -108,7 +106,6 @@ def no_doc_run(self):
     r"libsemigroups::RepOrc": r"RepOrc",
     r"libsemigroups::MinimalRepOrc": r"MinimalRepOrc",
     (
-        r"libsemigroups::DynamicMatrix<libsemigroups::BooleanPlus, "
         r"libsemigroups::BooleanProd, libsemigroups::BooleanZero, "
         r"libsemigroups::BooleanOne, int>"
     ): r"Matrix",
@@ -151,7 +148,7 @@ def no_doc_run(self):
     # FIXME can't disable signatures in c++ for the next one because it is
     # overloaded, and then there are no signatures at all (and the overloads
     # are seemingly documented as a single function because of this)
-    r"knuth_bendix_non_trivial_classes.*$": "",
+    # r"knuth_bendix_non_trivial_classes.*$": "",
     r"pbr_one\(\*args, \*\*kwargs\)": "",
     r"word_graph_dot\(.*\)(\s*->\s*(\w+::)*\w*)?": "",
 }

docs/source/main-algorithms/action/index.rst

@@ -35,40 +35,20 @@ The following helper functions are also available:
 
   >>> from libsemigroups_pybind11 import RightAction, BMat8
   >>> from libsemigroups_pybind11.bmat8 import row_space_basis
-  >>> o = RightAction(Element=BMat8, Point=BMat8)
-  >>> o.add_seed(row_space_basis(
-  ...     BMat8(
-  ...         [[1, 1, 1, 0],
-  ...          [1, 1, 0, 0],
-  ...          [0, 1, 0, 1],
-  ...          [0, 1, 0, 0]]))
-  ... ).add_generator(
-  ...     BMat8([[1, 0, 0, 0],
-  ...            [0, 1, 0, 0],
-  ...            [0, 0, 1, 0],
-  ...            [0, 0, 0, 1]])
-  ... ).add_generator(
-  ...     BMat8([[0, 1, 0, 0],
-  ...            [1, 0, 0, 0],
-  ...            [0, 0, 1, 0],
-  ...            [0, 0, 0, 1]])
-  ... ).add_generator(
-  ...     BMat8([[0, 1, 0, 0],
-  ...            [0, 0, 1, 0],
-  ...            [0, 0, 0, 1],
-  ...            [1, 0, 0, 0]])
-  ... ).add_generator(
-  ...     BMat8([[1, 0, 0, 0],
-  ...            [0, 1, 0, 0],
-  ...            [0, 0, 1, 0],
-  ...            [1, 0, 0, 1]])
-  ... ).add_generator(
-  ...     BMat8([[1, 0, 0, 0],
-  ...            [0, 1, 0, 0],
-  ...            [0, 0, 1, 0],
-  ...            [0, 0, 0, 0]])
+  >>> o = RightAction(
+  ...     seeds=[
+  ...         row_space_basis(
+  ...             BMat8([[1, 1, 1, 0], [1, 1, 0, 0], [0, 1, 0, 1], [0, 1, 0, 0]])
+  ...         )
+  ...     ],
+  ...     generators=[
+  ...         BMat8([[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1]]),
+  ...         BMat8([[0, 1, 0, 0], [1, 0, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1]]),
+  ...         BMat8([[0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1], [1, 0, 0, 0]]),
+  ...         BMat8([[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [1, 0, 0, 1]]),
+  ...         BMat8([[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 0]]),
+  ...     ],
   ... )
-  <incomplete right action with 5 generators, 1 points>
   >>> len(o)
   553