Use proper class for KnuthBendix

Author: james-d-mitchell

docs/source/data-structures/presentations/to-present.rst

@@ -159,15 +159,15 @@ letters of the type of word specified in *Return*.
 
 .. _knuth-bendix-to-presentation:
 
-Converting a :any:`KnuthBendixStringRewriteTrie` to a :any:`PresentationStrings`
+Converting a :any:`KnuthBendix` to a :any:`PresentationStrings`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To construct a :any:`PresentationStrings` from a
-:any:`KnuthBendixStringRewriteTrie`, specify the following values for
+:any:`KnuthBendix`, specify the following values for
 *args*:
 
-    * **kb** (:any:`KnuthBendixStringRewriteTrie`) -- the
-      :any:`KnuthBendixStringRewriteTrie` from which to obtain the rules.
+    * **kb** (:any:`KnuthBendix`) -- the
+      :any:`KnuthBendix` from which to obtain the rules.
 
 Additionally, specify the following for *Return*:
 
@@ -186,7 +186,7 @@ this function.
 
 .. seealso::
 
-    * :any:`KnuthBendixStringRewriteTrie.active_rules`; and
+    * :any:`KnuthBendix.active_rules`; and
     * :any:`Runner.run`.
 
 .. doctest:: Python

docs/source/main-algorithms/froidure-pin/to-froidure-pin.rst

@@ -130,14 +130,14 @@ This function throws a :any:`LibsemigroupsError` if the
 
 .. _knuth-bendix-to-froidure-pin:
 
-Converting a :any:`KnuthBendixStringRewriteTrie` to a :any:`FroidurePinPBR`
+Converting a :any:`KnuthBendix` to a :any:`FroidurePinPBR`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`FroidurePinPBR` from a :any:`KnuthBendixStringRewriteTrie`,
+To construct a :any:`FroidurePinPBR` from a :any:`KnuthBendix`,
 specify the following values for *args*:
 
-    * **kb** (:any:`KnuthBendixStringRewriteTrie`) -- the
-      :any:`KnuthBendixStringRewriteTrie` object being converted.
+    * **kb** (:any:`KnuthBendix`) -- the
+      :any:`KnuthBendix` object being converted.
 
 Additionally, specify the following for *Return*:
 

docs/source/main-algorithms/knuth-bendix/class/index.rst

@@ -4,12 +4,12 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 The KnuthBendix class
 =====================
 
-.. autoclass:: KnuthBendixStringRewriteTrie
+.. autoclass:: KnuthBendix
    :doc-only:
    :class-doc-from: class
 
@@ -25,35 +25,35 @@ Contents
 .. autosummary::
    :signatures: short
 
-   ~KnuthBendixStringRewriteTrie
-   KnuthBendixStringRewriteTrie.active_rules
-   KnuthBendixStringRewriteTrie.check_confluence_interval
-   KnuthBendixStringRewriteTrie.confluent
-   KnuthBendixStringRewriteTrie.confluent_known
-   KnuthBendixStringRewriteTrie.contains
-   KnuthBendixStringRewriteTrie.copy
-   KnuthBendixStringRewriteTrie.currently_contains
-   KnuthBendixStringRewriteTrie.generating_pairs
-   KnuthBendixStringRewriteTrie.gilman_graph
-   KnuthBendixStringRewriteTrie.gilman_graph_node_labels
-   KnuthBendixStringRewriteTrie.max_overlap
-   KnuthBendixStringRewriteTrie.max_pending_rules
-   KnuthBendixStringRewriteTrie.max_rules
-   KnuthBendixStringRewriteTrie.number_of_active_rules
-   KnuthBendixStringRewriteTrie.number_of_classes
-   KnuthBendixStringRewriteTrie.number_of_inactive_rules
-   KnuthBendixStringRewriteTrie.overlap_policy
-   KnuthBendixStringRewriteTrie.presentation
-   KnuthBendixStringRewriteTrie.reduce
-   KnuthBendixStringRewriteTrie.reduce_no_run
-   KnuthBendixStringRewriteTrie.total_rules
+   ~KnuthBendix
+   KnuthBendix.active_rules
+   KnuthBendix.check_confluence_interval
+   KnuthBendix.confluent
+   KnuthBendix.confluent_known
+   KnuthBendix.contains
+   KnuthBendix.copy
+   KnuthBendix.currently_contains
+   KnuthBendix.generating_pairs
+   KnuthBendix.gilman_graph
+   KnuthBendix.gilman_graph_node_labels
+   KnuthBendix.max_overlap
+   KnuthBendix.max_pending_rules
+   KnuthBendix.max_rules
+   KnuthBendix.number_of_active_rules
+   KnuthBendix.number_of_classes
+   KnuthBendix.number_of_inactive_rules
+   KnuthBendix.overlap_policy
+   KnuthBendix.presentation
+   KnuthBendix.reduce
+   KnuthBendix.reduce_no_run
+   KnuthBendix.total_rules
 
 Full API
 --------
 
