Fix init_ fn names

Author: james-d-mitchell

src/cong-common.cpp

@@ -35,7 +35,7 @@
 
 // libsemigroups_pybind11....
 #include "constants.hpp"
-#include "main.hpp"  // for init_cong_intf
+#include "main.hpp"  // for init_detail_cong_common
 
 namespace libsemigroups {
   namespace py = pybind11;
@@ -1165,7 +1165,7 @@ the congruence represented by an instance of :any:`{name}`.
   // The init function for detail::CongruenceCommon
   ////////////////////////////////////////////////////////////////////////
 
-  void init_cong_intf(py::module& m) {
+  void init_detail_cong_common(py::module& m) {
     py::class_<detail::CongruenceCommon, Runner> thing(
         m, "detail::CongruenceCommon");
 
@@ -1228,5 +1228,5 @@ This function returns the number of generating pairs of the congruence.
 :rtype:
    int
 )pbdoc");
-  }  // init_cong_intf
+  }  // init_detail_cong_common
 }  // namespace libsemigroups

src/knuth-bendix-impl.cpp

@@ -39,7 +39,7 @@
 
 // libsemigroups_pybind11....
 #include "cong-common.hpp"  // for contains etc
-#include "main.hpp"         // for init_knuth_bendix_base
+#include "main.hpp"         // for init_detail_knuth_bendix_impl
 
 // TODO(2): remove unused doc from this file.
 
