Finished FroidurePin

Author: james-d-mitchell

docs/source/_ext/libsemigroups_pybind11_extensions.py

@@ -100,18 +100,8 @@ def no_doc_run(self):
 # replacements will be performed globally. Hyperlinks will be added in the
 # signature if "good type" is a valid (potentially user defined) python type
 type_replacements = {
-    (
-        r"libsemigroups::Presentation<std::__cxx11::basic_string<char, "
-        r"std::char_traits<char>, std::allocator<char> > >"
-    ): r"Presentation",
-    r"libsemigroups::BMat8": r"BMat8",
     r"libsemigroups::WordGraph<unsigned int>": r"WordGraph",
     r"libsemigroups::Gabow<unsigned int>": r"Gabow",
-    (
-        r"libsemigroups::DynamicMatrix<libsemigroups::IntegerPlus<long long>, "
-        r"libsemigroups::IntegerProd<long long>, libsemigroups::IntegerZero"
-        r"<long long>, libsemigroups::IntegerOne<long long>, long long>"
-    ): r"Matrix",
     r"libsemigroups::SimsStats": r"SimsStats",
     r"libsemigroups::Sims1": r"Sims1",
     r"libsemigroups::Sims2": r"Sims2",
@@ -122,17 +112,13 @@ def no_doc_run(self):
         r"libsemigroups::BooleanProd, libsemigroups::BooleanZero, "
         r"libsemigroups::BooleanOne, int>"
     ): r"Matrix",
-    r"libsemigroups::Konieczny<BMat8, "
-    "libsemigroups::KoniecznyTraits<BMat8>>::DClass": "KoniecznyBMat8DClass",
 }
 
 # This dictionary should be of the form class_name -> (pattern, repl), where
 # "pattern" should be replaced by "repl" in the signature of all functions in
 # "class_name"
 class_specific_replacements = {
     "RightActionPPerm1List": [
-        ("libsemigroups::PPerm<16ul, unsigned char>", "Element"),
-        ("libsemigroups::Element", "Element"),
         ("libsemigroups::PPerm<0ul, unsigned char>", "Element"),
     ],
     "Transf1": [
@@ -145,49 +131,30 @@ def no_doc_run(self):
         ("PTransfBase1", "Perm1"),
         ("Transf", "Perm"),
     ],
-    "FroidurePinPBR": [(r"\bPBR\b", "Element")],
     "SchreierSimsPerm1": [(r"\bPerm1\b", "Element")],
     "Sims1": [("SubclassType", "Sims1"), ("SimsSettingsSims1", "Sims1")],
     "Sims2": [("SubclassType", "Sims2"), ("SimsSettingsSims2", "Sims2")],
     "MinimalRepOrc": [
         ("SubclassType", "MinimalRepOrc"),
         ("SimsSettingsMinimalRepOrc", "MinimalRepOrc"),
-        (r"\bRepOrc\b", "MinimalRepOrc"),
     ],
     "RepOrc": [
         ("SubclassType", "RepOrc"),
         ("SimsSettingsRepOrc", "RepOrc"),
     ],
     "KoniecznyBMat8": [
         (r"\bBMat8\b", "Element"),
-        (
-            "libsemigroups::Konieczny<libsemigroups::Element, "
-            "libsemigroups::KoniecznyTraits<libsemigroups::Element>>::DClass",
-            "KoniecznyBMat8.DClass",
-        ),
     ],
 }
 
 # This dictionary should be of the form bad_string -> good_string. These
 # replacements will be made in each docstring, and will be useful for removing
 # things like the signatures that sphinx inserts into every docstring
 docstring_replacements = {
-    r"_current_index_of.*$": "",
-    r"_number_of_classes.*$": "",
-    r"_small_overlap_class.*$": "",
     r"aho_corasick_dot\(.*\)(\s*->\s*(\w+::)*\w*)?": "",
-    r"congruence_non_trivial_classes.*$": "",
-    r"congruence_partition.*$": "",
-    r"kambites_normal_forms.*$": "",
     r"knuth_bendix_non_trivial_classes.*$": "",
     r"pbr_one\(\*args, \*\*kwargs\)": "",
-    r"todd_coxeter_is_non_trivial.*$": "",
-    r"todd_coxeter_non_trivial_class.*$": "",
-    r"todd_coxeter_normal_forms.*$": "",
-    r"todd_coxeter_partition.*$": "",
-    r"todd_coxeter_redundant_rule.*$": "",
     r"word_graph_dot\(.*\)(\s*->\s*(\w+::)*\w*)?": "",
-    r"D_class_of_element\(.*$": "",
 }
 
 

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

