Add support for Kambites

Author: james-d-mitchell

.gitignore

@@ -3,6 +3,7 @@
 *.so
 *.whl
 .DS_Store
+.ccls
 .coverage
 .tox
 MANIFEST

docs/source/api/kambites.rst

@@ -0,0 +1,71 @@
+.. Copyright (c) 2022, 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
+
+Kambites
+========
+
+On this page we describe the functionality relating to the algorithms for small
+overlap monoids by Kambites_ and the authors of ``libsemigroups``.
+
+.. _Kambites: https://doi.org/10.1016/j.jalgebra.2008.09.038
+
+.. code-block:: python
+
+   kb = Kambites()
+   kb.set_alphabet("abc")
+
+   TODO
+
+.. autosummary::
+   :nosignatures:
+
+   ~Kambites
+   Kambites.add_rule
+   Kambites.add_rules
+   Kambites.alphabet
+   Kambites.char_to_uint
+   Kambites.dead
+   Kambites.equal_to
+   Kambites.finished
+   Kambites.froidure_pin
+   Kambites.has_froidure_pin
+   Kambites.has_identity
+   Kambites.identity
+   Kambites.inverses
+   Kambites.is_obviously_finite
+   Kambites.is_obviously_infinite
+   Kambites.kill
+   Kambites.normal_form
+   Kambites.number_of_normal_forms
+   Kambites.number_of_pieces
+   Kambites.number_of_rules
+   Kambites.report
+   Kambites.report_every
+   Kambites.report_why_we_stopped
+   Kambites.rules
+   Kambites.run
+   Kambites.run_for
+   Kambites.run_until
+   Kambites.running
+   Kambites.set_alphabet
+   Kambites.set_identity
+   Kambites.set_inverses
+   Kambites.size
+   Kambites.small_overlap_class
+   Kambites.started
+   Kambites.stopped
+   Kambites.stopped_by_predicate
+   Kambites.string_to_word
+   Kambites.timed_out
+   Kambites.uint_to_char
+   Kambites.validate_letter
+   Kambites.validate_word
+   Kambites.word_to_string
+
+.. autoclass:: Kambites
+   :members:

docs/source/fpsemigroups.rst

@@ -35,5 +35,6 @@ monoids are:
    :maxdepth: 2
 
    api/fpsemi
+   api/kambites
    api/knuth-bendix
    presentations/index

libsemigroups_pybind11/__init__.py

@@ -36,6 +36,7 @@
     wilo,
     wislo,
     Sims1,
+    Kambites,
 )
 
 from .froidure_pin import FroidurePin

src/fpsemi.cpp

@@ -267,7 +267,7 @@ namespace libsemigroups {
                :return: An int.
                )pbdoc")
         .def("report_every",
-             (void(FpSemigroup::*)(std::chrono::nanoseconds))
+             (void (FpSemigroup::*)(std::chrono::nanoseconds))
                  & Runner::report_every,
              py::arg("t"),
              R"pbdoc(
@@ -306,7 +306,8 @@ namespace libsemigroups {
                :return: (None)
                )pbdoc")
         .def("run_for",
-             (void(FpSemigroup::*)(std::chrono::nanoseconds)) & Runner::run_for,
+             (void (FpSemigroup::*)(std::chrono::nanoseconds))
+                 & Runner::run_for,
              py::arg("t"),
              R"pbdoc(
                Run for a specified amount of time.
@@ -316,7 +317,7 @@ namespace libsemigroups {
                :Returns: (None)
                )pbdoc")
         .def("run_until",
-             (void(FpSemigroup::*)(std::function<bool()> &))
+             (void (FpSemigroup::*)(std::function<bool()> &))
                  & Runner::run_until,
              py::arg("func"),
              R"pbdoc(
@@ -545,12 +546,11 @@ namespace libsemigroups {
              &FpSemigroup::size,
              R"pbdoc(
                Returns the size of the finitely presented semigroup.
-            R"pbdoc(
-              Returns the size of the finitely presented semigroup.
 
-              :return: An ``int`` the value of which equals the size of this
-              if this number is finite, or ``POSITIVE_INFINITY`` if this
-              number is not finite.
+               :return:
+                An ``int`` the value of which equals the size of this
+                if this number is finite, or ``POSITIVE_INFINITY`` if this
+                number is not finite.
               )pbdoc")
         .def(
             "rules",