@@ -49,7 +49,7 @@ namespace libsemigroups {
   namespace detail {
 
     template <typename Rewriter>
-    void bind_knuth_bendix_base(py::module& m, std::string const& name) {
+    void bind_detail_knuth_bendix_impl(py::module& m, std::string const& name) {
       //////////////////////////////////////////////////////////////////////////
       // KnuthBendixImpl class definition . . .
       //////////////////////////////////////////////////////////////////////////
@@ -510,10 +510,10 @@ infinite; ``False`` is returned if it is not.
     }
   }  // namespace detail
 
-  void init_knuth_bendix_base(py::module& m) {
-    detail::bind_knuth_bendix_base<detail::RewriteFromLeft>(
+  void init_detail_knuth_bendix_impl(py::module& m) {
+    detail::bind_detail_knuth_bendix_impl<detail::RewriteFromLeft>(
         m, "KnuthBendixImplRewriteFromLeft");
-    detail::bind_knuth_bendix_base<detail::RewriteTrie>(
+    detail::bind_detail_knuth_bendix_impl<detail::RewriteTrie>(
         m, "KnuthBendixImplRewriteTrie");
   }
 }  // namespace libsemigroups

src/main.cpp

@@ -19,10 +19,8 @@
 #include "main.hpp"
 
 // C std headers....
-#include <stddef.h>  // for size_t
-
-// C++ stl headers....
-#include <initializer_list>  // for initializer_list
+#include <cstddef>  // for size_t
+#include <stdexcept>
 
 // libsemigroups....
 #include <libsemigroups/config.hpp>     // for LIBSEMIGROUPS_EIGEN_ENABLED
@@ -39,11 +37,11 @@
 // pybind11....
 #include <pybind11/operators.h>  // for self, operator<, operator==, self_t
 #include <pybind11/pybind11.h>   // for module_, class_, enum_, init
-#include <stdexcept>
 
 namespace libsemigroups {
   namespace py = pybind11;
 
+  // TODO move to separate fil
   bool ERROR_MESSAGE_WITH_PREFIX = false;
 
   void error_message_with_prefix(bool value) {
@@ -68,6 +66,7 @@ namespace libsemigroups {
     }
   }
 
+  // TODO move to separate fil
   // This has its own function so the py::options can be set for just this enum
   void init_tril(py::module& m) {
     py::options options;
@@ -99,6 +98,7 @@ The valid values are:
   }
 
   PYBIND11_MODULE(_libsemigroups_pybind11, m) {
+    // TODO move to separate file
     py::class_<Undefined>(m, "Undefined")
         .def("__repr__",
              [](Undefined const& val) -> std::string { return "UNDEFINED"; })
@@ -193,64 +193,60 @@ The valid values are:
     });
 
     ////////////////////////////////////////////////////////////////////////
-    // Classes
+    // Classes that need to be initialised early
     ////////////////////////////////////////////////////////////////////////
 
     init_reporter(m);
     init_runner(m);
-
-    ////////////////////////////////////////////////////////////////////////
-    // Misc that needs to be initialised early
-    ////////////////////////////////////////////////////////////////////////
-
     init_tril(m);
 
     ////////////////////////////////////////////////////////////////////////
-    // Abstract classes that are required by other classes
+    // Classes in (almost) alphabetical order
     ////////////////////////////////////////////////////////////////////////
 
-    init_imagerightaction(m);
+    init_detail_cong_common(m);
+    init_detail_todd_coxeter_impl(m);
+    init_detail_knuth_bendix_impl(m);
+
     init_action(m);
-    init_bmat8(m);
     init_aho_corasick(m);
-    init_blocks(m);
     init_bipart(m);
-    init_PBR(m);
+    init_blocks(m);
+    init_bmat8(m);
+    init_cong(m);
+    init_dot(m);
     init_forest(m);
     init_freeband(m);
+    init_froidure_pin_base(m);  // Must be before init_froidure_pin
+    init_froidure_pin(m);
     init_gabow(m);
-    init_order(m);
+    init_imagerightaction(m);
+    init_kambites(m);
+    init_knuth_bendix(m);
+    init_konieczny(m);
+    init_matrix(m);
     init_obvinf(m);
+    init_order(m);
     init_paths(m);
+    init_pbr(m);
     init_present(m);
-    init_inverse_present(m);
-    init_to_present(m);
-    init_sims(m);
-    init_stephen(m);
-    init_transf(m);
+    init_inverse_present(m);  // Must be after init_present
+    init_presentation_examples(m);
     init_ranges(m);
-    init_words(m);
-    init_word_graph(m);
-    init_dot(m);
-    init_matrix(m);
-    init_froidure_pin_base(m);
-    init_ukkonen(m);
-    init_froidure_pin(m);
     init_schreier_sims(m);
-    init_cong_intf(m);
-    init_todd_coxeter_base(m);
-    init_todd_coxeter(m);
-    init_kambites(m);
-    init_knuth_bendix_base(m);
-    init_knuth_bendix(m);
-    init_presentation_examples(m);
-    init_cong(m);
+    init_sims(m);
+    init_stephen(m);
+    init_to_congruence(m);
     init_to_froidure_pin(m);
-    init_to_todd_coxeter(m);
-    init_to_present(m);
     init_to_knuth_bendix(m);
-    init_to_congruence(m);
-    init_konieczny(m);
+    init_to_present(m);
+    init_to_present(m);
+    init_to_todd_coxeter(m);
+    init_todd_coxeter(m);
+    init_transf(m);
+    init_ukkonen(m);
+    init_word_graph(m);
+    init_words(m);
 
 #ifdef VERSION_INFO
     m.attr("__version__") = VERSION_INFO;
@@ -413,7 +409,7 @@ default.
 
     py::class_<LimitMax>(m, "LimitMax")
         .def("__repr__",
-             [](LimitMax const& val) -> std::string { return "<LIMIT_MAX>"; })
+             [](LimitMax const& val) -> std::string { return "LIMIT_MAX"; })
         .def(pybind11::self < LimitMax())
         .def(pybind11::self < int())
         .def(int() < pybind11::self)

src/main.hpp

@@ -29,14 +29,16 @@ namespace libsemigroups {
 
   namespace py = pybind11;
 
-  void init_PBR(py::module&);
+  void init_detail_cong_common(py::module&);
+  void init_detail_knuth_bendix_impl(py::module&);
+  void init_detail_todd_coxeter_impl(py::module&);
+
   void init_action(py::module&);
   void init_aho_corasick(py::module&);
   void init_bipart(py::module&);
   void init_blocks(py::module&);
   void init_bmat8(py::module&);
   void init_cong(py::module&);
-  void init_cong_intf(py::module&);
   void init_dot(py::module&);
   void init_forest(py::module&);
   void init_freeband(py::module&);
@@ -47,28 +49,27 @@ namespace libsemigroups {
   void init_inverse_present(py::module&);
   void init_kambites(py::module&);
   void init_knuth_bendix(py::module&);
-  void init_knuth_bendix_base(py::module&);
   void init_konieczny(py::module&);
   void init_matrix(py::module&);
   void init_obvinf(py::module&);
   void init_order(py::module&);
   void init_paths(py::module&);
+  void init_pbr(py::module&);
   void init_present(py::module&);
   void init_presentation_examples(py::module&);
   void init_ranges(py::module&);
   void init_reporter(py::module&);
   void init_runner(py::module&);
-  void init_stephen(py::module&);
   void init_schreier_sims(py::module&);
   void init_sims(py::module&);
+  void init_stephen(py::module&);
   void init_to_congruence(py::module&);
   void init_to_froidure_pin(py::module&);
   void init_to_knuth_bendix(py::module&);
   void init_to_present(py::module&);
   void init_to_present(py::module&);
   void init_to_todd_coxeter(py::module&);
   void init_todd_coxeter(py::module&);
-  void init_todd_coxeter_base(py::module&);
   void init_transf(py::module&);
   void init_ukkonen(py::module&);
   void init_word_graph(py::module&);

src/pbr.cpp

@@ -26,12 +26,12 @@
 #include <pybind11/stl.h>
 
 // libsemigroups_pybind11....
-#include "main.hpp"  // for init_PBR
+#include "main.hpp"  // for init_pbr
 
 namespace libsemigroups {
 
   namespace py = pybind11;
-  void init_PBR(py::module& m) {
+  void init_pbr(py::module& m) {
     py::class_<PBR> thing(m,
                           "PBR",
                           R"pbdoc(
@@ -271,6 +271,6 @@ value is adjacent to its negative. Equivalently, ``i`` is adjacent
 :returns: The identity.
 :rtype: PBR
 )pbdoc");
-  }  // init_PBR
+  }  // init_pbr
 
 }  // namespace libsemigroups

src/todd-coxeter-impl.cpp

@@ -32,13 +32,13 @@
 
 // libsemigroups_pybind11....
 #include "cong-common.hpp"  // for contains
-#include "main.hpp"         // for init_todd_coxeter_base
+#include "main.hpp"         // for init_detail_todd_coxeter_impl
 
 namespace libsemigroups {
   namespace py = pybind11;
   using std::literals::operator""sv;
 
-  void init_todd_coxeter_base(py::module& m) {
+  void init_detail_todd_coxeter_impl(py::module& m) {
     using ToddCoxeterImpl_ = detail::ToddCoxeterImpl;
     py::class_<ToddCoxeterImpl_, detail::CongruenceCommon> thing(
         m, "ToddCoxeterImpl");