-.. autoclass:: KnuthBendixStringRewriteTrie
+.. autoclass:: KnuthBendix
    :class-doc-from: init
    :members:
    :inherited-members:
    :exclude-members: 
-      options, run_for, run_until, run, finished, stopped, current_state, dead, internal_generating_pairs, kill, kind, last_report, report, report_every, report_prefix, report_why_we_stopped, reset_last_report, reset_start_time, running, running_for, running_until, start_time, started, state, stopped_by_predicate, success, timed_out, number_of_generating_pairs
+      options, run_for, run_until, run, finished, stopped, current_state, dead, internal_generating_pairs, kill, kind, last_report, report, report_every, report_prefix, report_why_we_stopped, reset_last_report, reset_start_time, running, running_for, running_until, start_time, started, state, stopped_by_predicate, success, timed_out

docs/source/main-algorithms/knuth-bendix/helpers.rst

@@ -10,7 +10,7 @@ Knuth-Bendix helpers
 ====================
 
 This page contains the documentation for various helper functions for
-manipulating :any:`KnuthBendixStringRewriteTrie` objects. All such functions are
+manipulating :any:`KnuthBendix` objects. All such functions are
 contained in the submodule ``libsemigroups_pybind11.knuth_bendix``.
 
 .. seealso::

docs/source/main-algorithms/knuth-bendix/to-knuth-bendix.rst

@@ -6,11 +6,11 @@
 
 .. currentmodule:: libsemigroups_pybind11
 
-Converting to a KnuthBendixStringRewriteTrie
+Converting to a KnuthBendix
 ============================================
 
 This page contains documentation relating to converting
-``libsemigroups_pybind11`` objects into :any:`KnuthBendixStringRewriteTrie`
+``libsemigroups_pybind11`` objects into :any:`KnuthBendix`
 instances using the :any:`to` function.
 
 .. seealso::
@@ -23,7 +23,7 @@ Various uses
 
 Recall that the signature for the :any:`to` function is ``to(*args, Return)``.
 In what follows, we explain how different values of *args* and *Return* may
-be used to construct :any:`KnuthBendixStringRewriteTrie` objects. The following
+be used to construct :any:`KnuthBendix` objects. The following
 options are possible:
 
   * :ref:`todd-coxeter-to-knuth-bendix-default`;
@@ -32,10 +32,10 @@ options are possible:
 
 .. _todd-coxeter-to-knuth-bendix-default:
 
-Converting a :any:`ToddCoxeterWord` to a :any:`KnuthBendixStringRewriteTrie` (default rewriter)
+Converting a :any:`ToddCoxeterWord` to a :any:`KnuthBendix` (default rewriter)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`KnuthBendixStringRewriteTrie` from a
+To construct a :any:`KnuthBendix` from a
 :any:`ToddCoxeterWord` using the default rewriter, specify all of the following
 values for *args*:
 
@@ -46,15 +46,15 @@ values for *args*:
 
 Additionally, specify the following for *Return*:
 
-    * ``KnuthBendix`` for constructing a :any:`KnuthBendixStringRewriteTrie`
+    * ``KnuthBendix`` for constructing a :any:`KnuthBendix`
       with the default rewriter.
 
 This function converts a :any:`ToddCoxeterWord` object *tc* to a
-:any:`KnuthBendixStringRewriteTrie` object using
+:any:`KnuthBendix` object using
 :any:`ToddCoxeterWord.presentation`. This is equivalent to specifying
 ``(KnuthBendix, 'RewriteTrie')`` as described below.
 
-This returned :any:`KnuthBendixStringRewriteTrie` object represents the trivial
+This returned :any:`KnuthBendix` object represents the trivial
 congruence over the semigroup defined by *tc*.
 
 .. doctest:: Python
@@ -87,10 +87,10 @@ congruence over the semigroup defined by *tc*.
 
 .. _todd-coxeter-to-knuth-bendix:
 
-Converting a :any:`ToddCoxeterWord` to a :any:`KnuthBendixStringRewriteTrie`
+Converting a :any:`ToddCoxeterWord` to a :any:`KnuthBendix`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`KnuthBendixStringRewriteTrie` from a
+To construct a :any:`KnuthBendix` from a
 :any:`ToddCoxeterWord`, specify all of the following values for *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
@@ -101,17 +101,17 @@ To construct a :any:`KnuthBendixStringRewriteTrie` from a
 Additionally, specify one of the following for *Return*:
 
     * ``(KnuthBendix, 'RewriteTrie')`` for constructing a
-      :any:`KnuthBendixStringRewriteTrie` with the the ``RewriteTrie'``
+      :any:`KnuthBendix` with the the ``RewriteTrie'``
       rewriter.
     * ``(KnuthBendix, 'RewriteFromLeft')`` for constructing a
-      :any:`KnuthBendixStringRewriteTrie` with the the ``RewriteFromLeft'``
+      :any:`KnuthBendix` with the the ``RewriteFromLeft'``
       rewriter.
 
 This function converts a :any:`ToddCoxeterWord` object *tc* to a
-:any:`KnuthBendixStringRewriteTrie` object with the rewriter as specified above,
+:any:`KnuthBendix` object with the rewriter as specified above,
 using :any:`ToddCoxeterWord.presentation`.
 
-This returned :any:`KnuthBendixStringRewriteTrie` object represents the trivial
+This returned :any:`KnuthBendix` object represents the trivial
 congruence over the semigroup defined by *tc*.
 
 .. doctest:: Python
@@ -144,10 +144,10 @@ congruence over the semigroup defined by *tc*.
 
 .. _froidure-pin-to-knuth-bendix:
 
-Converting a :any:`FroidurePinPBR` to a :any:`KnuthBendixStringRewriteTrie`
+Converting a :any:`FroidurePinPBR` to a :any:`KnuthBendix`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`KnuthBendixStringRewriteTrie` from a
+To construct a :any:`KnuthBendix` from a
 :any:`FroidurePinPBR`, specify all of the following values for *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
@@ -158,26 +158,26 @@ To construct a :any:`KnuthBendixStringRewriteTrie` from a
 Additionally, specify one of the following for *Return*:
 
     * ``(KnuthBendix, str, 'RewriteTrie')`` for constructing a
-      :any:`KnuthBendixStringRewriteTrie` on words with type ``str`` using the
+      :any:`KnuthBendix` on words with type ``str`` using the
       ``RewriteTrie'`` rewriter.
     * ``(KnuthBendix, List[int], 'RewriteTrie')`` for constructing a
-      :any:`KnuthBendixStringRewriteTrie` on words with type ``List[int]`` using
+      :any:`KnuthBendix` on words with type ``List[int]`` using
       the ``RewriteTrie'`` rewriter.
     * ``(KnuthBendix, str, 'RewriteFromLeft')`` for constructing a
-      :any:`KnuthBendixStringRewriteTrie` on words with type ``str`` using the
+      :any:`KnuthBendix` on words with type ``str`` using the
       ``RewriteFromLeft'`` rewriter.
     * ``(KnuthBendix, List[int], 'RewriteFromLeft')`` for constructing a
-      :any:`KnuthBendixStringRewriteTrie` on words with type ``List[int]`` using
+      :any:`KnuthBendix` on words with type ``List[int]`` using
       the ``RewriteFromLeft'`` rewriter.
 
 
 This function converts a :any:`FroidurePinPBR` object *fpb* to a
-:any:`KnuthBendixStringRewriteTrie` object with the word type and rewriter as
+:any:`KnuthBendix` object with the word type and rewriter as
 specified above. This is done using the presentation obtained from
 ``to(fpb, Return=(Presentation, Word)`` where ``Word`` is either ``str`` or
 ``List[int]``.
 
-This returned :any:`KnuthBendixStringRewriteTrie` object represents the trivial
+This returned :any:`KnuthBendix` object represents the trivial
 congruence over the semigroup defined by *fpb*.
 
 .. doctest:: Python

docs/source/main-algorithms/todd-coxeter/class/common.rst

@@ -11,8 +11,7 @@ Common methods
 
 This page contains documentation of the methods of :any:`ToddCoxeterWord` that
 are implemented in all of the classes :any:`Congruence`,
-:any:`Kambites`, :any:`KnuthBendixStringRewriteTrie`, and
-:any:`ToddCoxeterWord`.
+:any:`Kambites`, :any:`KnuthBendix`, and :any:`ToddCoxeterWord`.
 
 .. automethod:: ToddCoxeterWord.add_generating_pair
 .. automethod:: ToddCoxeterWord.contains

docs/source/main-algorithms/todd-coxeter/to-todd-coxeter.rst

@@ -91,23 +91,23 @@ This will throw a :any:`LibsemigroupsError` if *wg* is not the
 
 .. _knuth-bendix-to-todd-coxeter:
 
-Converting a :any:`KnuthBendixStringRewriteTrie` to a :any:`ToddCoxeterWord`
+Converting a :any:`KnuthBendix` to a :any:`ToddCoxeterWord`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To construct a :any:`ToddCoxeterWord` from a
-:any:`KnuthBendixStringRewriteTrie` specify all of the following values for
+:any:`KnuthBendix` specify all of the following values for
 *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
       constructed.
-    * **kb** (:any:`KnuthBendixStringRewriteTrie`) -- the
-      :any:`KnuthBendixStringRewriteTrie` object being converted.
+    * **kb** (:any:`KnuthBendix`) -- the
+      :any:`KnuthBendix` object being converted.
 
 Additionally, specify the following for *Return*:
 
     * ``ToddCoxeter`` for constructing a :any:`ToddCoxeterWord`.
 
-This function converts the :any:`KnuthBendixStringRewriteTrie` object *kb* into
+This function converts the :any:`KnuthBendix` object *kb* into
 a :any:`ToddCoxeterWord` object using the right Cayley graph of the semigroup
 represented by *kb*.
 

libsemigroups_pybind11/congruence.py

@@ -35,7 +35,6 @@
 from .detail.decorators import (
     may_return_positive_infinity as _may_return_positive_infinity,
     copydoc as _copydoc,
-    returns_self as _returns_self,
 )
 
 from .detail import cong_intf
@@ -95,8 +94,7 @@ def get(self: Self, t: type):
 
         :param t:
             The type of object being sought (must be
-            :any:`Kambites`,
-            :any:`KnuthBendixStringRewriteTrie`, or :any:`ToddCoxeterWord`).
+            :any:`Kambites`, :any:`KnuthBendix`, or :any:`ToddCoxeterWord`).
         :type t: type
 
         :returns: A copy of the instance of type *t*.
