froidure-pin: add dot_right/left_cayley_graph

Author: codex

src/froidure-pin-base.cpp

@@ -17,6 +17,7 @@
 //
 
 // libsemigroups headers
+#include <libsemigroups/dot.hpp>
 #include <libsemigroups/froidure-pin-base.hpp>
 
 // pybind11....
@@ -528,6 +529,164 @@ Returns the position of the suffix of the element ``x`` in position *pos*
       py::options options;
       options.disable_function_signatures();
 
+      m.def("froidure_pin_dot_current_right_cayley_graph",
+            py::overload_cast<FroidurePinBase const&>(
+                &froidure_pin::dot_current_right_cayley_graph),
+            py::arg("fp"),
+            R"pbdoc(
+:sig=(fp: FroidurePin) -> Dot:
+
+Returns a :any:`Dot` object representing the current right Cayley graph.
+
+This function does not trigger a full enumeration of *fp*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_current_right_cayley_graph",
+            py::overload_cast<FroidurePinBase const&, std::string const&>(
+                &froidure_pin::dot_current_right_cayley_graph),
+            py::arg("fp"),
+            py::arg("gen_names"),
+            R"pbdoc(
+:sig=(fp: FroidurePin, gen_names: str) -> Dot:
+
+Returns a :any:`Dot` object representing the current right Cayley graph.
+
+The generators are labelled using the characters in *gen_names*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+:param gen_names: the labels for the generators.
+:type gen_names: str
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_right_cayley_graph",
+            py::overload_cast<FroidurePinBase&>(
+                &froidure_pin::dot_right_cayley_graph),
+            py::arg("fp"),
+            R"pbdoc(
+:sig=(fp: FroidurePin) -> Dot:
+
+Returns a :any:`Dot` object representing the right Cayley graph.
+
+This function triggers a full enumeration of *fp*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_right_cayley_graph",
+            py::overload_cast<FroidurePinBase&, std::string const&>(
+                &froidure_pin::dot_right_cayley_graph),
+            py::arg("fp"),
+            py::arg("gen_names"),
+            R"pbdoc(
+:sig=(fp: FroidurePin, gen_names: str) -> Dot:
+
+Returns a :any:`Dot` object representing the right Cayley graph.
+
+This function triggers a full enumeration of *fp*. The generators are labelled
+using the characters in *gen_names*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+:param gen_names: the labels for the generators.
+:type gen_names: str
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_current_left_cayley_graph",
+            py::overload_cast<FroidurePinBase const&>(
+                &froidure_pin::dot_current_left_cayley_graph),
+            py::arg("fp"),
+            R"pbdoc(
+:sig=(fp: FroidurePin) -> Dot:
+
+Returns a :any:`Dot` object representing the current left Cayley graph.
+
+This function does not trigger a full enumeration of *fp*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_current_left_cayley_graph",
+            py::overload_cast<FroidurePinBase const&, std::string const&>(
+                &froidure_pin::dot_current_left_cayley_graph),
+            py::arg("fp"),
+            py::arg("gen_names"),
+            R"pbdoc(
+:sig=(fp: FroidurePin, gen_names: str) -> Dot:
+
+Returns a :any:`Dot` object representing the current left Cayley graph.
+
+The generators are labelled using the characters in *gen_names*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+:param gen_names: the labels for the generators.
+:type gen_names: str
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_left_cayley_graph",
+            py::overload_cast<FroidurePinBase&>(
+                &froidure_pin::dot_left_cayley_graph),
+            py::arg("fp"),
+            R"pbdoc(
+:sig=(fp: FroidurePin) -> Dot:
+
+Returns a :any:`Dot` object representing the left Cayley graph.
+
+This function triggers a full enumeration of *fp*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
+      m.def("froidure_pin_dot_left_cayley_graph",
+            py::overload_cast<FroidurePinBase&, std::string const&>(
+                &froidure_pin::dot_left_cayley_graph),
+            py::arg("fp"),
+            py::arg("gen_names"),
+            R"pbdoc(
+:sig=(fp: FroidurePin, gen_names: str) -> Dot:
+
+Returns a :any:`Dot` object representing the left Cayley graph.
+
+This function triggers a full enumeration of *fp*. The generators are labelled
+using the characters in *gen_names*.
+
+:param fp: the :any:`FroidurePin` object.
+:type fp: FroidurePin
+:param gen_names: the labels for the generators.
+:type gen_names: str
+
+:returns: A :any:`Dot` object.
+:rtype: Dot
+)pbdoc");
+
       m.def("froidure_pin_product_by_reduction",
             &froidure_pin::product_by_reduction,
             py::arg("fp"),

src/libsemigroups_pybind11/froidure_pin.py

@@ -71,6 +71,10 @@
     Transf1 as _Transf1,
     Transf2 as _Transf2,
     Transf4 as _Transf4,
+    froidure_pin_dot_current_left_cayley_graph as _froidure_pin_dot_current_left_cayley_graph,
+    froidure_pin_dot_current_right_cayley_graph as _froidure_pin_dot_current_right_cayley_graph,
+    froidure_pin_dot_left_cayley_graph as _froidure_pin_dot_left_cayley_graph,
+    froidure_pin_dot_right_cayley_graph as _froidure_pin_dot_right_cayley_graph,
     froidure_pin_current_minimal_factorisation as _froidure_pin_current_minimal_factorisation,
     froidure_pin_current_normal_forms as _froidure_pin_current_normal_forms,
     froidure_pin_current_position as _froidure_pin_current_position,
@@ -261,6 +265,10 @@ def sorted_elements(  # pylint: disable=missing-function-docstring
 # TODO(1) be good to get the notes about enumeration being triggered or not, in
 # this doc
 
+dot_current_left_cayley_graph = _wrap_cxx_free_fn(_froidure_pin_dot_current_left_cayley_graph)
+dot_current_right_cayley_graph = _wrap_cxx_free_fn(_froidure_pin_dot_current_right_cayley_graph)
+dot_left_cayley_graph = _wrap_cxx_free_fn(_froidure_pin_dot_left_cayley_graph)
+dot_right_cayley_graph = _wrap_cxx_free_fn(_froidure_pin_dot_right_cayley_graph)
 current_minimal_factorisation = _wrap_cxx_free_fn(_froidure_pin_current_minimal_factorisation)
 current_normal_forms = _wrap_cxx_free_fn(_froidure_pin_current_normal_forms)
 current_position = _wrap_cxx_free_fn(_froidure_pin_current_position)

tests/test_froidure_pin.py

@@ -18,6 +18,7 @@
     UNDEFINED,
     Bipartition,
     BMat8,
+    Dot,
     FroidurePin,
     KnuthBendix,
     LibsemigroupsError,
@@ -161,13 +162,50 @@ def check_idempotents(S):
 def check_cayley_graphs(S):
     ReportGuard(False)
 
+    gen_names = "abcdefghijklmnopqrstuvwxyz"[: S.number_of_generators()]
+
+    d = froidure_pin.dot_current_right_cayley_graph(S)
+    assert isinstance(d, Dot)
+    assert d.kind() == Dot.Kind.digraph
+    assert len(d.nodes()) == S.current_size()
+
+    d = froidure_pin.dot_current_right_cayley_graph(S, gen_names)
+    assert isinstance(d, Dot)
+    assert len(d.nodes()) == S.current_size()
+
+    d = froidure_pin.dot_current_left_cayley_graph(S)
+    assert isinstance(d, Dot)
+    assert d.kind() == Dot.Kind.digraph
+    assert len(d.nodes()) == S.current_size()
+
+    d = froidure_pin.dot_current_left_cayley_graph(S, gen_names)
+    assert isinstance(d, Dot)
+    assert len(d.nodes()) == S.current_size()
+
     g = S.right_cayley_graph()
     assert g.number_of_nodes() == S.size()
     assert g.out_degree() == S.number_of_generators()
+
+    d = froidure_pin.dot_right_cayley_graph(S)
+    assert isinstance(d, Dot)
+    assert len(d.nodes()) == S.size()
+
+    d = froidure_pin.dot_right_cayley_graph(S, gen_names)
+    assert isinstance(d, Dot)
+    assert len(d.nodes()) == S.size()
+
     g = S.left_cayley_graph()
     assert g.number_of_nodes() == S.size()
     assert g.out_degree() == S.number_of_generators()
 
+    d = froidure_pin.dot_left_cayley_graph(S)
+    assert isinstance(d, Dot)
+    assert len(d.nodes()) == S.size()
+
+    d = froidure_pin.dot_left_cayley_graph(S, gen_names)
+    assert isinstance(d, Dot)
+    assert len(d.nodes()) == S.size()
+
 
 def check_factor_prod_rels(S):
     ReportGuard(False)