From 6589723e078ef4117800dd669cf431c5e37c3326 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20G=C3=B6ttgens?= Date: Wed, 29 Jan 2025 10:53:39 +0100 Subject: [PATCH] Fix docstrings for various `lu` functions --- doc/source/fmpz_mod_mat.rst | 2 +- doc/source/fq_default_mat.rst | 2 +- doc/source/fq_mat.rst | 2 +- doc/source/fq_nmod_mat.rst | 2 +- doc/source/fq_zech_mat.rst | 2 +- doc/source/nmod_mat.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/fmpz_mod_mat.rst b/doc/source/fmpz_mod_mat.rst index 10e4fda62d..b40951271e 100644 --- a/doc/source/fmpz_mod_mat.rst +++ b/doc/source/fmpz_mod_mat.rst @@ -320,7 +320,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 index 9fc7ea34fa..38641bb829 100644 --- a/doc/source/fq_default_mat.rst +++ b/doc/source/fq_default_mat.rst @@ -313,7 +313,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 index 14e292f3b2..d733d677cd 100644 --- a/doc/source/fq_mat.rst +++ b/doc/source/fq_mat.rst @@ -337,7 +337,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 index bb6c1273fe..c0d4526eb1 100644 --- a/doc/source/fq_nmod_mat.rst +++ b/doc/source/fq_nmod_mat.rst @@ -336,7 +336,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 index afb6820b67..9b274d7ecc 100644 --- a/doc/source/fq_zech_mat.rst +++ b/doc/source/fq_zech_mat.rst @@ -303,7 +303,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 index 6d09c0732c..d9afd81eba 100644 --- 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