Rename things from upstream

Author: james-d-mitchell

build_tools/__init__.py

@@ -11,4 +11,5 @@ def minimum_libsemigroups_version():
     """Returns the minimum required version of libsemigroups required to build
     libsemigroups_pybind11.
     """
+    # TODO update to 3.7
     return "3.6.1"

src/cong-common.cpp

@@ -1269,9 +1269,14 @@ This function returns the element of *fp* obtained by evaluating *w*.
               });
       }
     }  // bind_froidure_pin_stateful
-  }    // namespace
+  }  // namespace
 
   void init_froidure_pin(py::module& m) {
+    using LenLexTrie = detail::RewritingSystemTrie<ShortLexCompare>;
+    using LenLexSet  = detail::RewritingSystemSet<ShortLexCompare>;
+    using RPOTrie    = detail::RewritingSystemTrie<RecursivePathCompare>;
+    using RPOSet     = detail::RewritingSystemSet<RecursivePathCompare>;
+
     bind_froidure_pin_stateless<Transf<0, uint8_t>>(m, "Transf1");
     bind_froidure_pin_stateless<Transf<0, uint16_t>>(m, "Transf2");
     bind_froidure_pin_stateless<Transf<0, uint32_t>>(m, "Transf4");
@@ -1301,17 +1306,15 @@ This function returns the element of *fp* obtained by evaluating *w*.
     bind_froidure_pin_stateless<NTPMat<0, 0, 0, 0, int64_t>>(m, "NTPMat");
 
     bind_froidure_pin_stateful<
-        detail::KBE<KnuthBendix<std::string, detail::RewriteFromLeft>>>(
-        m, "KBEStringRewriteFromLeft");
-    bind_froidure_pin_stateful<
-        detail::KBE<KnuthBendix<std::string, detail::RewriteTrie>>>(
-        m, "KBEStringRewriteTrie");
-    bind_froidure_pin_stateful<
-        detail::KBE<KnuthBendix<word_type, detail::RewriteFromLeft>>>(
-        m, "KBEWordRewriteFromLeft");
+        detail::KBE<KnuthBendix<std::string, LenLexSet>>>(m,
+                                                          "KBEStringLenLexSet");
     bind_froidure_pin_stateful<
-        detail::KBE<KnuthBendix<word_type, detail::RewriteTrie>>>(
-        m, "KBEWordRewriteTrie");
+        detail::KBE<KnuthBendix<std::string, LenLexTrie>>>(
+        m, "KBEStringLenLexTrie");
+    bind_froidure_pin_stateful<detail::KBE<KnuthBendix<word_type, LenLexSet>>>(
+        m, "KBEWordLenLexSet");
+    bind_froidure_pin_stateful<detail::KBE<KnuthBendix<word_type, LenLexTrie>>>(
+        m, "KBEWordLenLexTrie");
 
     bind_froidure_pin_stateful<detail::KE<std::string>>(m, "KEString");
     bind_froidure_pin_stateful<detail::KE<detail::MultiView<std::string>>>(

src/froidure-pin.cpp

@@ -73,18 +73,20 @@ namespace libsemigroups {
   }
 
   void init_kbe(py::module& m) {
-    using KBEStringTrie
-        = detail::KBE<KnuthBendix<std::string, detail::RewriteTrie>>;
-    using KBEWordTrie
-        = detail::KBE<KnuthBendix<word_type, detail::RewriteTrie>>;
-    using KBEStringFromLeft
-        = detail::KBE<KnuthBendix<std::string, detail::RewriteFromLeft>>;
-    using KBEWordFromLeft
-        = detail::KBE<KnuthBendix<word_type, detail::RewriteFromLeft>>;
-
-    bind_kbe<KBEStringTrie>(m, "KBEStringTrie");
-    bind_kbe<KBEWordTrie>(m, "KBEWordTrie");
-    bind_kbe<KBEStringFromLeft>(m, "KBEStringFromLeft");
-    bind_kbe<KBEWordFromLeft>(m, "KBEWordFromLeft");
+    using LenLexTrie = detail::RewritingSystemTrie<ShortLexCompare>;
+    using LenLexSet  = detail::RewritingSystemSet<ShortLexCompare>;
+    using RPOTrie    = detail::RewritingSystemTrie<RecursivePathCompare>;
+    using RPOSet     = detail::RewritingSystemSet<RecursivePathCompare>;
+
+    using KBEStringLenLexTrie
+        = detail::KBE<KnuthBendix<std::string, LenLexTrie>>;
+    using KBEWordLenLexTrie  = detail::KBE<KnuthBendix<word_type, LenLexTrie>>;
+    using KBEStringLenLexSet = detail::KBE<KnuthBendix<std::string, LenLexSet>>;
+    using KBEWordLenLexSet   = detail::KBE<KnuthBendix<word_type, LenLexSet>>;
+
+    bind_kbe<KBEStringLenLexTrie>(m, "KBEStringLenLexTrie");
+    bind_kbe<KBEWordLenLexTrie>(m, "KBEWordLenLexTrie");
+    bind_kbe<KBEStringLenLexSet>(m, "KBEStringLenLexSet");
+    bind_kbe<KBEWordLenLexSet>(m, "KBEWordLenLexSet");
   }
 }  // namespace libsemigroups

src/kbe.cpp

@@ -507,9 +507,14 @@ infinite; ``False`` is returned if it is not.
   }  // namespace detail
 
   void init_detail_knuth_bendix_impl(py::module& m) {
-    detail::bind_detail_knuth_bendix_impl<detail::RewriteFromLeft>(
-        m, "KnuthBendixImplRewriteFromLeft");
-    detail::bind_detail_knuth_bendix_impl<detail::RewriteTrie>(
-        m, "KnuthBendixImplRewriteTrie");
+    using LenLexTrie = detail::RewritingSystemTrie<ShortLexCompare>;
+    using LenLexSet  = detail::RewritingSystemSet<ShortLexCompare>;
+    using RPOTrie    = detail::RewritingSystemTrie<RecursivePathCompare>;
+    using RPOSet     = detail::RewritingSystemSet<RecursivePathCompare>;
+
+    detail::bind_detail_knuth_bendix_impl<LenLexSet>(
+        m, "KnuthBendixImplLenLexSet");
+    detail::bind_detail_knuth_bendix_impl<LenLexTrie>(
+        m, "KnuthBendixImplLenLexTrie");
   }
 }  // namespace libsemigroups

