sims: use keyword arg "word" instead of default ctor

Author: james-d-mitchell

src/libsemigroups_pybind11/sims.py

@@ -44,21 +44,36 @@
 
 class _SimsBase(_CxxWrapper):
     def __init__(self: _Self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
+        super().__init__(*args, optional_kwargs=("word",), **kwargs)
         if _to_cxx(self) is not None:
             return
         if len(args) not in (0, 1):
             raise TypeError(
                 f"expected 0 or 1 positional arguments but found {len(args)}"
             )
-        if len(kwargs) != 0:
+        if len(args) != 0 and len(kwargs) != 0:
             raise TypeError(
-                f"expected 0 keyword arguments, but found {len(kwargs)}"
+                "expected either 1 positional argument or 1"
+                f"keyword argument (but not both), but found {len(args)} and {len(kwargs)}"
             )
+        if len(args) == 0:
+            if "word" not in kwargs:
+                raise TypeError(
+                    f'expected the keyword argument "word", but found {tuple(kwargs.keys())}'
+                )
+            # for when Sims has a facade
+            # if kwargs["word"] not in (str, list[int]):
+            #     raise ValueError(
+            #         'the keyword argument "word" must be str or list[int], '
+            #         f"but found {kwargs['word']}"
+            #     )
+            if kwargs["word"] != list[int]:
+                raise ValueError(
+                    f'the keyword argument "word" must be list[int], but found {kwargs["word"]}'
+                )
 
         if len(args) == 0:
-            # self.Word = kwargs["Word"]
-            self.py_template_params = (list[int],)
+            self.py_template_params = (kwargs["word"],)
         else:
             if isinstance(args[0], _Presentation):
                 self.py_template_params = args[0].py_template_params
@@ -240,15 +255,31 @@ class SimsRefinerFaithful(
 
     @_copydoc(_SimsRefinerFaithful.__init__)
     def __init__(self: _Self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
+        super().__init__(*args, optional_kwargs=("word",), **kwargs)
         if _to_cxx(self) is not None:
             return
 
+        if len(args) not in (0, 1):
+            raise TypeError(
+                f"expected 0 or 1 positional arguments but found {len(args)}"
+            )
+        if len(args) != 0 and len(kwargs) != 0:
+            raise TypeError(
+                "expected either 1 positional argument or 1"
+                f"keyword argument (but not both), but found {len(args)} and {len(kwargs)}"
+            )
+        if len(args) == 0:
+            if "word" not in kwargs:
+                raise TypeError(
+                    f'expected the keyword argument "word", but found {tuple(kwargs.keys())}'
+                )
+            if kwargs["word"] != list[int]:
+                raise ValueError(
+                    f'the keyword argument "word" must be list[int], but found {kwargs["word"]}'
+                )
         if len(args) == 0:
-            # self.Word = kwargs["Word"]
-            self.py_template_params = (list[int],)
+            self.py_template_params = (kwargs["word"],)
         else:
-            assert len(args) == 1
             if (
                 isinstance(args[0], list)
                 and all(isinstance(x, list) for x in args[0])

src/sims.cpp

@@ -675,10 +675,13 @@ a congruence.
            [](Sims1 const& s1) { return to_human_readable_repr(s1); });
 
     s1.def(py::init<>(), R"pbdoc(
-:sig=(self: Sims1) -> None:
-Default constructor.
+:sig=(self: Sims1, word: type) -> None:
+
+This function returns an uninitialized :any:`Sims1` object that uses
+words of type specified by *word*.
 
-This function returns an uninitialized :any:`Sims1` object.
+:Keyword Arguments:
+    * **word** (*type*) -- the type of words to use, must be ``list[int]``.
 )pbdoc");
 
     s1.def(py::init<Presentation<word_type> const&>(),
@@ -899,9 +902,13 @@ on the classes of a congruence.
            [](Sims2 const& s2) { return to_human_readable_repr(s2); });
 
     s2.def(py::init<>(), R"pbdoc(
-Default constructor.
+:sig=(self: Sims2, word: type) -> None:
 
-This function returns an uninitialized :any:`Sims2` object.
+This function returns an uninitialized :any:`Sims2` object that uses
+words of type specified by *word*.
+
+:Keyword Arguments:
+    * **word** (*type*) -- the type of words to use, must be ``list[int]``.
 )pbdoc");
 
     s2.def("__copy__", [](Sims2 const& self) { return Sims2(self); });
@@ -1121,9 +1128,13 @@ returned (with ``0`` nodes and ``0`` edges).
            [](RepOrc const& ro) { return to_human_readable_repr(ro); });
 
     ro.def(py::init<>(), R"pbdoc(
-Default constructor.
+:sig=(self: RepOrc, word: type) -> None:
+
+This function returns an uninitialized :any:`RepOrc` object that uses
+words of type specified by *word*.
 
-This function returns an uninitialized :any:`RepOrc` object.
+:Keyword Arguments:
+    * **word** (*type*) -- the type of words to use, must be ``list[int]``.
 )pbdoc");
 
     ro.def(
@@ -1279,9 +1290,13 @@ edges).
     });
 
     mro.def(py::init<>(), R"pbdoc(
-Default constructor.
+:sig=(self: MinimalRepOrc, word: type) -> None:
+
+This function returns an uninitialized :any:`MinimalRepOrc` object that uses
+words of type specified by *word*.
 
-This function returns an uninitialized :any:`MinimalRepOrc` object.
+:Keyword Arguments:
+    * **word** (*type*) -- the type of words to use, must be ``list[int]``.
 )pbdoc");
 
     mro.def(
@@ -1386,9 +1401,13 @@ v)` such that every vertex of the word graph is compatible with :math:`(u, v)`.
     });
 
     srf.def(py::init<>(), R"pbdoc(
-Default constructor.
+:sig=(self: SimsRefinerFaithful, word: type) -> None:
 
-This function returns an uninitialized :any:`SimsRefinerFaithful` object.
+This function returns an uninitialized :any:`SimsRefinerFaithful` object that uses
+words of type specified by *word*.
+
+:Keyword Arguments:
+    * **word** (*type*) -- the type of words to use, must be ``list[int]``.
 )pbdoc");
 
     srf.def(py::init<std::vector<word_type> const&>(),
@@ -1510,9 +1529,13 @@ or two-sided congruences arising from ideals (Rees congruences).
     });
 
     sri.def(py::init<>(), R"pbdoc(
-Default constructor.
+:sig=(self: SimsRefinerIdeals, word: type) -> None:
+
+This function returns an uninitialized :any:`SimsRefinerIdeals` object that uses
+words of type specified by *word*.
 
-This function returns an uninitialized :any:`SimsRefinerIdeals` object.
+:Keyword Arguments:
+    * **word** (*type*) -- the type of words to use, must be ``list[int]``.
 )pbdoc");
     sri.def(py::init<Presentation<word_type> const&>(), R"pbdoc(
 :sig=(self: SimsRefinerIdeals, p: Presentation) -> None:

tests/test_sims.py

@@ -89,7 +89,7 @@ def test_sims1_000():
     presentation.add_rule(p, [1, 1], [1])
     presentation.add_rule(p, [0, 1, 0, 1], [0])
 
-    S = Sims1()
+    S = Sims1(word=list[int])
     assert S.presentation(p).number_of_threads(2).number_of_congruences(5) == 6
     with pytest.raises(LibsemigroupsError):
         S.number_of_congruences(0)
@@ -124,7 +124,7 @@ def test_sims1_000():
         5, lambda wg: check_right_generating_pairs(S, wg)
     )
     presentation.reverse(p)
-    S = Sims1()
+    S = Sims1(word=list[int])
     assert S.presentation(p).number_of_congruences(5) == 9
     for wg in S.iterator(5):
         assert word_graph.follow_path(
@@ -164,7 +164,7 @@ def test_sims1_001():
     presentation.add_rule(p, [1, 1], [1])
     presentation.add_rule(p, [0, 2], [0, 0])
 
-    S = Sims1()
+    S = Sims1(word=list[int])
     S.presentation(p)
     assert S.number_of_congruences(1) == 1
     assert S.number_of_congruences(2) == 3
@@ -203,7 +203,7 @@ def test_sims1_002():
     presentation.add_rule(p, [0, 0, 5, 0, 4], [6])
     presentation.add_rule(p, [0, 4, 2, 2, 1, 5, 2], [6])
     presentation.add_rule(p, [1, 3, 0, 2, 4, 4, 4], [6])
-    S = Sims1()
+    S = Sims1(word=list[int])
     S.presentation(p)
 
     S.for_each(3, lambda wg: check_right_generating_pairs(S, wg))
@@ -290,7 +290,7 @@ def test_sims1_003():
     presentation.add_rule(p, "aaCac", "e")
     presentation.add_rule(p, "acbbACb", "e")
     presentation.add_rule(p, "ABabccc", "e")
-    S = Sims1()
+    S = Sims1(word=list[int])
     S.presentation(to(p, rtype=(Presentation, list[int])))
     assert S.number_of_congruences(3) == 14
 
@@ -331,12 +331,12 @@ def test_sims1_004():
     assert S.number_of_congruences(16) == 105
     assert S.number_of_congruences(17) == 105
 
-    T = Sims2()
+    T = Sims2(word=list[int])
     T.presentation(p)
     T.number_of_threads(2)
     assert T.number_of_congruences(16) == 13
 
-    orc = MinimalRepOrc()
+    orc = MinimalRepOrc(word=list[int])
     d = (
         orc.presentation(p)
         .target_size(15)
@@ -359,7 +359,7 @@ def test_sims_refiner_faithful_128():
     forbid = [[0], [0, 1], [0, 0], []]
     pruno = SimsRefinerFaithful(forbid)
 
-    S = Sims1()
+    S = Sims1(word=list[int])
     S.presentation(p)
     S.add_pruner(pruno)
     assert (
@@ -577,34 +577,34 @@ def test_sims2_return_policy():
 
 
 def test_rep_orc_return_policy():
-    ro = RepOrc()
+    ro = RepOrc(word=list[int])
     assert ro.init() is ro
     assert ro.max_nodes(10) is ro
     assert ro.min_nodes(9) is ro
     assert ro.target_size(27) is ro
 
 
 def test_min_rep_orc_return_policy():
-    ro = MinimalRepOrc()
+    ro = MinimalRepOrc(word=list[int])
     assert ro.init() is ro
     assert ro.target_size(27) is ro
 
 
 def test_sims_refiner_faithful_return_policy():
-    srf = SimsRefinerFaithful()
+    srf = SimsRefinerFaithful(word=list[int])
 
     assert srf.init() is srf
     assert srf.init([[0, 1], [0]]) is srf
 
 
 def test_sims_refiner_faithful_call():
-    srf = SimsRefinerFaithful()
+    srf = SimsRefinerFaithful(word=list[int])
     wg = WordGraph(2, [[0, 1]])
     assert srf(wg)
 
 
 def test_sims_refiner_ideals_return_policy():
-    sri = SimsRefinerIdeals()
+    sri = SimsRefinerIdeals(word=list[int])
     assert sri.presentation() is sri.presentation()
     assert sri.init() is sri
     p = Presentation("ab")