Skip to content

Commit 21c3bc4

Browse files
doc: readd MatrixKind doc
1 parent 537dfc7 commit 21c3bc4

3 files changed

Lines changed: 47 additions & 3 deletions

File tree

docs/source/data-structures/elements/matrix/matrix.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ MatrixKind
150150
----------
151151

152152
.. autoclass:: MatrixKind
153+
:show-inheritance:
153154

154155
..
155156
TODO later summary

docs/source/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

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

8-
.. |libsemigroups-pybind11-version| replace:: 1.0.0
8+
|libsemigroups-pybind11-version| replace:: 1.0.0
99

1010
Installation
1111
============

src/libsemigroups_pybind11/matrix.py

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,52 @@
3636
# the underscore prefix stops this from appearing in the doc of the
3737
# "matrix" submodule
3838
class _MatrixKind(_Enum):
39-
""""""
39+
"""
40+
41+
This enum contains values that can be used to describe the type of semiring
42+
over which a :any:`Matrix` is defined.
43+
44+
.. py:attribute:: MatrixKind.Boolean
45+
:value: <MatrixKind.Boolean: 0>
46+
47+
For matrices over the Boolean semiring.
48+
49+
.. py:attribute:: MatrixKind.Integer
50+
:value: <MatrixKind.Integer: 1>
51+
52+
For matrices over the usual ring of integers.
53+
54+
.. py:attribute:: MatrixKind.MaxPlus
55+
:value: <MatrixKind.MaxPlus: 2>
56+
57+
For matrices over the max-plus semiring.
58+
59+
.. py:attribute:: MatrixKind.MinPlus
60+
:value: <MatrixKind.MinPlus: 3>
4061
41-
# pylint: disable=invalid-name
62+
For matrices over the min-plus semiring.
63+
64+
.. py:attribute:: MatrixKind.ProjMaxPlus
65+
:value: <MatrixKind.ProjMaxPlus: 4>
66+
67+
For projective matrices over the max-plus semiring.
68+
69+
.. py:attribute:: MatrixKind.MaxPlusTrunc
70+
:value: <MatrixKind.MaxPlusTrunc: 5>
71+
72+
For matrices over the truncated max-plus semiring.
73+
74+
.. py:attribute:: MatrixKind.MinPlusTrunc
75+
:value: <MatrixKind.MinPlusTrunc: 6>
76+
77+
For matrices over the truncated min-plus semiring.
78+
79+
.. py:attribute:: MatrixKind.NTP
80+
:value: <MatrixKind.NTP: 7>
81+
82+
For matrices over the semiring of natural numbers quotiented by `t
83+
= t + p`.
84+
"""
4285

4386
Boolean = 0
4487
Integer = 1

0 commit comments

Comments
 (0)