Skip to content

Improve documentation and fix docstrings #339

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

Open
tmigot wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve documentation and fix docstrings #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54ae8c9
Improve doc
tmigot Dec 17, 2025
a32ca7b
Update src/tronls.jl
tmigot Dec 17, 2025
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
8 changes: 4 additions & 4 deletions docs/src/solvers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/fomo.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/lbfgs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 5 additions & 3 deletions src/tron.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
10 changes: 7 additions & 3 deletions src/tronls.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/trunk.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/trunkls.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading