Use proper class for Congruence

Author: james-d-mitchell

docs/source/conf.py

@@ -56,7 +56,9 @@ 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
@@ -102,7 +104,9 @@ def no_doc_run(self):
 source_suffix = ".rst"
 master_doc = "index"
 project = "libsemigroups_pybind11"
-copyright = "2021-2024, Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
+copyright = (
+    "2021-2024, Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
+)
 author = "Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
 version = "1.0.0"
 release = "1.0.0"
@@ -215,6 +219,7 @@ def no_doc_run(self):
             "KoniecznyBMat8.DClass",
         ),
     ],
+    "Congruence": [("detail::CongruenceCommon", "Congruence")],
 }
 
 # This is what sphinx considers to be a signature

docs/source/main-algorithms/congruence/cong.rst

@@ -1,15 +1,15 @@
-.. Copyright (c) 2024 J. D. Mitchell
+.. Copyright (c) 2025 J. D. Mitchell
 
    Distributed under the terms of the GPL license version 3.
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
-The CongruenceWord class
-========================
+The Congruence class
+====================
 
-.. autoclass:: CongruenceWord
+.. autoclass:: Congruence
    :doc-only:
    :class-doc-from: class
 
@@ -19,21 +19,29 @@ Contents
 .. autosummary::
    :signatures: short
 
-   ~CongruenceWord
-   CongruenceWord.add_generating_pair
-   CongruenceWord.contains
-   CongruenceWord.copy
-   CongruenceWord.currently_contains
-   CongruenceWord.generating_pairs
-   CongruenceWord.init
-   CongruenceWord.max_threads
-   CongruenceWord.number_of_classes
-   CongruenceWord.number_of_runners
-   CongruenceWord.presentation
+   ~Congruence
+   Congruence.add_generating_pair
+   Congruence.contains
+   Congruence.copy
+   Congruence.currently_contains
+   Congruence.generating_pairs
+   Congruence.get
+   Congruence.has
+   Congruence.init
+   Congruence.max_threads
+   Congruence.number_of_classes
+   Congruence.number_of_runners
+   Congruence.presentation
 
 Full API
 --------
 
-.. autoclass:: CongruenceWord
+.. autoclass:: Congruence
    :class-doc-from: init
    :members:
+   :exclude-members: 
+      current_state, dead, finished, internal_generating_pairs, kill,
+      last_report, report, report_every, report_prefix, report_why_we_stopped,
+      reset_last_report, reset_start_time, run, run_for, run_until, running,
+      running_for, running_until, start_time, started, state, stopped,
+      stopped_by_predicate, success, timed_out, 

docs/source/main-algorithms/congruence/helpers.rst

@@ -4,11 +4,11 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-CongruenceWord helper functions
-===============================
+Congruence helper functions
+===========================
 
 This page contains the documentation for various helper functions for
-manipulating :any:`CongruenceWord` objects.
+manipulating :any:`Congruence` objects.
 
 Contents
 --------

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

@@ -10,12 +10,12 @@ Congruence
 ==========
 
 This page contains links to the documentation for the class
-:any:`CongruenceWord`.
+:any:`Congruence`.
 
-Helper functions for the class :any:`CongruenceWord` can be found in the
+Helper functions for the class :any:`Congruence` can be found in the
 submodule :doc:`helpers`. At present the helper
 functions in these two namespaces are identical, because there are no helper
-functions that only apply to the :any:`CongruenceWord` class. 
+functions that only apply to the :any:`Congruence` class. 
 
 .. toctree::
    :maxdepth: 1

docs/source/main-algorithms/congruence/to-cong.rst

@@ -6,11 +6,11 @@
 
 .. currentmodule:: libsemigroups_pybind11
 
-Converting to a CongruenceWord
+Converting to a Congruence
 ==============================
 
 This page contains documentation relating to converting
-``libsemigroups_pybind11`` objects into :any:`CongruenceWord` instances using
+``libsemigroups_pybind11`` objects into :any:`Congruence` instances using
 the :any:`to` function.
 
 .. seealso::
@@ -23,17 +23,17 @@ 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:`CongruenceWord` objects. The following options are
+be used to construct :any:`Congruence` objects. The following options are
 possible:
 
   * :ref:`froidure-pin-to-congruence`.
 
 .. _froidure-pin-to-congruence:
 
-Converting a :any:`FroidurePinPBR` to a :any:`CongruenceWord`
+Converting a :any:`FroidurePinPBR` to a :any:`Congruence`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`CongruenceWord` from a :any:`FroidurePinPBR`, specify all
+To construct a :any:`Congruence` from a :any:`FroidurePinPBR`, specify all
 of the following values for *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
@@ -44,17 +44,17 @@ of the following values for *args*:
 
 Additionally, specify one of the following tuples for *Return*:
 
-    * ``(Congruence, str)`` for constructing a :any:`CongruenceWord` on words
+    * ``(Congruence, str)`` for constructing a :any:`Congruence` on words
       of type ``str``; or
-    * ``(Congruence, List[int])`` for constructing a :any:`CongruenceWord` on
+    * ``(Congruence, List[int])`` for constructing a :any:`Congruence` on
       words of type ``List[int]``.
 
 This function converts the :any:`FroidurePinPBR` object *fpb* into a
-:any:`CongruenceWord` object using the :any:`WordGraph` *wg* (which should be
+:any:`Congruence` object using the :any:`WordGraph` *wg* (which should be
 either the :any:`FroidurePinBase.left_cayley_graph` or the
 :any:`FroidurePinBase.right_cayley_graph` of *fpb*).
 
-This returned :any:`CongruenceWord` object represents the trivial congruence
+This returned :any:`Congruence` object represents the trivial congruence
 over the semigroup defined by *fpb*.
 
 This will throw a :any:`LibsemigroupsError` if *wg* is not the

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

@@ -34,13 +34,13 @@ possible:
 
 .. _congruence-to-froidure-pin:
 
-Converting a :any:`CongruenceWord` to a :any:`FroidurePinPBR`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Converting a :any:`Congruence` to a :any:`FroidurePinPBR`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`FroidurePinPBR` from a :any:`CongruenceWord`, specify the
+To construct a :any:`FroidurePinPBR` from a :any:`Congruence`, specify the
 following values for *args*:
 
-    * **cong** (:any:`CongruenceWord`) -- the :any:`CongruenceWord` object being
+    * **cong** (:any:`Congruence`) -- the :any:`Congruence` object being
       converted.
 
 Additionally, specify the following for *Return*:

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

@@ -10,7 +10,7 @@ Common methods
 ==============
 
 This page contains documentation of the methods of :any:`ToddCoxeterWord` that
-are implemented in all of the classes :any:`CongruenceWord`,
+are implemented in all of the classes :any:`Congruence`,
 :any:`KambitesMultiStringView`, :any:`KnuthBendixStringRewriteTrie`, and
 :any:`ToddCoxeterWord`.
 

libsemigroups_pybind11/__init__.py

@@ -48,7 +48,6 @@
         recursive_path_compare,
         shortlex_compare,
         LibsemigroupsError,
-        is_obviously_infinite,
         BMat8,
         side,
         AhoCorasick,
@@ -82,6 +81,7 @@
 from .adapters import ImageRightAction, ImageLeftAction
 
 from .congruence import Congruence
+from .is_obviously_infinite import is_obviously_infinite
 from .kambites import Kambites
 
 from .knuth_bendix import KnuthBendix