diff --git a/docs/source/data-structures/elements/matrix/matrix.rst b/docs/source/data-structures/elements/matrix/matrix.rst index 90f07303e..bca115d03 100644 --- a/docs/source/data-structures/elements/matrix/matrix.rst +++ b/docs/source/data-structures/elements/matrix/matrix.rst @@ -150,6 +150,7 @@ MatrixKind ---------- .. autoclass:: MatrixKind + :show-inheritance: .. TODO later summary diff --git a/src/libsemigroups_pybind11/matrix.py b/src/libsemigroups_pybind11/matrix.py index 70d16d696..c9019eedf 100644 --- a/src/libsemigroups_pybind11/matrix.py +++ b/src/libsemigroups_pybind11/matrix.py @@ -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: + + For matrices over the Boolean semiring. + + .. py:attribute:: MatrixKind.Integer + :value: + + For matrices over the usual ring of integers. + + .. py:attribute:: MatrixKind.MaxPlus + :value: + + For matrices over the max-plus semiring. + + .. py:attribute:: MatrixKind.MinPlus + :value: + + For matrices over the min-plus semiring. + + .. py:attribute:: MatrixKind.ProjMaxPlus + :value: + + For projective matrices over the max-plus semiring. + + .. py:attribute:: MatrixKind.MaxPlusTrunc + :value: + + For matrices over the truncated max-plus semiring. + + .. py:attribute:: MatrixKind.MinPlusTrunc + :value: + + For matrices over the truncated min-plus semiring. + + .. py:attribute:: MatrixKind.NTP + :value: + + For matrices over the semiring of natural numbers quotiented by `t + = t + p`. + """ Boolean = 0 Integer = 1