Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docstrings of various lu functions #2211

Merged
merged 1 commit into from
Jan 29, 2025
+6 −6
Merged

Fix docstrings of various lu functions #2211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/fmpz_mod_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/source/fq_default_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/source/fq_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/source/fq_nmod_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/source/fq_zech_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/source/nmod_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading