Use proper class for Congruence

Author: james-d-mitchell

docs/source/conf.py

@@ -3,6 +3,7 @@
 """
 This provides configuration for the generation of the docs
 """
+
 import importlib.metadata
 import sys
 from pathlib import Path

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/data-structures/to-function.rst

@@ -14,7 +14,7 @@ This page contains links to the documentation of the uses of the function
 another type. These mostly only apply to the types implementing the main
 algorithms in ``libsemigroups_pybind11``.
 
-For example, to convert a :any:`ToddCoxeterWord` ``tc`` object to a
+For example, to convert a :any:`ToddCoxeter` ``tc`` object to a
 :any:`FroidurePinPBR` object, you can simply do ``to(tc, Return=FroidurePin)``.
 
 A summary of the possible conversions available in ``libsemigroups_pybind11`` of

docs/source/data-structures/word-graph/forest.rst

@@ -9,7 +9,9 @@
 Forest
 ======
 
-This class represents the collection of spanning trees of a word graph.
+.. autoclass:: Forest
+   :doc-only:
+   :class-doc-from: class
 
 Contents
 --------
@@ -35,4 +37,4 @@ Full API
 .. autoclass:: Forest
     :members:
     :show-inheritance:
-    :class-doc-from: class
+    :class-doc-from: init

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

@@ -68,7 +68,7 @@ The following helper functions are also available:
   ...            [0, 0, 1, 0],
   ...            [0, 0, 0, 0]])
   ... )
-  <incomplete action with 5 generators, 1 points>
+  <incomplete right action with 5 generators, 1 points>
   >>> len(o)
   553
 

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/helpers.rst

@@ -29,5 +29,9 @@ Contents
 Full API
 --------
 
+.. currentmodule:: libsemigroups_pybind11.froidure_pin
+
 .. automodule:: libsemigroups_pybind11.froidure_pin
    :members:
+   :imported-members:
+   :exclude-members: FroidurePin, FroidurePinBase