Add inits from make (#221)

* Change make_forest to an init

* Change make_word_graph to an init

* Linting

Author: Joseph-Edwards

docs/source/data-structures/word-graph/forest.rst

@@ -10,7 +10,6 @@ Forest
 ======
 
 This class represents the collection of spanning trees of a word graph.
-See also :any:`make_forest`.
 
 Contents
 --------
@@ -37,5 +36,3 @@ Full API
     :members:
     :show-inheritance:
     :class-doc-from: class
-
-.. autofunction:: make_forest

docs/source/data-structures/word-graph/helpers.rst

@@ -14,22 +14,11 @@ manipulating word graphs.
 Contents
 --------
 
-In ``libsemigroups_pybind11``:
-
-.. currentmodule:: libsemigroups_pybind11
-
-.. autosummary::
-   :nosignatures:
-  
-   make_word_graph
-
-In ``libsemigroups_pybind11.word_graph``:
-
 .. currentmodule:: libsemigroups_pybind11.word_graph
 
 .. autosummary::
    :nosignatures:
-  
+
    add_cycle
    adjacency_matrix
    dot
@@ -54,8 +43,6 @@ Full API
 
 .. currentmodule:: libsemigroups_pybind11
 
-.. autofunction:: make_word_graph
-
 .. automodule:: libsemigroups_pybind11.word_graph
    :members:
    :imported-members:

libsemigroups_pybind11/__init__.py

@@ -55,9 +55,7 @@
         Bipartition,
         Blocks,
         freeband_equal_to,
-        make_forest,
         Meeter,
-        make_word_graph,
         Joiner,
         Dot,
         PBR,

src/forest.cpp

@@ -37,37 +37,6 @@ namespace py = pybind11;
 
 namespace libsemigroups {
   void init_forest(py::module& m) {
-    m.def(
-        "make_forest",
-        [](std::vector<size_t> const& parents,
-           std::vector<size_t> const& labels) {
-          return make<Forest>(parents, labels);
-        },
-        py::arg("parents"),
-        py::arg("labels"),
-        R"pbdoc(
-:sig=(parents:List[int], labels:List[int])->Forest:
-Construct a :any:`Forest` from list of parents and labels.
-
-:param parent: the list of parents of nodes
-:type parent: List[int]
-:param labels: the list of edge labels
-:type labels: List[int]
-
-:returns:
-  A newly constructed Forest with parents *parents* and edge labels *labels*.
-:rtype:
-  Forest
-
-:raises LibsemigroupsError: if  *parent* and *labels* have different sizes;
-:raises LibsemigroupsError:
-  *parent* and *labels* do not have the value :any:`UNDEFINED` in the same
-  positions (these values indicate where the roots of the trees in the forest
-  are located and so must coincide).
-:raises LibsemigroupsError:
-  :any:`set_parent_and_label` throws for ``parent[i]`` and ``edge_labels[i]`` for any value of ``i``.
-)pbdoc");
-
     using node_type = Forest::node_type;
 
     py::class_<Forest> thing(m,
@@ -89,6 +58,29 @@ Constructs a forest with *n* nodes, that is initialised so that the
 
 :param n: the number of nodes, defaults to ``0``.
 :type n: int
+)pbdoc");
+    thing.def(py::init([](std::vector<size_t> const& parents,
+                          std::vector<size_t> const& labels) {
+                return make<Forest>(parents, labels);
+              }),
+              py::arg("parents"),
+              py::arg("labels"),
+              R"pbdoc(
+:sig=(self: Forest, parents:List[int], labels:List[int]) -> None:
+Construct a :any:`Forest` from list of *parents* and *labels*.
+
+:param parent: the list of parents of nodes.
+:type parent: List[int]
+:param labels: the list of edge labels.
+:type labels: List[int]
+
+:raises LibsemigroupsError: if  *parent* and *labels* have different sizes;
+:raises LibsemigroupsError:
+*parent* and *labels* do not have the value :any:`UNDEFINED` in the same
+positions (these values indicate where the roots of the trees in the forest
+are located and so must coincide).
+:raises LibsemigroupsError:
+:any:`set_parent_and_label` throws for ``parent[i]`` and ``edge_labels[i]`` for any value of ``i``.
 )pbdoc");
     thing.def("add_nodes",
               &Forest::add_nodes,

src/word-graph.cpp

@@ -68,7 +68,7 @@ the *out-degree* of the word graph, or any of its nodes.)pbdoc");
     });
 
     thing.def("__str__", [](WordGraph_ const& self) {
-      return to_input_string(self, "make_word_graph(", "[]", ")");
+      return to_input_string(self, "WordGraph(", "[]", ")");
     });
 
     thing.def(py::self != py::self);
@@ -109,6 +109,36 @@ out-degree of any node is *n*. There are no edges in the defined word graph.
   :math:`O(mn)` where *m* is the number of nodes, and *n* is the
   out-degree of the word graph.)pbdoc");
 
