Skip to content

Commit

Permalink
add docstring for parameters in is_totally_unimodular
Browse files Browse the repository at this point in the history
  • Loading branch information
xuluze committed Sep 2, 2024
1 parent 5739b4e commit 571a7ed
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions src/sage/matrix/matrix_cmr_sparse.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -2197,6 +2197,20 @@ cdef class Matrix_cmr_chr_sparse(Matrix_cmr_sparse):
INPUT:
- ``certificate``: ``False`` or ``True``
If ``True``, then return a :class:`DecompositionNode`
if the linear matroid of ``self`` over `\GF{2}` is regular;
If not, NotImplemented.
- ``stop_when_irregular`` -- boolean (default: ``True``)
Whether to stop decomposing once irregularity is determined.
For a description of other parameters, see :meth:`_set_cmr_seymour_parameters`
- ``row_keys`` -- a finite or enumerated family of arbitrary objects
that index the rows of the matrix
- ``column_keys`` -- a finite or enumerated family of arbitrary objects
that index the columns of the matrix
EXAMPLES::
Expand Down Expand Up @@ -2376,6 +2390,20 @@ cdef class Matrix_cmr_chr_sparse(Matrix_cmr_sparse):
INPUT:
- ``certificate``: ``False`` or ``True``
If ``True``, then return
a :class:`DecompositionNode` if ``self`` is totally unimodular;
a submatrix with determinant not in `\{0, \pm1\}` if not.
- ``stop_when_nonTU`` -- boolean (default: ``True``)
Whether to stop decomposing once not TU is determined.
For a description of other parameters, see :meth:`_set_cmr_seymour_parameters`
- ``row_keys`` -- a finite or enumerated family of arbitrary objects
that index the rows of the matrix
- ``column_keys`` -- a finite or enumerated family of arbitrary objects
that index the columns of the matrix
EXAMPLES::
Expand Down

0 comments on commit 571a7ed

Please sign in to comment.