File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -307,9 +307,21 @@ until convergence up to tolerance `tol`.
307307"""
308308 DefaultAlgorithm(; kwargs...)
309309
310- Algorithm sentinel that resolves to the default algorithm for a given function and input
311- type at call time. Any keyword arguments stored in the instance are forwarded at runtime
312- to [`select_algorithm`](@ref).
310+ Algorithm sentinel that resolves to the algorithm section procedures for a given function and input type at call time.
311+ This provides a unified approach for package developers to store keyword argument and direct algorithm inputs.
312+ Any keyword arguments stored in the instance are forwarded at runtime to [`select_algorithm`](@ref).
313+
314+ For example, the following calls are equivalent:
315+
316+ ```julia
317+ A = rand(3, 3)
318+
319+ # specifying keyword arguments
320+ Q, R = qr_compact(A; positive = true)
321+
322+ # wrapping keyword arguments in DefaultAlgorithm
323+ alg = DefaultAlgorithm(; positive = true)
324+ Q, R = qr_compact(A; alg)
313325"""
314326@algdef DefaultAlgorithm
315327
You can’t perform that action at this time.
0 commit comments