src/knuth-bendix-impl.cpp

@@ -87,6 +87,7 @@ nested class :any:`KnuthBendix.options`.
       def_construct_default(
           thing,
           "KnuthBendix",
+          // TODO update
           doc{.extra_kwargs = ", rewriter: str", .extra_kwargs_doc = R"pbdoc(
     * **rewriter** (*str*) -- the type of rewriter to use, must be either ``"RewriteTrie"`` or ``"RewriteFromLeft"``.)pbdoc"sv});
 
@@ -386,7 +387,7 @@ Copy a :any:`NormalFormRange` object.
                 });
       thing.def("next", [](NormalFormRange& nfr) { nfr.next(); });
     }  // bind_normal_form_range
-  }    // namespace
+  }  // namespace
 
   template <typename Word>
   void bind_redundant_rule(py::module& m) {
@@ -447,25 +448,25 @@ redundant in this way, then ``None`` is returned.
   }
 
   void init_knuth_bendix(py::module& m) {
-    using RewriteTrie     = detail::RewriteTrie;
-    using RewriteFromLeft = detail::RewriteFromLeft;
-
-    bind_knuth_bendix<word_type, RewriteTrie>(m, "KnuthBendixWordRewriteTrie");
-    bind_knuth_bendix<word_type, RewriteFromLeft>(
-        m, "KnuthBendixWordRewriteFromLeft");
-    bind_knuth_bendix<std::string, RewriteTrie>(m,
-                                                "KnuthBendixStringRewriteTrie");
-    bind_knuth_bendix<std::string, RewriteFromLeft>(
-        m, "KnuthBendixStringRewriteFromLeft");
-
-    bind_normal_form_range<word_type, RewriteTrie>(
-        m, "KnuthBendixNormalFormRangeWordRewriteTrie");
-    bind_normal_form_range<word_type, RewriteFromLeft>(
-        m, "KnuthBendixNormalFormRangeWordRewriteFromLeft");
-    bind_normal_form_range<std::string, RewriteTrie>(
-        m, "KnuthBendixNormalFormRangeStringRewriteTrie");
-    bind_normal_form_range<std::string, RewriteFromLeft>(
-        m, "KnuthBendixNormalFormRangeStringRewriteFromLeft");
+    using LenLexTrie = detail::RewritingSystemTrie<ShortLexCompare>;
+    using LenLexSet  = detail::RewritingSystemSet<ShortLexCompare>;
+    using RPOTrie    = detail::RewritingSystemTrie<RecursivePathCompare>;
+    using RPOSet     = detail::RewritingSystemSet<RecursivePathCompare>;
+
+    bind_knuth_bendix<word_type, LenLexTrie>(m, "KnuthBendixWordLenLexTrie");
+    bind_knuth_bendix<word_type, LenLexSet>(m, "KnuthBendixWordLenLexSet");
+    bind_knuth_bendix<std::string, LenLexTrie>(m,
+                                               "KnuthBendixStringLenLexTrie");
+    bind_knuth_bendix<std::string, LenLexSet>(m, "KnuthBendixStringLenLexSet");
+
+    bind_normal_form_range<word_type, LenLexTrie>(
+        m, "KnuthBendixNormalFormRangeWordLenLexTrie");
+    bind_normal_form_range<word_type, LenLexSet>(
+        m, "KnuthBendixNormalFormRangeWordLenLexSet");
+    bind_normal_form_range<std::string, LenLexTrie>(
+        m, "KnuthBendixNormalFormRangeStringLenLexTrie");
+    bind_normal_form_range<std::string, LenLexSet>(
+        m, "KnuthBendixNormalFormRangeStringLenLexSet");
 
     bind_redundant_rule<std::string>(m);
     bind_redundant_rule<word_type>(m);

src/knuth-bendix.cpp

@@ -26,10 +26,10 @@
     FroidurePinBMat as _FroidurePinBMat,
     FroidurePinBMat8 as _FroidurePinBMat8,
     FroidurePinIntMat as _FroidurePinIntMat,
-    FroidurePinKBEStringRewriteFromLeft as _FroidurePinKBEStringRewriteFromLeft,
-    FroidurePinKBEStringRewriteTrie as _FroidurePinKBEStringRewriteTrie,
-    FroidurePinKBEWordRewriteFromLeft as _FroidurePinKBEWordRewriteFromLeft,
-    FroidurePinKBEWordRewriteTrie as _FroidurePinKBEWordRewriteTrie,
+    FroidurePinKBEStringLenLexSet as _FroidurePinKBEStringLenLexSet,
+    FroidurePinKBEStringLenLexTrie as _FroidurePinKBEStringLenLexTrie,
+    FroidurePinKBEWordLenLexSet as _FroidurePinKBEWordLenLexSet,
+    FroidurePinKBEWordLenLexTrie as _FroidurePinKBEWordLenLexTrie,
     FroidurePinKEMultiViewString as _FroidurePinKEMultiViewString,
     FroidurePinKEString as _FroidurePinKEString,
     FroidurePinKEWord as _FroidurePinKEWord,
@@ -51,10 +51,10 @@
     FroidurePinTransf2 as _FroidurePinTransf2,
     FroidurePinTransf4 as _FroidurePinTransf4,
     IntMat as _IntMat,
-    KBEStringFromLeft as _KBEStringFromLeft,
-    KBEStringTrie as _KBEStringTrie,
-    KBEWordFromLeft as _KBEWordFromLeft,
-    KBEWordTrie as _KBEWordTrie,
+    KBEStringLenLexSet as _KBEStringLenLexSet,
+    KBEStringLenLexTrie as _KBEStringLenLexTrie,
+    KBEWordLenLexSet as _KBEWordLenLexSet,
+    KBEWordLenLexTrie as _KBEWordLenLexTrie,
     MaxPlusMat as _MaxPlusMat,
     MaxPlusTruncMat as _MaxPlusTruncMat,
     MinPlusMat as _MinPlusMat,
@@ -145,10 +145,10 @@ class FroidurePin(_CxxWrapper):
         (_Transf1,): _FroidurePinTransf1,
         (_Transf2,): _FroidurePinTransf2,
         (_Transf4,): _FroidurePinTransf4,
-        (_KBEStringTrie,): _FroidurePinKBEStringRewriteTrie,
-        (_KBEStringFromLeft,): _FroidurePinKBEStringRewriteFromLeft,
-        (_KBEWordTrie,): _FroidurePinKBEWordRewriteTrie,
-        (_KBEWordFromLeft,): _FroidurePinKBEWordRewriteFromLeft,
+        (_KBEStringLenLexTrie,): _FroidurePinKBEStringLenLexTrie,
+        (_KBEStringLenLexSet,): _FroidurePinKBEStringLenLexSet,
+        (_KBEWordLenLexTrie,): _FroidurePinKBEWordLenLexTrie,
+        (_KBEWordLenLexSet,): _FroidurePinKBEWordLenLexSet,
     } | (
         {
             (_HPCombiPTransf16,): _FroidurePinHPCombiPTransf16,

src/libsemigroups_pybind11/froidure_pin.py

@@ -10,10 +10,10 @@
 """
 
 from _libsemigroups_pybind11 import (
-    KnuthBendixStringRewriteFromLeft as _KnuthBendixStringRewriteFromLeft,
-    KnuthBendixStringRewriteTrie as _KnuthBendixStringRewriteTrie,
-    KnuthBendixWordRewriteFromLeft as _KnuthBendixWordRewriteFromLeft,
-    KnuthBendixWordRewriteTrie as _KnuthBendixWordRewriteTrie,
+    KnuthBendixStringLenLexSet as _KnuthBendixStringLenLexSet,
+    KnuthBendixStringLenLexTrie as _KnuthBendixStringLenLexTrie,
+    KnuthBendixWordLenLexSet as _KnuthBendixWordLenLexSet,
+    KnuthBendixWordLenLexTrie as _KnuthBendixWordLenLexTrie,
     knuth_bendix_by_overlap_length as _knuth_bendix_by_overlap_length,
     knuth_bendix_is_reduced as _knuth_bendix_is_reduced,
     knuth_bendix_non_trivial_classes as _knuth_bendix_non_trivial_classes,
@@ -38,15 +38,15 @@
 
 
 class KnuthBendix(_CongruenceCommon):
-    __doc__ = _KnuthBendixStringRewriteTrie.__doc__
+    __doc__ = _KnuthBendixStringLenLexTrie.__doc__
 
     _py_template_params_to_cxx_type = {
-        (list[int],): _KnuthBendixWordRewriteTrie,
-        (str,): _KnuthBendixStringRewriteTrie,
-        (list[int], "RewriteTrie"): _KnuthBendixWordRewriteTrie,
-        (str, "RewriteTrie"): _KnuthBendixStringRewriteTrie,
-        (list[int], "RewriteFromLeft"): _KnuthBendixWordRewriteFromLeft,
-        (str, "RewriteFromLeft"): _KnuthBendixStringRewriteFromLeft,
+        (list[int],): _KnuthBendixWordLenLexTrie,
+        (str,): _KnuthBendixStringLenLexTrie,
+        (list[int], "LenLexTrie"): _KnuthBendixWordLenLexTrie,
+        (str, "LenLexTrie"): _KnuthBendixStringLenLexTrie,
+        (list[int], "LenLexSet"): _KnuthBendixWordLenLexSet,
+        (str, "LenLexSet"): _KnuthBendixStringLenLexSet,
     }
 
     _cxx_type_to_py_template_params = dict(
@@ -59,14 +59,14 @@ class KnuthBendix(_CongruenceCommon):
 
     _all_wrapped_cxx_types = {*_py_template_params_to_cxx_type.values()}
 
-    options = _KnuthBendixStringRewriteTrie.options
+    options = _KnuthBendixStringLenLexTrie.options
 
-    @_copydoc(_KnuthBendixStringRewriteTrie.__init__)
-    def __init__(self, *args, rewriter="RewriteTrie", **kwargs) -> None:
-        if rewriter not in ("RewriteFromLeft", "RewriteTrie"):
+    @_copydoc(_KnuthBendixStringLenLexTrie.__init__)
+    def __init__(self, *args, rewriter="LenLexTrie", **kwargs) -> None:
+        if rewriter not in ("LenLexSet", "LenLexTrie"):
             raise TypeError(
                 f'expected the keyword argument "rewriter" to be '
-                f'"RewriteFromLeft" or "RewriteTrie", but found "{rewriter}"'
+                f'"LenLexSet" or "LenLexTrie", but found "{rewriter}"'
             )
 
         msg = f"""expected either:
@@ -93,11 +93,11 @@ def __init__(self, *args, rewriter="RewriteTrie", **kwargs) -> None:
 # Copy mem fns from sample C++ type and register types
 ########################################################################
 
-_copy_cxx_mem_fns(_KnuthBendixStringRewriteTrie, KnuthBendix)
-_register_cxx_wrapped_type(_KnuthBendixStringRewriteTrie, KnuthBendix)
-_register_cxx_wrapped_type(_KnuthBendixWordRewriteTrie, KnuthBendix)
-_register_cxx_wrapped_type(_KnuthBendixStringRewriteFromLeft, KnuthBendix)
-_register_cxx_wrapped_type(_KnuthBendixWordRewriteFromLeft, KnuthBendix)
+_copy_cxx_mem_fns(_KnuthBendixStringLenLexTrie, KnuthBendix)
+_register_cxx_wrapped_type(_KnuthBendixStringLenLexTrie, KnuthBendix)
+_register_cxx_wrapped_type(_KnuthBendixWordLenLexTrie, KnuthBendix)
+_register_cxx_wrapped_type(_KnuthBendixStringLenLexSet, KnuthBendix)
+_register_cxx_wrapped_type(_KnuthBendixWordLenLexSet, KnuthBendix)
 
 ########################################################################
 # Helpers

src/libsemigroups_pybind11/knuth_bendix.py

@@ -18,12 +18,12 @@
     to_inverse_presentation_string as _to_inverse_presentation_string,
     to_inverse_presentation_word as _to_inverse_presentation_word,
     to_knuth_bendix as _to_knuth_bendix,
-    to_knuth_bendix_RewriteFromLeft as _to_knuth_bendix_RewriteFromLeft,
-    to_knuth_bendix_RewriteTrie as _to_knuth_bendix_RewriteTrie,
-    to_knuth_bendix_string_RewriteFromLeft as _to_knuth_bendix_string_RewriteFromLeft,
-    to_knuth_bendix_string_RewriteTrie as _to_knuth_bendix_string_RewriteTrie,
-    to_knuth_bendix_word_RewriteFromLeft as _to_knuth_bendix_word_RewriteFromLeft,
-    to_knuth_bendix_word_RewriteTrie as _to_knuth_bendix_word_RewriteTrie,
+    to_knuth_bendix_LenLexSet as _to_knuth_bendix_LenLexSet,
+    to_knuth_bendix_LenLexTrie as _to_knuth_bendix_LenLexTrie,
+    to_knuth_bendix_string_LenLexSet as _to_knuth_bendix_string_LenLexSet,
+    to_knuth_bendix_string_LenLexTrie as _to_knuth_bendix_string_LenLexTrie,
+    to_knuth_bendix_word_LenLexSet as _to_knuth_bendix_word_LenLexSet,
+    to_knuth_bendix_word_LenLexTrie as _to_knuth_bendix_word_LenLexTrie,
     to_presentation as _to_presentation,
     to_presentation_string as _to_presentation_string,
     to_presentation_word as _to_presentation_word,
@@ -69,12 +69,12 @@ def _nice_name(type_list):
     (_InversePresentation, list[int]): _to_inverse_presentation_word,
     (_InversePresentation, str): _to_inverse_presentation_string,
     (_KnuthBendix,): _to_knuth_bendix,
-    (_KnuthBendix, "RewriteTrie"): _to_knuth_bendix_RewriteTrie,
-    (_KnuthBendix, "RewriteFromLeft"): _to_knuth_bendix_RewriteFromLeft,
-    (_KnuthBendix, list[int], "RewriteFromLeft"): _to_knuth_bendix_word_RewriteFromLeft,
-    (_KnuthBendix, list[int], "RewriteTrie"): _to_knuth_bendix_word_RewriteTrie,
-    (_KnuthBendix, str, "RewriteFromLeft"): _to_knuth_bendix_string_RewriteFromLeft,
-    (_KnuthBendix, str, "RewriteTrie"): _to_knuth_bendix_string_RewriteTrie,
+    (_KnuthBendix, "LenLexTrie"): _to_knuth_bendix_LenLexTrie,
+    (_KnuthBendix, "LenLexSet"): _to_knuth_bendix_LenLexSet,
+    (_KnuthBendix, list[int], "LenLexSet"): _to_knuth_bendix_word_LenLexSet,
+    (_KnuthBendix, list[int], "LenLexTrie"): _to_knuth_bendix_word_LenLexTrie,
+    (_KnuthBendix, str, "LenLexSet"): _to_knuth_bendix_string_LenLexSet,
+    (_KnuthBendix, str, "LenLexTrie"): _to_knuth_bendix_string_LenLexTrie,
     (_Presentation,): _to_presentation,
     (_Presentation, str): _to_presentation_string,
     (_Presentation, list[int]): _to_presentation_word,

src/libsemigroups_pybind11/to.py

@@ -52,6 +52,11 @@ namespace libsemigroups {
   }  // namespace
 
   void init_to_froidure_pin(py::module& m) {
+    using LenLexTrie = detail::RewritingSystemTrie<ShortLexCompare>;
+    using LenLexSet  = detail::RewritingSystemSet<ShortLexCompare>;
+    using RPOTrie    = detail::RewritingSystemTrie<RecursivePathCompare>;
+    using RPOSet     = detail::RewritingSystemSet<RecursivePathCompare>;
+
     // Congruence
     bind_to_froidure_pin<Congruence<std::string>>(m);
     bind_to_froidure_pin<Congruence<word_type>>(m);
@@ -62,10 +67,10 @@ namespace libsemigroups {
     bind_to_froidure_pin<Kambites<word_type>>(m);
 
     // KnuthBendix
-    bind_to_froidure_pin<KnuthBendix<std::string, detail::RewriteFromLeft>>(m);
-    bind_to_froidure_pin<KnuthBendix<std::string, detail::RewriteTrie>>(m);
-    bind_to_froidure_pin<KnuthBendix<word_type, detail::RewriteFromLeft>>(m);
-    bind_to_froidure_pin<KnuthBendix<word_type, detail::RewriteTrie>>(m);
+    bind_to_froidure_pin<KnuthBendix<std::string, LenLexSet>>(m);
+    bind_to_froidure_pin<KnuthBendix<std::string, LenLexTrie>>(m);
+    bind_to_froidure_pin<KnuthBendix<word_type, LenLexSet>>(m);
+    bind_to_froidure_pin<KnuthBendix<word_type, LenLexTrie>>(m);
 
     // ToddCoxeter
     bind_to_froidure_pin<ToddCoxeter<std::string>>(m);