+    thing.def(py::init([](size_t                                     num_nodes,
+                          std::vector<std::vector<node_type>> const& targets) {
+                return make<WordGraph_>(num_nodes, targets);
+              }),
+              py::arg("num_nodes"),
+              py::arg("targets"),
+              R"pbdoc(
+Construct a word graph from a number of nodes and an list of targets.
+
+This function constructs a word graph from its arguments whose
+out-degree is specified by the length of the first item in *targets*.
+
+:param num_nodes: the number of nodes in the word graph.
+:type num_nodes: int
+
+:param targets: list of the targets.
+:type targets: List[List[int]]
+
+
+:raises LibsemigroupsError: if any target is specified in *targets* is greater
+  than or equal to *num_nodes*.
+
+.. doctest::
+
+  >>> from libsemigroups_pybind11 import WordGraph
+  >>> WordGraph(5, [[0, 0], [1, 1], [2], [3, 3]])
+  <WordGraph with 5 nodes, 7 edges, & out-degree 2>
+  
+)pbdoc");
+
     thing.def("add_nodes",
               &WordGraph_::add_nodes,
               py::arg("nr"),
@@ -1027,8 +1057,8 @@ considered to be reachable from itself by default).
 
 .. doctest::
 
-  >>> from libsemigroups_pybind11 import make_word_graph, word_graph
-  >>> wg = make_word_graph (5,  [[0,  0],  [1,  1],  [2],  [3,  3]])
+  >>> from libsemigroups_pybind11 import WordGraph, word_graph
+  >>> wg = WordGraph(5,  [[0,  0],  [1,  1],  [2],  [3,  3]])
   >>> word_graph.is_strictly_cyclic(wg)
   False)pbdoc");
     m.def(
@@ -1769,35 +1799,5 @@ and *y*.
 :raises LibsemigroupsError: if *x* has no nodes;
 :raises LibsemigroupsError: if *y* has no nodes;
 :raises LibsemigroupsError: if ``x.out_degree() != y.out_degree()``.)pbdoc");
-
-    m.def("make_word_graph",
-          py::overload_cast<size_t, std::vector<std::vector<node_type>> const&>(
-              &make<WordGraph<node_type>>),
-          py::arg("num_nodes"),
-          py::arg("targets"),
-          R"pbdoc(
-Constructs a word graph from a number of nodes and an list of targets.
-
-This function constructs a word graph from its arguments whose
-out-degree is specified by the length of the first item in *targets*.
-
-:param num_nodes: the number of nodes in the word graph.
-:type num_nodes: int
-
-:param targets: list of the targets.
-:type targets: List[List[int]]
-
-:returns: The constructed word graph.
-:rtype: WordGraph
-
-:raises LibsemigroupsError:
-  if any target is specified in *targets* is greater than or equal to
-  *num_nodes*.
-
-.. doctest::
-
-   >>> from libsemigroups_pybind11 import make_word_graph
-   >>> make_word_graph(5, [[0, 0], [1, 1], [2], [3, 3]])
-   <WordGraph with 5 nodes, 7 edges, & out-degree 2>)pbdoc");
   }
 }  // namespace libsemigroups

tests/test_dot.py

@@ -19,12 +19,12 @@
     Dot,
     LibsemigroupsError,
     word_graph,
-    make_word_graph,
+    WordGraph,
 )
 
 
 def test_edge():
-    wg = make_word_graph(3, [[0, 1], [1, 0], [2, 2]])
+    wg = WordGraph(3, [[0, 1], [1, 0], [2, 2]])
     d = word_graph.dot(wg)
     edges = d.edges()
     assert len(edges) == 6
@@ -38,7 +38,7 @@ def test_edge():
 
 
 def test_node():
-    wg = make_word_graph(3, [[0, 1], [1, 0], [2, 2]])
+    wg = WordGraph(3, [[0, 1], [1, 0], [2, 2]])
     d = word_graph.dot(wg)
     nodes = d.nodes()
     assert len(nodes) == 3
@@ -51,13 +51,13 @@ def test_node():
 
 
 def test_dot_copy():
-    wg = make_word_graph(3, [[0, 1], [1, 0], [2, 2]])
+    wg = WordGraph(3, [[0, 1], [1, 0], [2, 2]])
     d = word_graph.dot(wg)
     assert copy.copy(d) is not d
 
 
 def test_dot_attrs():
-    wg = make_word_graph(3, [[0, 1], [1, 0], [2, 2]])
+    wg = WordGraph(3, [[0, 1], [1, 0], [2, 2]])
     d = word_graph.dot(wg)
     d.add_attr("node [shape=circle]")
     assert d.attrs() == {"node [shape=circle]": ""}

tests/test_paths.py

@@ -22,7 +22,6 @@
     WordGraph,
     ToString,
     POSITIVE_INFINITY,
-    make_word_graph,
 )
 
 
@@ -95,7 +94,7 @@ def test_ToString():
 
 
 def test_paths_bug():
-    wg = make_word_graph(4, [[0, 1], [1, 0], [2, 2]])
+    wg = WordGraph(4, [[0, 1], [1, 0], [2, 2]])
     p = Paths(wg)
     p.source(0).target(1)
     assert p.source() == 0
@@ -104,7 +103,7 @@ def test_paths_bug():
 
 
 def test_paths_bug2():
-    wg = make_word_graph(4, [[0, 1], [1, 0], [2, 2]])
+    wg = WordGraph(4, [[0, 1], [1, 0], [2, 2]])
     p = Paths(wg)
     assert p.max() is POSITIVE_INFINITY
 

tests/test_word_graph.py

@@ -23,12 +23,10 @@
     WordGraph,
     word_graph,
     LibsemigroupsError,
-    make_forest,
     UNDEFINED,
     Forest,
     Order,
     Meeter,
-    make_word_graph,
     Joiner,
     Matrix,
     MatrixKind,
@@ -241,7 +239,7 @@ def test_number_of_nodes_reachable_from(word_graph_fixture):
 def test_spanning_tree(word_graph_fixture):
     wg1, _ = word_graph_fixture
 
