Finalize

Author: james-d-mitchell

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

@@ -17,6 +17,8 @@ The Matrix class
 MatrixKind
 ----------
 
+.. TODO move MatrixKind to the "enums" page when it exists
+
 .. autoclass:: MatrixKind
     :show-inheritance:
 
@@ -26,9 +28,19 @@ Contents
 .. autosummary::
     :signatures: short
 
-    ~Matrix
-
-    .. TODO complete
+    Matrix.__init__
+    Matrix.copy
+    Matrix.degree
+    Matrix.number_of_cols
+    Matrix.number_of_rows
+    Matrix.one
+    Matrix.product_inplace
+    Matrix.row
+    Matrix.rows
+    Matrix.scalar_one
+    Matrix.scalar_zero
+    Matrix.swap
+    Matrix.transpose
 
 Full API
 --------

src/libsemigroups_pybind11/matrix.py

@@ -148,40 +148,54 @@ def __init__(self: _Self, kind: MatrixKind, *args) -> None:
         self.py_template_params = (kind,)
         self.init_cxx_obj(*args)
 
-    def __getitem__(self: _Self, *args) -> _Union[int, _Self]:
+    def __getitem__(
+        self: _Self, *args
+    ) -> _Union[int, _Self, _PositiveInfinity, _NegativeInfinity]:
         return _to_cxx(self).__getitem__(*args)
 
     def __setitem__(self: _Self, *args):
         return _to_cxx(self).__setitem__(*args)
 
-    def __imul__(self: _Self, that: _Self | int) -> _Self:
+    def __imul__(
+        self: _Self,
+        that: _Union[_Self, int, _PositiveInfinity, _NegativeInfinity],
+    ) -> _Self:
         return _to_cxx(self).__imul__(that)
 
-    def __mul__(self: _Self, that: _Self | int) -> _Self:
+    def __mul__(
+        self: _Self,
+        that: _Union[_Self, int, _PositiveInfinity, _NegativeInfinity],
+    ) -> _Self:
         return _to_cxx(self).__mul__(that)
 
-    def __iadd__(self: _Self, that: _Self | int) -> _Self:
+    def __iadd__(
+        self: _Self,
+        that: _Union[_Self, int, _PositiveInfinity, _NegativeInfinity],
+    ) -> _Self:
         return _to_cxx(self).__iadd__(that)
 
-    def __add__(self: _Self, that: _Self | int) -> _Self:
+    def __add__(
+        self: _Self,
+        that: _Union[_Self, int, _PositiveInfinity, _NegativeInfinity],
+    ) -> _Self:
         return _to_cxx(self).__add__(that)
 
-    def __gt__(self: _Self, that: _Self | int) -> bool:
+    def __gt__(self: _Self, that: _Union[_Self, int]) -> bool:
         return _to_cxx(self).__gt__(that)
 
-    def __ge__(self: _Self, that: _Self | int) -> bool:
+    def __ge__(self: _Self, that: _Union[_Self, int]) -> bool:
         return _to_cxx(self).__ge__(that)
 
-    def __ne__(self: _Self, that: _Self | int) -> bool:
+    def __ne__(self: _Self, that: _Union[_Self, int]) -> bool:
         return _to_cxx(self).__ne__(that)
 
-    def __eq__(self: _Self, that: _Self | int) -> bool:
+    def __eq__(self: _Self, that: _Union[_Self, int]) -> bool:
         return _to_cxx(self).__eq__(that)
 
-    def __lt__(self: _Self, that: _Self | int) -> bool:
+    def __lt__(self: _Self, that: _Union[_Self, int]) -> bool:
         return _to_cxx(self).__lt__(that)
 
-    def __le__(self: _Self, that: _Self | int) -> bool:
+    def __le__(self: _Self, that: _Union[_Self, int]) -> bool:
         return _to_cxx(self).__le__(that)
 
     def __len__(self: _Self) -> int:

src/matrix.cpp

@@ -764,12 +764,12 @@ Construct an uninitialized `r` by `c` matrix.
           py::init(
               [](size_t threshold,
                  std::vector<std::vector<int_or_constant<scalar_type>>> const&
-                     entries) {
+                     rows) {
                 return make<Mat>(semiring<semiring_type>(threshold),
-                                 to_ints<scalar_type>(entries));
+                                 to_ints<scalar_type>(rows));
               }),
           R"pbdoc(
-:sig=(self: Matrix, kind: MatrixKind, threshold: int, period: int, rows: list[list[int | PositiveInfinity | NegativeInfinity]]) -> None
+:sig=(self: Matrix, kind: MatrixKind, threshold: int, rows: list[list[int | PositiveInfinity | NegativeInfinity]]) -> None:
 
 Construct a matrix from threshold and rows.
 
@@ -779,13 +779,12 @@ Construct a matrix from threshold and rows.
 :param threshold: the threshold of the underlying semiring.
 :type threshold: int
 
-:param period: the period of the underlying semiring.
-:type period: int
-
 :param rows: the rows of the matrix.
 :type rows: list[list[int | PositiveInfinity | NegativeInfinity]]
 
-:raise RunTimeError: if *kind* is not :py:attr:`MatrixKind.NTP`.
+:raise RunTimeError:
+    if *kind* is not :py:attr:`MatrixKind.MaxPlusTrunc` or
+    :py:attr:`MatrixKind.MinPlusTrunc`.
 
 :raise LibsemigroupsError:
   if the entries in *rows* are not of equal length.
@@ -841,7 +840,7 @@ that is a matrix whose kind is any of:
                                  to_ints<scalar_type>(entries));
               }),
           R"pbdoc(
-:sig=(self: Matrix, kind: MatrixKind, threshold: int, period: int, rows: list[list[int | PositiveInfinity | NegativeInfinity]]) -> None:
+:sig=(self: Matrix, kind: MatrixKind, threshold: int, period: int, rows: list[list[int]]) -> None:
 
 Construct a matrix from threshold, period, and rows.
 
@@ -855,7 +854,7 @@ Construct a matrix from threshold, period, and rows.
 :type period: int
 
 :param rows: the rows of the matrix.
-:type rows: list[list[int | PositiveInfinity | NegativeInfinity]]
+:type rows: list[list[int]]
 
 :raise RunTimeError: if *kind* is not :py:attr:`MatrixKind.NTP`.
 
@@ -872,7 +871,7 @@ Construct a matrix from threshold, period, and rows.
           R"pbdoc(
 :sig=(self: Matrix, kind: MatrixKind, threshold: int, period: int, r: int, c: int) -> None:
 
-Construct an uninitialized `r` by `c` matrix.
+Construct an uninitialized `r` by `c` matrix with threshold and period.
 
 :param kind: specifies the underlying semiring.
 :type kind: MatrixKind