@@ -105,7 +103,7 @@ def get(self: Self, t: type):
             if there is no object of type *t* within *self*.
         """
         if t is _KnuthBendix:
-            return self._get_knuth_bendix()
+            return _KnuthBendix(self._get_knuth_bendix())
         if t is _ToddCoxeter:
             return self._get_todd_coxeter()
         if t is _Kambites:
@@ -124,7 +122,7 @@ def has(self: Self, t: type) -> bool:
 
         :param t:
             The type of object being sought (must be :any:`Kambites`,
-            :any:`KnuthBendixStringRewriteTrie`, or :any:`ToddCoxeterWord`).
+            :any:`KnuthBendix`, or :any:`ToddCoxeterWord`).
         :type t: type
 
         :returns: Whether or not there is an object of type *t* in *self*.
@@ -137,20 +135,10 @@ def has(self: Self, t: type) -> bool:
             return self._has_kambites()
         return False
 
-    @_copydoc(_CongruenceWord.add_generating_pair)
-    @_returns_self
-    def add_generating_pair(self: Self, *args) -> Self:
-        return _to_cxx(self).add_generating_pair(*args)
-
     @_copydoc(_CongruenceWord.copy)
     def copy(self: Self) -> Self:
         return Congruence(_to_cxx(self).copy())
 
-    @_copydoc(_CongruenceWord.init)
-    @_returns_self
-    def init(self: Self, *args) -> Self:
-        return _to_cxx(self).init(*args)
-
     @_copydoc(_CongruenceWord._number_of_classes)
     @_may_return_positive_infinity
     def number_of_classes(self: Self) -> int:

libsemigroups_pybind11/detail/cxx_wrapper.py

@@ -95,9 +95,7 @@ def __getattr__(self: Self, meth_name: str):
         def cxx_fn_wrapper(*args) -> Any:
             if len(args) == 1 and isinstance(args[0], list):
                 args = args[0]
-                return getattr(self._cxx_obj, meth_name)(
-                    [to_cxx(x) for x in args]
-                )
+                return getattr(self._cxx_obj, meth_name)([to_cxx(x) for x in args])
             return getattr(self._cxx_obj, meth_name)(*(to_cxx(x) for x in args))
 
         return cxx_fn_wrapper
@@ -158,9 +156,10 @@ def _cxx_obj_type_from(self: Self, samples=(), types=()) -> Any:
 # TODO proper annotations
 def wrap_cxx_mem_fn(cxx_mem_fn: pybind11_type) -> Callable:
     def cxx_mem_fn_wrapper(self, *args):
-        return getattr(self._cxx_obj, cxx_mem_fn.__name__)(
-            *(to_cxx(x) for x in args)
-        )
+        result = getattr(self._cxx_obj, cxx_mem_fn.__name__)(*(to_cxx(x) for x in args))
+        if isinstance(result, type(self._cxx_obj)):
+            return self
+        return result
 
     update_wrapper(cxx_mem_fn_wrapper, cxx_mem_fn)
     return cxx_mem_fn_wrapper
@@ -181,9 +180,7 @@ def copy_cxx_mem_fns(cxx_class: pybind11_type, py_class: CxxWrapper) -> None:
     that call the cxx member function on the _cxx_obj.
     """
     for py_meth_name in dir(cxx_class):
-        if not py_meth_name.startswith("_") and py_meth_name not in dir(
-            py_class
-        ):
+        if not py_meth_name.startswith("_") and py_meth_name not in dir(py_class):
             setattr(
                 py_class,
                 py_meth_name,