Include (semi-)definite in the description

Modifies the docstring to include the (semi-). Otherwise it sounds as though Cholesky is only picked for positive and negative definite operators.
patrick-kidger · Feb 15, 2025 · 52f9d3f · 52f9d3f
1 parent fa6c777
commit 52f9d3f
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lineax/_solve.py b/lineax/_solve.py
@@ -534,7 +534,7 @@ class AutoLinearSolver(AbstractLinearSolver[_AutoLinearSolverState], strict=True
         - If the operator is diagonal, then use [`lineax.Diagonal`][].
         - If the operator is tridiagonal, then use [`lineax.Tridiagonal`][].
         - If the operator is triangular, then use [`lineax.Triangular`][].
-        - If the matrix is positive or negative definite, then use
+        - If the matrix is positive or negative (semi-)definite, then use
             [`lineax.Cholesky`][].
         - Else use [`lineax.LU`][].
 
@@ -553,7 +553,7 @@ class AutoLinearSolver(AbstractLinearSolver[_AutoLinearSolverState], strict=True
         - If the operator is diagonal, then use [`lineax.Diagonal`][].
         - If the operator is tridiagonal, then use [`lineax.Tridiagonal`][].
         - If the operator is triangular, then use [`lineax.Triangular`][].
-        - If the matrix is positive or negative definite, then use
+        - If the matrix is positive or negative (semi-)definite, then use
             [`lineax.Cholesky`][].
         - Else, use [`lineax.LU`][].