From 2eefff24644e678b74dbfccb16fdf3c5ca002fc2 Mon Sep 17 00:00:00 2001 From: "Matthias C. M. Troffaes" Date: Thu, 19 Sep 2024 14:49:24 +0100 Subject: [PATCH] Document the new function. --- cython/pycddlib.pxi | 3 ++- docs/source/cdd.rst | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/cython/pycddlib.pxi b/cython/pycddlib.pxi index 0a24a30..a54bfc1 100644 --- a/cython/pycddlib.pxi +++ b/cython/pycddlib.pxi @@ -348,7 +348,8 @@ def matrix_append_to(mat1: Matrix, mat2: Matrix) -> None: def redundant( mat: Matrix, row: int, strong: bool = False ) -> tuple[bool, Sequence[NumberType]]: - """Checks whether *row* is (strongly) redundant for the representation *mat*. + """Checks whether *row* is + (strongly if *strong* is ``True``) redundant for the representation *mat*. Linearity rows are not checked i.e. *row* should not be in the :attr:`~cdd.Matrix.lin_set`. diff --git a/docs/source/cdd.rst b/docs/source/cdd.rst index ba60f76..e0d6258 100644 --- a/docs/source/cdd.rst +++ b/docs/source/cdd.rst @@ -87,6 +87,8 @@ Functions .. autofunction:: matrix_canonicalize .. autofunction:: matrix_rank +.. autofunction:: redundant + .. autofunction:: linprog_solve .. autofunction:: copy_input