Merge pull request flintlib#2211 from lgoettgens/lg/lu-docstring

Fix docstrings of various `lu` functions
albinahlback · Jan 29, 2025 · 53fdebc · 53fdebc
2 parents edb40b4 + 6589723
commit 53fdebc
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/doc/source/fmpz_mod_mat.rst b/doc/source/fmpz_mod_mat.rst
@@ -321,7 +321,7 @@ LU decomposition
 
 .. function:: slong fmpz_mod_mat_lu(slong * P, fmpz_mod_mat_t A, int rank_check, const fmpz_mod_ctx_t ctx)
 
-    Computes a generalised LU decomposition `LU = PA` of a given
+    Computes a generalised LU decomposition `PLU = A` of a given
     matrix `A`, returning the rank of `A`.
 
     If `A` is a nonsingular square matrix, it will be overwritten with

diff --git a/doc/source/fq_default_mat.rst b/doc/source/fq_default_mat.rst
@@ -323,7 +323,7 @@ LU decomposition
 
 .. function:: slong fq_default_mat_lu(slong * P, fq_default_mat_t A, int rank_check, const fq_default_ctx_t ctx)
 
-    Computes a generalised LU decomposition `LU = PA` of a given
+    Computes a generalised LU decomposition `PLU = A` of a given
     matrix `A`, returning the rank of `A`.
 
     If `A` is a nonsingular square matrix, it will be overwritten with

diff --git a/doc/source/fq_mat.rst b/doc/source/fq_mat.rst
@@ -347,7 +347,7 @@ LU decomposition
 
 .. function:: slong fq_mat_lu(slong * P, fq_mat_t A, int rank_check, const fq_ctx_t ctx)
 
-    Computes a generalised LU decomposition `LU = PA` of a given
+    Computes a generalised LU decomposition `PLU = A` of a given
     matrix `A`, returning the rank of `A`.
 
     If `A` is a nonsingular square matrix, it will be overwritten with

diff --git a/doc/source/fq_nmod_mat.rst b/doc/source/fq_nmod_mat.rst
@@ -346,7 +346,7 @@ LU decomposition
 
 .. function:: slong fq_nmod_mat_lu(slong * P, fq_nmod_mat_t A, int rank_check, const fq_nmod_ctx_t ctx)
 
-    Computes a generalised LU decomposition `LU = PA` of a given
+    Computes a generalised LU decomposition `PLU = A` of a given
     matrix `A`, returning the rank of `A`.
 
     If `A` is a nonsingular square matrix, it will be overwritten with

diff --git a/doc/source/fq_zech_mat.rst b/doc/source/fq_zech_mat.rst
@@ -313,7 +313,7 @@ LU decomposition
 
 .. function:: slong fq_zech_mat_lu(slong * P, fq_zech_mat_t A, int rank_check, const fq_zech_ctx_t ctx)
 
-    Computes a generalised LU decomposition `LU = PA` of a given
+    Computes a generalised LU decomposition `PLU = A` of a given
     matrix `A`, returning the rank of `A`.
 
     If `A` is a nonsingular square matrix, it will be overwritten with

diff --git a/doc/source/nmod_mat.rst b/doc/source/nmod_mat.rst
@@ -593,7 +593,7 @@ LU decomposition
               slong nmod_mat_lu_classical_delayed(slong * P, nmod_mat_t A, int rank_check)
               slong nmod_mat_lu_recursive(slong * P, nmod_mat_t A, int rank_check)
 
-    Computes a generalised LU decomposition `LU = PA` of a given
+    Computes a generalised LU decomposition `PLU = A` of a given
     matrix `A`, returning the rank of `A`.
 
     If `A` is a nonsingular square matrix, it will be overwritten with