Update for changes in libsemigroups

Author: james-d-mitchell

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

@@ -36,7 +36,7 @@ Contents
    libsemigroups_pybind11.InversePresentation
    InversePresentationStrings.inverse
    InversePresentationStrings.inverses
-   InversePresentationStrings.validate
+   InversePresentationStrings.throw_if_bad_alphabet_rules_or_inverses
 
 Full API
 --------

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

@@ -56,15 +56,15 @@ Contents
    remove_redundant_generators
    remove_trivial_rules
    replace_subword
-   replace_word_with_new_generator
    replace_word
+   replace_word_with_new_generator
    reverse
-   shortest_rule_length
    shortest_rule
+   shortest_rule_length
    sort_each_rule
    sort_rules
    strongly_compress
-   validate_semigroup_inverses
+   throw_if_bad_inverses
 
 Full API
 --------

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

@@ -43,11 +43,10 @@ Contents
    PresentationStrings.letter
    PresentationStrings.remove_generator
    PresentationStrings.rules
-   PresentationStrings.validate
-   PresentationStrings.validate_alphabet
-   PresentationStrings.validate_letter
-   PresentationStrings.validate_word
-   PresentationStrings.validate_rules
+   PresentationStrings.throw_if_bad_alphabet_or_rules
+   PresentationStrings.throw_if_alphabet_not_duplicate_free
+   PresentationStrings.throw_if_letter_not_in_alphabet
+   PresentationStrings.throw_if_bad_rules
 
 Full API
 --------

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

@@ -54,11 +54,12 @@ the alphabet of the returned :any:`InversePresentationStrings` will be
 :math:`\{0, 1, \dots, n-1, n, \dots, 2n-1\}`, where the inverse of letter
 :math:`i` is the letter :math:`i + n\, (\text{mod }2n)`.
 
-This function throws a :any:`LibsemigroupsError` if ``p.validate()`` throws.
+This function throws a :any:`LibsemigroupsError` if
+``p.throw_if_bad_alphabet_or_rules()`` throws.
 
 .. seealso::
 
-    * :any:`PresentationStrings.validate`.
+    * :any:`PresentationStrings.throw_if_bad_alphabet_or_rules`.
 
 .. doctest:: Python
 
@@ -120,13 +121,14 @@ of type ``List[int]``, then the conversion from one type to another is
 :math:`a_i \mapsto` ``human_readable_letter(a_i)``.
 
 This function throws a :any:`LibsemigroupsError` if the type of words in *ip* is
-not the same as that specified in *Return* and ``p.validate()`` throws.
+not the same as that specified in *Return* and
+``p.throw_if_bad_alphabet_rules_or_inverses()`` throws.
 
 .. seealso::
 
     * :any:`words.human_readable_index`;
     * :any:`words.human_readable_letter`; and
-    * :any:`InversePresentationStrings.validate`.
+    * :any:`InversePresentationStrings.throw_if_bad_alphabet_rules_or_inverses`.
 
 .. doctest:: Python
 
@@ -177,13 +179,14 @@ different type (for example, can be used to convert from :any:`str` to
 :any:`int`). The second parameter *f* specifies how to map the letters of one
 :any:`InversePresentationStrings` to the other.
 
-This function throws a :any:`LibsemigroupsError` if ``ip.validate()`` throws, or
-if the function specified by *f* does not map letters of the type used in *ip*
-to letters of the type of word specified in *Return*.
+This function throws a :any:`LibsemigroupsError` if
+``ip.throw_if_bad_alphabet_rules_or_inverses()`` throws, or if the function
+specified by *f* does not map letters of the type used in *ip* to letters of
+the type of word specified in *Return*.
 
 .. seealso::
 
-    * :any:`InversePresentationStrings.validate`.
+    * :any:`InversePresentationStrings.throw_if_bad_alphabet_rules_or_inverses`.
 
 .. doctest:: Python
 

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

@@ -70,13 +70,13 @@ of type ``List[int]``, then the conversion from one type to another is
 :math:`a_i \mapsto` ``human_readable_letter(a_i)``.
 
 This function throws a :any:`LibsemigroupsError` if the type of words in *p* is
