Skip to content

Commit f6a6372

Browse files
authored
Highlight usage of default_algorithm in decomposition documentation (#169)
* Highlight usage of `default_algorithm` in decomposition documentation * Remove `default_algorithm` export * And then actually do it
1 parent 8de569f commit f6a6372

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

docs/src/user_interface/decompositions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ f!(A, [F]; kwargs...) -> F...
1616

1717
Here, the input matrix is always the first argument, and optionally the output can be provided as well.
1818
The keywords are algorithm-specific, and can be used to influence the behavior of the algorithms.
19+
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 [`MatrixAlgebraKit.default_algorithm(f, A)`](@ref) and check the documentation of resulting algorithm type.
1920
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.
2021
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.
2122

0 commit comments

Comments
 (0)