Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/data-structures/enums/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


20 changes: 20 additions & 0 deletions docs/source/data-structures/enums/paths-algorithm.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/source/data-structures/word-graph/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ This page contains links to the documentation for the parts of
meeter
paths
word-graph
paths-helpers
helpers
33 changes: 33 additions & 0 deletions docs/source/data-structures/word-graph/paths-helpers.rst
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions docs/source/libsemigroups.bib
Original file line number Diff line number Diff line change
Expand Up @@ -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},
Expand Down
1 change: 1 addition & 0 deletions src/libsemigroups_pybind11/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 23 additions & 0 deletions src/libsemigroups_pybind11/paths.py
Original file line number Diff line number Diff line change
@@ -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"
Loading