Use proper class for ToddCoxeter

Author: james-d-mitchell

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/main-algorithms/froidure-pin/to-froidure-pin.rst

@@ -174,13 +174,13 @@ This function throws a :any:`LibsemigroupsError` if ``kb.kind()`` is not
 
 .. _todd-coxeter-to-froidure-pin:
 
-Converting a :any:`ToddCoxeterWord` to a :any:`FroidurePinPBR`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Converting a :any:`ToddCoxeter` to a :any:`FroidurePinPBR`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`FroidurePinPBR` from a :any:`ToddCoxeterWord`, specify the
+To construct a :any:`FroidurePinPBR` from a :any:`ToddCoxeter`, specify the
 following values for *args*:
 
-    * **tc** (:any:`ToddCoxeterWord`) -- the :any:`ToddCoxeterWord` object being
+    * **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` object being
       converted.
 
 Additionally, specify the following for *Return*:

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

@@ -7,7 +7,7 @@
 .. currentmodule:: libsemigroups_pybind11
 
 Converting to a KnuthBendix
-============================================
+===========================
 
 This page contains documentation relating to converting
 ``libsemigroups_pybind11`` objects into :any:`KnuthBendix`
@@ -32,26 +32,26 @@ options are possible:
 
 .. _todd-coxeter-to-knuth-bendix-default:
 
-Converting a :any:`ToddCoxeterWord` to a :any:`KnuthBendix` (default rewriter)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Converting a :any:`ToddCoxeter` to a :any:`KnuthBendix` (default rewriter)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To construct a :any:`KnuthBendix` from a
-:any:`ToddCoxeterWord` using the default rewriter, specify all of the following
+:any:`ToddCoxeter` using the default rewriter, specify all of the following
 values for *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
       constructed.
-    * **tc** (:any:`ToddCoxeterWord`) -- the :any:`ToddCoxeterWord` object
+    * **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` object
       being converted.
 
 Additionally, specify the following for *Return*:
 
     * ``KnuthBendix`` for constructing a :any:`KnuthBendix`
       with the default rewriter.
 
-This function converts a :any:`ToddCoxeterWord` object *tc* to a
+This function converts a :any:`ToddCoxeter` object *tc* to a
 :any:`KnuthBendix` object using
-:any:`ToddCoxeterWord.presentation`. This is equivalent to specifying
+:any:`ToddCoxeter.presentation`. This is equivalent to specifying
 ``(KnuthBendix, 'RewriteTrie')`` as described below.
 
 This returned :any:`KnuthBendix` object represents the trivial
@@ -87,15 +87,15 @@ congruence over the semigroup defined by *tc*.
 
 .. _todd-coxeter-to-knuth-bendix:
 
-Converting a :any:`ToddCoxeterWord` to a :any:`KnuthBendix`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Converting a :any:`ToddCoxeter` to a :any:`KnuthBendix`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To construct a :any:`KnuthBendix` from a
-:any:`ToddCoxeterWord`, specify all of the following values for *args*:
+:any:`ToddCoxeter`, specify all of the following values for *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
       constructed.