@@ -216,14 +216,14 @@ this function.
 
 .. _froidure-pin-to-presentation:
 
-Converting a :any:`FroidurePinPBR` to a :any:`PresentationStrings`
+Converting a :any:`FroidurePin` to a :any:`PresentationStrings`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To construct a :any:`PresentationStrings` from a
-:any:`FroidurePinPBR`, specify the following values for
+:any:`FroidurePin`, specify the following values for
 *args*:
 
-    * **fp** (:any:`FroidurePinPBR`) -- the :any:`FroidurePinPBR` from which to
+    * **fp** (:any:`FroidurePin`) -- the :any:`FroidurePin` from which to
       obtain the rules.
 
 Additionally, specify the following for *Return*:
@@ -234,7 +234,7 @@ Additionally, specify the following for *Return*:
       :any:`PresentationStrings` over words of type ``List[int]``.
 
 This function constructs and returns a :any:`PresentationStrings` object using
-the rules of a :any:`FroidurePinPBR` object.
+the rules of a :any:`FroidurePin` object.
 
 No enumeration of the argument *fp* is performed, so it might be the case that
 the resulting :any:`PresentationStrings` does not define the same semigroup as

docs/source/data-structures/to-function.rst

@@ -15,7 +15,7 @@ another type. These mostly only apply to the types implementing the main
 algorithms in ``libsemigroups_pybind11``.
 
 For example, to convert a :any:`ToddCoxeter` ``tc`` object to a
-:any:`FroidurePinPBR` object, you can simply do ``to(tc, Return=FroidurePin)``.
+:any:`FroidurePin` object, you can simply do ``to(tc, Return=FroidurePin)``.
 
 A summary of the possible conversions available in ``libsemigroups_pybind11`` of
 ``to(FromType, Return=ToType)`` are given below, where the rows correspond to

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

@@ -20,6 +20,6 @@ functions that only apply to the :any:`Congruence` class.
 .. toctree::
    :maxdepth: 1
 
-   cong
+   class
    helpers
    to-cong

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

@@ -30,15 +30,15 @@ possible:
 
 .. _froidure-pin-to-congruence:
 
-Converting a :any:`FroidurePinPBR` to a :any:`Congruence`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Converting a :any:`FroidurePin` to a :any:`Congruence`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To construct a :any:`Congruence` from a :any:`FroidurePinPBR`, specify all
+To construct a :any:`Congruence` from a :any:`FroidurePin`, specify all
 of the following values for *args*:
 
     * **knd** (:any:`congruence_kind`) -- the kind of the congruence being
       construed;
-    * **fpb** (:any:`FroidurePinBase`) -- the :any:`FroidurePinPBR` instance to
+    * **fpb** (:any:`FroidurePin`) -- the :any:`FroidurePin` instance to
       be converted; and
     * **wg** (:any:`WordGraph`) -- the left or right Cayley graph of *fpb*.
 
@@ -49,17 +49,17 @@ Additionally, specify one of the following tuples for *Return*:
     * ``(Congruence, List[int])`` for constructing a :any:`Congruence` on
       words of type ``List[int]``.
 
-This function converts the :any:`FroidurePinPBR` object *fpb* into a
+This function converts the :any:`FroidurePin` object *fpb* into a
 :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*).
+either the :any:`FroidurePin.left_cayley_graph` or the
+:any:`FroidurePin.right_cayley_graph` of *fpb*).
 
 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
-:any:`FroidurePinBase.left_cayley_graph` or the
-:any:`FroidurePinBase.right_cayley_graph` of *fpb*.
+:any:`FroidurePin.left_cayley_graph` or the
+:any:`FroidurePin.right_cayley_graph` of *fpb*.
 
 .. doctest:: Python
 

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

@@ -2,7 +2,7 @@ Helper functions for FroidurePin objects
 ========================================
 
 This page contains the documentation for various helper functions for
-manipulating :any:`FroidurePinPBR` objects.
+manipulating :any:`FroidurePin` objects.
 
 Contents
 --------

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

@@ -8,12 +8,12 @@ Froidure-Pin
 ============
 
 The functionality in ``libsemigroups_pybind11`` related to the Froidure-Pin
-algorithm :cite:`Froidure1997aa` is contained in the two classes below. 
+algorithm :cite:`Froidure1997aa` is contained in the class and the helper
+functions  below. 
 
 .. toctree::
    :maxdepth: 1
 
-   froidure-pin-base
-   froidure-pin
+   class
    helpers
    to-froidure-pin