Skip to content

Highlight usage of default_algorithm in decomposition documentation #169

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

Merged
lkdvos merged 3 commits into from
Feb 4, 2026
Merged

Highlight usage of default_algorithm in decomposition documentation #169

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19b6be7
Highlight usage of `default_algorithm` in decomposition documentation
leburgel Feb 4, 2026
464204b
Remove `default_algorithm` export
leburgel Feb 4, 2026
ffa35b5
And then actually do it
leburgel Feb 4, 2026
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
1 change: 1 addition & 0 deletions docs/src/user_interface/decompositions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ f!(A, [F]; kwargs...) -> F...

Here, the input matrix is always the first argument, and optionally the output can be provided as well.
The keywords are algorithm-specific, and can be used to influence the behavior of the algorithms.
To check what algorithm is used by default for a given factorization `f` and input `A`, and by extension which keyword arguments it takes, you can call [`default_algorithm(f, A)`](@ref) and check the documentation of resulting algorithm type.
Importantly, for generic code patterns it is recommended to always use the output `F` explicitly, since some implementations may not be able to reuse the provided memory.
Additionally, the `f!` method typically assumes that it is allowed to destroy the input `A`, and making use of the contents of `A` afterwards should be deemed as undefined behavior.

Expand Down
3 changes: 2 additions & 1 deletion src/MatrixAlgebraKit.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export left_polar!, right_polar!
export left_orth, right_orth, left_null, right_null
export left_orth!, right_orth!, left_null!, right_null!

export default_algorithm
Comment thread
lkdvos marked this conversation as resolved.
Outdated
export Native_HouseholderQR, Native_HouseholderLQ
export LAPACK_HouseholderQR, LAPACK_HouseholderLQ, LAPACK_Simple, LAPACK_Expert,
LAPACK_QRIteration, LAPACK_Bisection, LAPACK_MultipleRelativelyRobustRepresentations,
Expand All @@ -50,7 +51,7 @@ export notrunc, truncrank, trunctol, truncerror, truncfilter
@static if VERSION >= v"1.11.0-DEV.469"
eval(
Expr(
:public, :default_algorithm, :findtruncated, :findtruncated_svd,
:public, :findtruncated, :findtruncated_svd,
:select_algorithm
)
)
Expand Down
Loading