Skip to content

doc: readd MatrixKind doc #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
james-d-mitchell merged 3 commits into from
Jun 13, 2025
Merged

doc: readd MatrixKind doc #266

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21c3bc4
doc: readd MatrixKind doc
james-d-mitchell Jun 12, 2025
fcd865a
Fix linting
james-d-mitchell Jun 13, 2025
060ca00
Update docs/source/install.rst
james-d-mitchell Jun 13, 2025
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
1 change: 1 addition & 0 deletions docs/source/data-structures/elements/matrix/matrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ MatrixKind
----------

.. autoclass:: MatrixKind
:show-inheritance:

..
TODO later summary
Expand Down
2 changes: 1 addition & 1 deletion docs/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

The full license is in the file LICENSE, distributed with this software.

.. |libsemigroups-pybind11-version| replace:: 1.0.0
|libsemigroups-pybind11-version| replace:: 1.0.0
Comment thread
james-d-mitchell marked this conversation as resolved.
Outdated
Comment thread
james-d-mitchell marked this conversation as resolved.
Outdated

Installation
============
Expand Down
48 changes: 46 additions & 2 deletions src/libsemigroups_pybind11/matrix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,53 @@
# the underscore prefix stops this from appearing in the doc of the
# "matrix" submodule
class _MatrixKind(_Enum):
""""""

# pylint: disable=invalid-name
"""

This enum contains values that can be used to describe the type of semiring
over which a :any:`Matrix` is defined.

.. py:attribute:: MatrixKind.Boolean
:value: <MatrixKind.Boolean: 0>

For matrices over the Boolean semiring.

.. py:attribute:: MatrixKind.Integer
:value: <MatrixKind.Integer: 1>

For matrices over the usual ring of integers.

.. py:attribute:: MatrixKind.MaxPlus
:value: <MatrixKind.MaxPlus: 2>

For matrices over the max-plus semiring.

.. py:attribute:: MatrixKind.MinPlus
:value: <MatrixKind.MinPlus: 3>

For matrices over the min-plus semiring.

.. py:attribute:: MatrixKind.ProjMaxPlus
:value: <MatrixKind.ProjMaxPlus: 4>

For projective matrices over the max-plus semiring.

.. py:attribute:: MatrixKind.MaxPlusTrunc
:value: <MatrixKind.MaxPlusTrunc: 5>

For matrices over the truncated max-plus semiring.

.. py:attribute:: MatrixKind.MinPlusTrunc
:value: <MatrixKind.MinPlusTrunc: 6>

For matrices over the truncated min-plus semiring.

.. py:attribute:: MatrixKind.NTP
:value: <MatrixKind.NTP: 7>

For matrices over the semiring of natural numbers quotiented by `t
= t + p`.
"""

Boolean = 0
Integer = 1
Expand Down