-not the same as that specified in *Return*, and ``p.validate()`` throws.
+not the same as that specified in *Return*, and ``p.throw_if_bad_alphabet_or_rules()`` throws.
 
 .. seealso::
 
     * :any:`words.human_readable_index`;
     * :any:`words.human_readable_letter`; and
-    * :any:`PresentationStrings.validate`.
+    * :any:`PresentationStrings.throw_if_bad_alphabet_or_rules`.
 
 .. doctest:: Python
 
@@ -127,13 +127,13 @@ This function returns a :any:`PresentationStrings` equivalent to the input
 parameter *f* specifies how to map the letters of one :any:`PresentationStrings`
 to the other.
 
-This function throws a :any:`LibsemigroupsError` if ``p.validate()`` throws, or
+This function throws a :any:`LibsemigroupsError` if ``p.throw_if_bad_alphabet_or_rules()`` throws, or
 if the function specified by *f* does not map letters of the type used in *p* to
 letters of the type of word specified in *Return*.
 
 .. seealso::
 
-    * :any:`PresentationStrings.validate`.
+    * :any:`PresentationStrings.throw_if_bad_alphabet_or_rules`.
 
 .. doctest:: Python
 
@@ -267,4 +267,4 @@ semigroup as *fp*, run ``fp.run()`` (or any other function that fully enumerates
     >>> len(p.alphabet()) == 4
     True
 
-.. py:class:: Thing(arg)
+.. py:class:: Thing(arg)

docs/source/data-structures/tries/class.rst

@@ -24,9 +24,9 @@ Contents
    AhoCorasick.number_of_nodes
    AhoCorasick.signature
    AhoCorasick.suffix_link
+   AhoCorasick.throw_if_node_index_not_active
+   AhoCorasick.throw_if_node_index_out_of_range
    AhoCorasick.traverse
-   AhoCorasick.validate_active_node_index
-   AhoCorasick.validate_node_index
 
 Full API
 --------

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

@@ -41,6 +41,7 @@ Contents
    FroidurePinPBR.sorted_position
    FroidurePinPBR.to_sorted_position
 
+
 Full API
 --------
 

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

@@ -259,11 +259,11 @@ label of the :any:`WordGraph` the corresponding :math:`f` satisfies
 function returns the :any:`FroidurePinPBR` object corresponding to the
 semigroup or monoid generated by the set of all such transformations.
 
-This function throws a :any:`LibsemigroupsError` if ``validate`` throws for any
-of the constructed generators. This can happen if, for example, the 
-:any:`WordGraph` is not complete (i.e. there exists an edge label and node for
-which there is no edge with the given label and given source) or if there is an
-edge label such that
+This function throws a :any:`LibsemigroupsError` if
+``throw_if_image_value_out_of_range`` throws for any of the constructed
+generators. This can happen if, for example, the :any:`WordGraph` is not
+complete (i.e. there exists an edge label and node for which there is no edge
+with the given label and given source) or if there is an edge label such that
 :math:`\{a, \ldots, b - 1\}f \not\subseteq \{a, \ldots, b - 1\}` for the
 corresponding :math:`f`.
 

libsemigroups_pybind11/presentation/__init__.py

@@ -15,17 +15,17 @@
 """
 
 from _libsemigroups_pybind11 import (
-    PresentationStrings as __PresentationStrings,
-    PresentationWords as __PresentationWords,
+    # TODO(0) balance?
     InversePresentationStrings as __InversePresentationStrings,
     InversePresentationWords as __InversePresentationWords,
+    PresentationStrings as __PresentationStrings,
+    PresentationWords as __PresentationWords,
     add_identity_rules,
     add_inverse_rules,
     add_rule,
     add_rules,
     add_zero_rules,
     are_rules_sorted,
-    # TODO(0) balance?
     change_alphabet,
     contains_rule,
     first_unused_letter,
@@ -44,15 +44,15 @@
     remove_redundant_generators,
     remove_trivial_rules,
     replace_subword,
-    replace_word_with_new_generator,
     replace_word,
+    replace_word_with_new_generator,
     reverse,
-    shortest_rule_length,
     shortest_rule,
+    shortest_rule_length,
     sort_each_rule,
     sort_rules,
     strongly_compress,
-    validate_semigroup_inverses,
+    throw_if_bad_inverses,
 )
 
 # TODO make these into classes like in transformations
@@ -75,9 +75,7 @@ def Presentation(arg):
             "using copy.copy"
         )
     else:
-        raise TypeError(
-            "expected the argument to be a string or a list of ints"
-        )
+        raise TypeError("expected the argument to be a string or a list of ints")
     return result
 
 
@@ -109,9 +107,7 @@ def InversePresentation(arg):
     elif isinstance(arg, list) and all(isinstance(x, int) for x in arg):
         result = __InversePresentationWords()
         result.alphabet(arg)
-    elif isinstance(
-        arg, (__InversePresentationStrings, __InversePresentationWords)
-    ):
+    elif isinstance(arg, (__InversePresentationStrings, __InversePresentationWords)):
         raise TypeError(
             "expected the argument to be a presentation, a string or a list of "
             "ints; received an InversePresentation. If you are trying to copy "

src/aho-corasick.cpp

@@ -102,11 +102,11 @@ This function returns the index of the child of the node with index
 :returns: the index of the child.
 :rtype: int
 
-:raises LibsemigroupsError:  if ``validate_active_node_index(parent)`` throws.
+:raises LibsemigroupsError:  if ``throw_if_node_index_not_active(parent)`` throws.
 
 :complexity: Constant.
 
-.. seealso:: :any:`validate_active_node_index`.
+.. seealso:: :any:`throw_if_node_index_not_active`.
 
 )pbdoc");
 
@@ -122,11 +122,11 @@ Calculate the height of a node.
 :returns: the height.
 :rtype: int
 
-:raises LibsemigroupsError:  if ``validate_active_node_index(i)`` throws.
+:raises LibsemigroupsError:  if ``throw_if_node_index_not_active(i)`` throws.
 
 :complexity: Linear in the return value which is, at worst, the maximum length of a word in the trie
 
-.. seealso::  :any:`validate_active_node_index`.
+.. seealso::  :any:`throw_if_node_index_not_active`.
 
 )pbdoc");
 
@@ -195,11 +195,11 @@ the longest proper suffix of :math:`W` contained in the trie.
 :returns: The index of the suffix link.
 :rtype: int
 
-:raises LibsemigroupsError:  if ``validate_active_node_index(current)`` throws.
+:raises LibsemigroupsError:  if ``throw_if_node_index_not_active(current)`` throws.
 
 :complexity: Linear in the height of the node.
 
-.. seealso:: :any:`validate_active_node_index`.
+.. seealso:: :any:`throw_if_node_index_not_active`.
 
 )pbdoc");
 
@@ -227,32 +227,32 @@ trie.
 :returns: The index of the node traversed to
 :rtype: int
 
-:raises LibsemigroupsError:  if ``validate_active_node_index(current)`` throws.
+:raises LibsemigroupsError:  if ``throw_if_node_index_not_active(current)`` throws.
 
-.. seealso:: :any:`validate_active_node_index`.
+.. seealso:: :any:`throw_if_node_index_not_active`.
 
 )pbdoc");
 
-    thing.def("validate_active_node_index",
-              &AhoCorasick::validate_active_node_index,
+    thing.def("throw_if_node_index_not_active",
+              &AhoCorasick::throw_if_node_index_not_active,
               py::arg("i"),
               R"pbdoc(
 Check if an index corresponds to a node currently in the trie.
 
 :param i: the index to validate
 :type i: int
 
-:raises LibsemigroupsError:  if ``validate_node_index(i)`` throws, or if *i* is
+:raises LibsemigroupsError:  if ``throw_if_node_index_out_of_range(i)`` throws, or if *i* is
     not an active node.
 
 :complexity: Constant
 
-.. seealso::  :any:`validate_node_index`.
+.. seealso::  :any:`throw_if_node_index_out_of_range`.
 
 )pbdoc");
 
-    thing.def("validate_node_index",
-              &AhoCorasick::validate_node_index,
+    thing.def("throw_if_node_index_out_of_range",
+              &AhoCorasick::throw_if_node_index_out_of_range,
               py::arg("i"),
               R"pbdoc(
 Check if an index corresponds to a node.