paths: add helpers

Author: james-d-mitchell

docs/source/data-structures/enums/index.rst

@@ -17,6 +17,7 @@ In this section, we describe the :any:`Enum <enum.Enum>` classes available in
     congruence-kind
     matrix-kind
     order
+    paths-algorithm
     side
     tril
-    
+    

docs/source/data-structures/enums/paths-algorithm.rst

@@ -0,0 +1,20 @@
+..
+    Copyright (c) 2025, James 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
+
+The paths.algorithm enum
+========================
+
+This page describes the enum class :any:`paths.algorithm` in ``libsemigroups_pybind11``.
+
+Full API
+--------
+
+.. currentmodule:: libsemigroups_pybind11.paths
+
+.. autoclass:: algorithm

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

@@ -21,5 +21,7 @@ This page contains links to the documentation for the parts of
     joiner
     meeter
     paths
+    paths-helpers
     word-graph
+    paths-helpers
     helpers

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

@@ -0,0 +1,33 @@
+..
+    Copyright (c) 2025 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.
+
+Paths helpers
+=============
+
+This page contains the documentation for the ``paths`` subpackage, that
+contains helper functions for the :any:`Paths` class.
+
+Contents
+--------
+
+.. currentmodule:: libsemigroups_pybind11.paths
+
+.. autosummary::
+    :signatures: short
+
+    number_of_paths_algorithm
+    number_of_paths
+
+Full API
+--------
+
+.. currentmodule:: libsemigroups_pybind11
+
+.. automodule:: libsemigroups_pybind11.paths
+    :members:
+    :imported-members:
+    :exclude-members: algorithm

docs/source/libsemigroups.bib

@@ -6,6 +6,13 @@
 
 %% Saved with string encoding Unicode (UTF-8) 
 
+ @misc{Guennebaud2010aa,
+	author = {Ga\"{e}l Guennebaud and Beno\^{i}t Jacob and others},
+	title = {Eigen v3},
+	howpublished = {http://eigen.tuxfamily.org},
+	year = {2010}
+}
+
 @inbook{Carnino2011,
   title = {Random Generation of Deterministic Acyclic Automata Using Markov Chains},
   ISBN = {9783642222566},

src/libsemigroups_pybind11/__init__.py

@@ -19,6 +19,7 @@
 import libsemigroups_pybind11.kambites
 import libsemigroups_pybind11.knuth_bendix
 import libsemigroups_pybind11.matrix
+import libsemigroups_pybind11.paths
 import libsemigroups_pybind11.pbr
 import libsemigroups_pybind11.sims
 import libsemigroups_pybind11.stephen

src/libsemigroups_pybind11/paths.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2025 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.
+
+"""
+This page contains the documentation for the ``paths`` subpackage, that
+contains helper functions for the :any:`Paths` class.
+"""
+
+from _libsemigroups_pybind11 import (  # pylint: disable=no-name-in-module,unused-import
+    paths_algorithm as algorithm,
+    paths_number_of_paths_algorithm as number_of_paths_algorithm,
+    paths_number_of_paths as number_of_paths,
+)
+
+# The following fools sphinx into thinking that "algorithm" is not an
+# alias.
+algorithm.__module__ = __name__
+algorithm.__name__ = "algorithm"