Skip to content

Commit df2f5a0

Browse files
rename "algorithms" as "solvers"
1 parent 983c2a8 commit df2f5a0

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/src/algorithms.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# [Algorithms](@id algorithms)
1+
# [Solvers](@id algorithms)
22

33
## General case
4-
The algorithms in this package are based upon the approach of [aravkin-baraldi-orban-2022](@cite).
4+
The solvers in this package are based upon the approach of [aravkin-baraldi-orban-2022](@cite).
55
Suppose we are given the general regularized problem
66
```math
77
\underset{x \in \mathbb{R}^n}{\text{minimize}} \quad f(x) + h(x),
@@ -25,18 +25,18 @@ or a quadratic regularization
2525
```math
2626
s_0 \in \underset{s \in \mathbb{R}^n}{\argmin} \ \varphi(s; x_0) + \psi(s; x_0) + \tfrac{1}{2} \sigma \|s\|^2_2.
2727
```
28-
Algorithms that work with a trust-region are [`TR`](@ref TR) and [`TRDH`](@ref TRDH) and the ones working with a quadratic regularization are [`R2`](@ref R2), [`R2N`](@ref R2N) and [`R2DH`](@ref R2DH)
28+
Solvers that work with a trust-region are [`TR`](@ref TR) and [`TRDH`](@ref TRDH) and the ones working with a quadratic regularization are [`R2`](@ref R2), [`R2N`](@ref R2N) and [`R2DH`](@ref R2DH)
2929

3030
The models for the smooth part `f` in this package are always quadratic models of the form
3131
```math
3232
\varphi(s; x_0) = f(x_0) + \nabla f(x_0)^T s + \tfrac{1}{2} s^T H(x_0) s,
3333
```
3434
where $H(x_0)$ is a symmetric matrix that can be either $0$, the Hessian of $f$ (if it exists) or a quasi-Newton approximation.
35-
Some algorithms require a specific structure for $H$, for an overview, refer to the table below.
35+
Some solvers require a specific structure for $H$, for an overview, refer to the table below.
3636

37-
The following table gives an overview of the available algorithms in the general case.
37+
The following table gives an overview of the available solvers in the general case.
3838

39-
Algorithm | Quadratic Regularization | Trust Region | Quadratic term for $\varphi$ : H | Reference
39+
Solver | Quadratic Regularization | Trust Region | Quadratic term for $\varphi$ : H | Reference
4040
----------|--------------------------|--------------|---------------|----------
4141
[`R2`](@ref R2) | Yes | No | $H = 0$ | [aravkin-baraldi-orban-2022; Algorithm 6.1](@cite)
4242
[`R2N`](@ref R2N) | Yes | No | Any Symmetric| [diouane-habiboullah-orban-2024; Algorithm 1](@cite)
@@ -45,7 +45,7 @@ Algorithm | Quadratic Regularization | Trust Region | Quadratic term for $\varph
4545
[`TRDH`](@ref TRDH) | No | Yes | Any Diagonal | [leconte-orban-2025; Algorithm 5.1](@cite)
4646

4747
## Nonlinear least-squares
48-
This package provides two algorithms, [`LM`](@ref LM) and [`LMTR`](@ref LMTR), specialized for regularized, nonlinear least-squares, i.e., problems of the form
48+
This package provides two solvers, [`LM`](@ref LM) and [`LMTR`](@ref LMTR), specialized for regularized, nonlinear least-squares, i.e., problems of the form
4949
```math
5050
\underset{x \in \mathbb{R}^n}{\text{minimize}} \quad \tfrac{1}{2}\|F(x)\|_2^2 + h(x),
5151
```
@@ -55,8 +55,8 @@ In that case, the model $\varphi$ is defined as
5555
\varphi(s; x) = \tfrac{1}{2}\|F(x) + J(x)s\|_2^2,
5656
```
5757
where $J(x)$ is the Jacobian of $F$ at $x$.
58-
Similar to the algorithms in the previous section, we either add a quadratic regularization to the model ([`LM`](@ref LM)) or a trust-region ([`LMTR`](@ref LMTR)).
59-
These algorithms are described in [aravkin-baraldi-orban-2024](@cite).
58+
Similar to the solvers in the previous section, we either add a quadratic regularization to the model ([`LM`](@ref LM)) or a trust-region ([`LMTR`](@ref LMTR)).
59+
These solvers are described in [aravkin-baraldi-orban-2024](@cite).
6060

6161
## Constrained Optimization
6262
For constrained, regularized optimization,

docs/src/examples/basic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ regularized_pb = RegularizedNLPModel(f_model, h)
4343
```
4444

4545
## Solving the problem
46-
We can now choose one of the algorithms presented [here](@ref algorithms) to solve the problem we defined above.
46+
We can now choose one of the solvers presented [here](@ref algorithms) to solve the problem we defined above.
4747
Please refer to other sections of this documentation to make the wisest choice for your particular problem.
4848
Depending on the problem structure and on requirements from the user, some solvers are more appropriate than others.
4949
The following tries to give a quick overview of what choices one can make.
@@ -70,7 +70,7 @@ println("R2 converged after $(out.iter) iterations to the solution x = $(out.sol
7070
println("--------------------------------------------------------------------------------------")
7171
7272
# Now, on this example, we can actually use second information on f.
73-
# To do so, we are going to use TR, a trust-region algorithm that can exploit second order information.
73+
# To do so, we are going to use TR, a trust-region solver that can exploit second order information.
7474
out = TR(regularized_pb, verbose = 10, atol = 1e-3)
7575
println("TR converged after $(out.iter) iterations to the solution x = $(out.solution)")
7676
println("--------------------------------------------------------------------------------------")

docs/src/examples/ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ regularized_pb = RegularizedNLPModel(f_model, h)
5050
```
5151

5252
## Solving the problem
53-
We can now choose one of the algorithms presented [here](@ref algorithms) to solve the problem we defined above.
53+
We can now choose one of the solvers presented [here](@ref algorithms) to solve the problem we defined above.
5454
In the case of least-squares, it is usually more appropriate to choose LM or LMTR.
5555
```@example
5656
using LLSModels

0 commit comments

Comments
 (0)