-    * **tc** (:any:`ToddCoxeterWord`) -- the :any:`ToddCoxeterWord` object
+    * **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` object
       being converted.
 
 Additionally, specify one of the following for *Return*:
@@ -107,9 +107,9 @@ Additionally, specify one of the following for *Return*:
       :any:`KnuthBendix` with the the ``RewriteFromLeft'``
       rewriter.
 
-This function converts a :any:`ToddCoxeterWord` object *tc* to a
+This function converts a :any:`ToddCoxeter` object *tc* to a
 :any:`KnuthBendix` object with the rewriter as specified above,
-using :any:`ToddCoxeterWord.presentation`.
+using :any:`ToddCoxeter.presentation`.
 
 This returned :any:`KnuthBendix` object represents the trivial
 congruence over the semigroup defined by *tc*.
@@ -145,7 +145,7 @@ congruence over the semigroup defined by *tc*.
 .. _froidure-pin-to-knuth-bendix:
 
 Converting a :any:`FroidurePinPBR` to a :any:`KnuthBendix`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To construct a :any:`KnuthBendix` from a
 :any:`FroidurePinPBR`, specify all of the following values for *args*:

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

@@ -4,20 +4,20 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Accessors
 =========
 
 This page contains the documentation of the various member functions of the
-:any:`ToddCoxeterWord` class that can be used to access the state of an instance.
+:any:`ToddCoxeter` class that can be used to access the state of an instance.
 
 Those functions with the prefix ``current_`` do not perform any further
 enumeration.
 
-.. automethod:: ToddCoxeterWord.current_spanning_tree
-.. automethod:: ToddCoxeterWord.current_word_graph
-.. automethod:: ToddCoxeterImpl.is_standardized
-.. automethod:: ToddCoxeterWord.spanning_tree
-.. automethod:: ToddCoxeterWord.standardization_order
-.. automethod:: ToddCoxeterWord.word_graph
+.. automethod:: ToddCoxeter.current_spanning_tree
+.. automethod:: ToddCoxeter.current_word_graph
+.. automethod:: ToddCoxeter.is_standardized
+.. automethod:: ToddCoxeter.spanning_tree
+.. automethod:: ToddCoxeter.standardization_order
+.. automethod:: ToddCoxeter.word_graph

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

@@ -4,20 +4,20 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Common methods
 ==============
 
-This page contains documentation of the methods of :any:`ToddCoxeterWord` that
+This page contains documentation of the methods of :any:`ToddCoxeter` that
 are implemented in all of the classes :any:`Congruence`,
-:any:`Kambites`, :any:`KnuthBendix`, and :any:`ToddCoxeterWord`.
+:any:`Kambites`, :any:`KnuthBendix`, and :any:`ToddCoxeter`.
 
-.. automethod:: ToddCoxeterWord.add_generating_pair
-.. automethod:: ToddCoxeterWord.contains
-.. automethod:: ToddCoxeterWord.currently_contains
-.. automethod:: ToddCoxeterWord.generating_pairs
-.. automethod:: ToddCoxeterWord.number_of_classes
-.. automethod:: ToddCoxeterWord.presentation
-.. automethod:: ToddCoxeterWord.reduce
-.. automethod:: ToddCoxeterWord.reduce_no_run
+.. automethod:: ToddCoxeter.add_generating_pair
+.. automethod:: ToddCoxeter.contains
+.. automethod:: ToddCoxeter.currently_contains
+.. automethod:: ToddCoxeter.generating_pairs
+.. automethod:: ToddCoxeter.number_of_classes
+.. automethod:: ToddCoxeter.presentation
+.. automethod:: ToddCoxeter.reduce
+.. automethod:: ToddCoxeter.reduce_no_run

docs/source/main-algorithms/todd-coxeter/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 ToddCoxeterWord class
-=========================
+The ToddCoxeter class
+=====================
 
-.. autoclass:: ToddCoxeterWord
+.. autoclass:: ToddCoxeter
    :doc-only:
    :class-doc-from: class
 

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

@@ -4,14 +4,14 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Class index to word
 ===================
 
-This page contains documentation for the member functions of :any:`ToddCoxeterWord` that
+This page contains documentation for the member functions of :any:`ToddCoxeter` that
 can be used to convert the index of a congruence class to a representative word
 belonging to that congruence class.
 
-.. automethod:: ToddCoxeterWord.current_word_of
-.. automethod:: ToddCoxeterWord.word_of
+.. automethod:: ToddCoxeter.current_word_of
+.. automethod:: ToddCoxeter.word_of

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

@@ -4,30 +4,30 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Constructors + initializers
 ===========================
 
 This page documents the constructors and initialisers for the
-:any:`ToddCoxeterWord` class.
+:any:`ToddCoxeter` class.
 
 Every constructor has a matching init function with the same signature that can
-be used to re-initialize a :any:`ToddCoxeterWord` instance as if it had just been
+be used to re-initialize a :any:`ToddCoxeter` instance as if it had just been
 constructed; but without necessarily releasing any previous allocated memory.
 
 Constructors
 ------------
 
-.. autoclass:: ToddCoxeterWord
+.. autoclass:: ToddCoxeter
    :class-doc-from: init
 
 Initializers
 ------------
 
-.. automethod:: ToddCoxeterWord.init
+.. automethod:: ToddCoxeter.init
 
 Copying
 -------
 
-.. automethod:: ToddCoxeterWord.copy
+.. automethod:: ToddCoxeter.copy

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

@@ -4,16 +4,16 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Modifiers
 =========
 
-This page contains documentation of the member functions of :any:`ToddCoxeterWord` that
-can be used to modify the state of a :any:`ToddCoxeterWord` instance. In other words, for
+This page contains documentation of the member functions of :any:`ToddCoxeter` that
+can be used to modify the state of a :any:`ToddCoxeter` instance. In other words, for
 modifying the :any:`WordGraph` that is the output of the algorithm in a way that
 preserves it up to isomorphism.
 
-.. automethod:: ToddCoxeterWord.perform_lookahead
-.. automethod:: ToddCoxeterWord.shrink_to_fit
-.. automethod:: ToddCoxeterWord.standardize
+.. automethod:: ToddCoxeter.perform_lookahead
+.. automethod:: ToddCoxeter.shrink_to_fit
+.. automethod:: ToddCoxeter.standardize

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

@@ -4,13 +4,13 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Settings
 ========
 
 This page contains information about the member functions of the
-:any:`ToddCoxeterWord` that control various settings that influence the congruence
+:any:`ToddCoxeter` that control various settings that influence the congruence
 enumeration process.
 
 There are a fairly large number of settings, they can profoundly alter the run
@@ -19,22 +19,22 @@ settings will work best for any particular input.
 
 See also :any:`Runner` for further settings.
 
-.. automethod:: ToddCoxeterWord.def_max
-.. automethod:: ToddCoxeterWord.def_policy
-.. automethod:: ToddCoxeterWord.def_version
-.. automethod:: ToddCoxeterWord.f_defs
-.. automethod:: ToddCoxeterWord.hlt_defs
-.. automethod:: ToddCoxeterWord.large_collapse
-.. automethod:: ToddCoxeterWord.lookahead_extent
-.. automethod:: ToddCoxeterWord.lookahead_growth_factor
-.. automethod:: ToddCoxeterWord.lookahead_growth_threshold
-.. automethod:: ToddCoxeterWord.lookahead_min
-.. automethod:: ToddCoxeterWord.lookahead_next
-.. automethod:: ToddCoxeterWord.lookahead_stop_early_interval
-.. automethod:: ToddCoxeterWord.lookahead_stop_early_ratio
-.. automethod:: ToddCoxeterWord.lookahead_style
-.. automethod:: ToddCoxeterWord.lower_bound
-.. automethod:: ToddCoxeterWord.save
-.. automethod:: ToddCoxeterWord.strategy
-.. automethod:: ToddCoxeterWord.use_relations_in_extra
+.. automethod:: ToddCoxeter.def_max
+.. automethod:: ToddCoxeter.def_policy
+.. automethod:: ToddCoxeter.def_version
+.. automethod:: ToddCoxeter.f_defs
+.. automethod:: ToddCoxeter.hlt_defs
+.. automethod:: ToddCoxeter.large_collapse
+.. automethod:: ToddCoxeter.lookahead_extent
+.. automethod:: ToddCoxeter.lookahead_growth_factor
+.. automethod:: ToddCoxeter.lookahead_growth_threshold
+.. automethod:: ToddCoxeter.lookahead_min
+.. automethod:: ToddCoxeter.lookahead_next
+.. automethod:: ToddCoxeter.lookahead_stop_early_interval
+.. automethod:: ToddCoxeter.lookahead_stop_early_ratio
+.. automethod:: ToddCoxeter.lookahead_style
+.. automethod:: ToddCoxeter.lower_bound
+.. automethod:: ToddCoxeter.save
+.. automethod:: ToddCoxeter.strategy
+.. automethod:: ToddCoxeter.use_relations_in_extra