-    assert word_graph.spanning_tree(wg1, 0) == make_forest(
+    assert word_graph.spanning_tree(wg1, 0) == Forest(
         [int(UNDEFINED), 0, 1, 2, 3], [int(UNDEFINED), 0, 0, 0, 0]
     )
 
@@ -273,44 +271,44 @@ def test_meeter(word_graph_fixture):
     wg1.remove_target(4, 0)
 
     meet = Meeter()
-    assert wg1 == make_word_graph(5, [[1], [2], [3], [4], [2**32 - 1]])
+    assert wg1 == WordGraph(5, [[1], [2], [3], [4], [2**32 - 1]])
     assert meet(wg1, wg1) == wg1
 
-    wg2 = make_word_graph(2, [[1, 0], [1, 0]])
-    wg3 = make_word_graph(2, [[1, 1], [1, 1]])
+    wg2 = WordGraph(2, [[1, 0], [1, 0]])
+    wg3 = WordGraph(2, [[1, 1], [1, 1]])
 
-    assert meet(wg3, wg2) == make_word_graph(3, [[1, 2], [1, 2], [1, 2]])
+    assert meet(wg3, wg2) == WordGraph(3, [[1, 2], [1, 2], [1, 2]])
     meet(wg1, wg3, wg2)
-    assert wg1 == make_word_graph(3, [[1, 2], [1, 2], [1, 2]])
+    assert wg1 == WordGraph(3, [[1, 2], [1, 2], [1, 2]])
     assert meet.is_subrelation(wg1, wg3)
     assert meet.is_subrelation(wg1, wg2)
 
 
 def test_joiner(word_graph_fixture):
     wg1, _ = word_graph_fixture
     wg1.remove_target(0, 0)
-    assert wg1 == make_word_graph(5, [[2**32 - 1], [2], [3], [4], [0]])
+    assert wg1 == WordGraph(5, [[2**32 - 1], [2], [3], [4], [0]])
 
     join = Joiner()
     # TODO(later) use UNDEFINED here instead of 2**32 -1
-    assert join(wg1, wg1) == make_word_graph(1, [[2**32 - 1]])
+    assert join(wg1, wg1) == WordGraph(1, [[2**32 - 1]])
 
-    wg3 = make_word_graph(2, [[1, 1], [1, 1]])
-    wg2 = make_word_graph(2, [[1, 0], [1, 0]])
+    wg3 = WordGraph(2, [[1, 1], [1, 1]])
+    wg2 = WordGraph(2, [[1, 0], [1, 0]])
 
-    assert join(wg3, wg2) == make_word_graph(1, [[0, 0]])
+    assert join(wg3, wg2) == WordGraph(1, [[0, 0]])
     join(wg1, wg3, wg2)
-    assert wg1 == make_word_graph(1, [[0, 0]])
+    assert wg1 == WordGraph(1, [[0, 0]])
     assert join.is_subrelation(wg3, wg1)
     assert join.is_subrelation(wg2, wg1)
 
 
 def test_str(word_graph_fixture):
     wg1, wg2 = word_graph_fixture
-    assert str(wg1) == "make_word_graph(5, [[1], [2], [3], [4], [0]])"
+    assert str(wg1) == "WordGraph(5, [[1], [2], [3], [4], [0]])"
     assert (
         str(wg2)
-        == "make_word_graph(10, [[1], [2], [3], [4], [0], [6], [7], [8], [9], [5]])"
+        == "WordGraph(10, [[1], [2], [3], [4], [0], [6], [7], [8], [9], [5]])"
     )
 
 
@@ -339,7 +337,7 @@ def test_random():
     assert word_graph.is_acyclic(w)
     assert word_graph.is_connected(w)
 
-    d = make_word_graph(3, [[0, 1], [1, 0], [2, 2]])
+    d = WordGraph(3, [[0, 1], [1, 0], [2, 2]])
     assert (
         str(word_graph.dot(d))
         == 'digraph WordGraph {\n\n  0  [shape="box"]\n  1  [shape="box"]\n  2'
@@ -349,7 +347,7 @@ def test_random():
         '  [color="#ff00ff"]\n}'
     )
 
-    d = make_word_graph(4, list(12 * [i] for i in range(4)))
+    d = WordGraph(4, list(12 * [i] for i in range(4)))
     assert (
         str(word_graph.dot(d))
         == 'digraph WordGraph {\n\n  0  [shape="box"]\n  1  [shape="box"]\n  2  [shape="box"]\n  3  [shape="box"]\n  0 -> 0  [color="#00ff00"]\n  0 -> 0  [color="#ff00ff"]\n  0 -> 0  [color="#007fff"]\n  0 -> 0  [color="#ff7f00"]\n  0 -> 0  [color="#7fbf7f"]\n  0 -> 0  [color="#4604ac"]\n  0 -> 0  [color="#de0328"]\n  0 -> 0  [color="#19801d"]\n  0 -> 0  [color="#d881f5"]\n  0 -> 0  [color="#00ffff"]\n  0 -> 0  [color="#ffff00"]\n  0 -> 0  [color="#00ff7f"]\n  1 -> 1  [color="#00ff00"]\n  1 -> 1  [color="#ff00ff"]\n  1 -> 1  [color="#007fff"]\n  1 -> 1  [color="#ff7f00"]\n  1 -> 1  [color="#7fbf7f"]\n  1 -> 1  [color="#4604ac"]\n  1 -> 1  [color="#de0328"]\n  1 -> 1  [color="#19801d"]\n  1 -> 1  [color="#d881f5"]\n  1 -> 1  [color="#00ffff"]\n  1 -> 1  [color="#ffff00"]\n  1 -> 1  [color="#00ff7f"]\n  2 -> 2  [color="#00ff00"]\n  2 -> 2  [color="#ff00ff"]\n  2 -> 2  [color="#007fff"]\n  2 -> 2  [color="#ff7f00"]\n  2 -> 2  [color="#7fbf7f"]\n  2 -> 2  [color="#4604ac"]\n  2 -> 2  [color="#de0328"]\n  2 -> 2  [color="#19801d"]\n  2 -> 2  [color="#d881f5"]\n  2 -> 2  [color="#00ffff"]\n  2 -> 2  [color="#ffff00"]\n  2 -> 2  [color="#00ff7f"]\n  3 -> 3  [color="#00ff00"]\n  3 -> 3  [color="#ff00ff"]\n  3 -> 3  [color="#007fff"]\n  3 -> 3  [color="#ff7f00"]\n  3 -> 3  [color="#7fbf7f"]\n  3 -> 3  [color="#4604ac"]\n  3 -> 3  [color="#de0328"]\n  3 -> 3  [color="#19801d"]\n  3 -> 3  [color="#d881f5"]\n  3 -> 3  [color="#00ffff"]\n  3 -> 3  [color="#ffff00"]\n  3 -> 3  [color="#00ff7f"]\n}'  # pylint: disable=line-too-long