diff --git a/docs/src/solvers.md b/docs/src/solvers.md index 322f7c2e..1f74344b 100644 --- a/docs/src/solvers.md +++ b/docs/src/solvers.md @@ -10,10 +10,10 @@ | Problem type | Solvers | | --------------------- | -------- | -| Unconstrained NLP | [`lbfgs`](@ref), [`tron`](@ref), [`trunk`](@ref), [`R2`](@ref), [`fomo`](@ref)| -| Unconstrained NLS | [`trunk`](@ref), [`tron`](@ref) | -| Bound-constrained NLP | [`tron`](@ref) | -| Bound-constrained NLS | [`tron`](@ref) | +| Unconstrained Nonlinear Optimization Problem | [`lbfgs`](@ref), [`tron`](@ref), [`trunk`](@ref), [`R2`](@ref), [`fomo`](@ref)| +| Unconstrained Nonlinear Least Squares | [`trunk`](@ref), [`tron`](@ref) | +| Bound-constrained Nonlinear Optimization Problem | [`tron`](@ref) | +| Bound-constrained Nonlinear Least Squares | [`tron`](@ref) | ## Solver list diff --git a/src/fomo.jl b/src/fomo.jl index 79bf358b..8bbb0228 100644 --- a/src/fomo.jl +++ b/src/fomo.jl @@ -154,7 +154,7 @@ For advanced usage, first define a `FomoSolver` to preallocate the memory used i # Output -The value returned is a `GenericExecutionStats`, see `SolverCore.jl`. +The value returned is a [`GenericExecutionStats`](https://jso.dev/SolverCore.jl/stable/95-reference/#SolverCore.GenericExecutionStats), see `SolverCore.jl`. # Callback diff --git a/src/lbfgs.jl b/src/lbfgs.jl index 6ed5a9eb..42f34f6d 100644 --- a/src/lbfgs.jl +++ b/src/lbfgs.jl @@ -70,7 +70,7 @@ The keyword arguments may include - `verbose_subsolver::Int = 0`: if > 0, display iteration information every `verbose_subsolver` iteration of the subsolver. # Output -The returned value is a `GenericExecutionStats`, see `SolverCore.jl`. +The returned value is a [`GenericExecutionStats`](https://jso.dev/SolverCore.jl/stable/95-reference/#SolverCore.GenericExecutionStats), see `SolverCore.jl`. # Callback $(Callback_docstring) diff --git a/src/tron.jl b/src/tron.jl index 7b2bb357..b8d2b7ed 100644 --- a/src/tron.jl +++ b/src/tron.jl @@ -82,7 +82,7 @@ The keyword arguments may include The keyword arguments of `TronSolver` are passed to the [`TRONTrustRegion`](https://jso.dev/SolverTools.jl/stable/95-reference/#SolverTools.TRONTrustRegion) constructor. # Output -The value returned is a `GenericExecutionStats`, see `SolverCore.jl`. +The value returned is a [`GenericExecutionStats`](https://jso.dev/SolverCore.jl/stable/95-reference/#SolverCore.GenericExecutionStats), see `SolverCore.jl`. # Callback $(Callback_docstring) @@ -498,7 +498,9 @@ function projected_line_search!( return s end -"""`α, s = cauchy!(x, H, g, Δ, ℓ, u, s, Hs; μ₀ = 1e-2, μ₁ = 1.0, σ=10.0)` +""" + + α, s = cauchy!(x, H, g, Δ, ℓ, u, s, Hs; μ₀ = 1e-2, μ₁ = 1.0, σ = 10.0) Computes a Cauchy step `s = P(x - α g) - x` for @@ -588,7 +590,7 @@ end Compute an approximate solution `d` for -min q(d) = ¹/₂dᵀHs + dᵀg s.t. ℓ ≦ x + d ≦ u, ‖d‖ ≦ Δ + min q(d) = ¹/₂dᵀHs + dᵀg s.t. ℓ ≦ x + d ≦ u, ‖d‖ ≦ Δ starting from `s`. The steps are computed using the conjugate gradient method projected on the active bounds. diff --git a/src/tronls.jl b/src/tronls.jl index edc8d2f5..6afc00fd 100644 --- a/src/tronls.jl +++ b/src/tronls.jl @@ -83,7 +83,7 @@ The keyword arguments may include The keyword arguments of `TronSolverNLS` are passed to the [`TRONTrustRegion`](https://jso.dev/SolverTools.jl/stable/95-reference/#SolverTools.TRONTrustRegion) constructor. # Output -The value returned is a `GenericExecutionStats`, see `SolverCore.jl`. +The value returned is a [`GenericExecutionStats`](https://jso.dev/SolverCore.jl/stable/95-reference/#SolverCore.GenericExecutionStats), see `SolverCore.jl`. # Callback $(Callback_docstring) @@ -466,7 +466,9 @@ function SolverCore.solve!( stats end -"""`s = projected_line_search_ls!(x, A, g, d, ℓ, u, As, s; μ₀ = 1e-2)` +""" + + s = projected_line_search_ls!(x, A, g, d, ℓ, u, As, s; μ₀ = 1e-2) Performs a projected line search, searching for a step size `t` such that @@ -518,7 +520,9 @@ function projected_line_search_ls!( return s end -"""`α, s = cauchy_ls!(x, A, Fx, g, Δ, ℓ, u, s, As; μ₀ = 1e-2, μ₁ = 1.0, σ=10.0)` +""" + + α, s = cauchy_ls!(x, A, Fx, g, Δ, ℓ, u, s, As; μ₀ = 1e-2, μ₁ = 1.0, σ = 10.0) Computes a Cauchy step `s = P(x - α g) - x` for diff --git a/src/trunk.jl b/src/trunk.jl index a1fde71b..a6e2cb43 100644 --- a/src/trunk.jl +++ b/src/trunk.jl @@ -74,7 +74,7 @@ The keyword arguments may include - `M`: linear operator that models a Hermitian positive-definite matrix of size `n`; passed to Krylov subsolvers. # Output -The returned value is a `GenericExecutionStats`, see `SolverCore.jl`. +The returned value is a [`GenericExecutionStats`](https://jso.dev/SolverCore.jl/stable/95-reference/#SolverCore.GenericExecutionStats), see `SolverCore.jl`. # Callback $(Callback_docstring) diff --git a/src/trunkls.jl b/src/trunkls.jl index aa6fe9f1..8b11adc1 100644 --- a/src/trunkls.jl +++ b/src/trunkls.jl @@ -81,7 +81,7 @@ The keyword arguments may include See `JSOSolvers.trunkls_allowed_subsolvers` for a list of available Krylov solvers. # Output -The value returned is a `GenericExecutionStats`, see `SolverCore.jl`. +The value returned is a [`GenericExecutionStats`](https://jso.dev/SolverCore.jl/stable/95-reference/#SolverCore.GenericExecutionStats), see `SolverCore.jl`. # Callback $(Callback_docstring)