Skip to content

Commit 032a2b5

Browse files
add reduce_TR doc
1 parent 37d9bac commit 032a2b5

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/TRDH_alg.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,12 @@ For advanced usage, first define a solver "TRDHSolver" to preallocate the memory
134134
- `η1::T = √√eps(T)`: successful iteration threshold;
135135
- `η2::T = T(0.9)`: very successful iteration threshold;
136136
- `γ::T = T(3)`: trust-region radius parameter multiplier. Must satisfy `γ > 1`. The trust-region radius is updated as Δ := Δ*γ when the iteration is very successful and Δ := Δ/γ when the iteration is unsuccessful;
137-
- `reduce_TR::Bool = True`: TODO
137+
- `reduce_TR::Bool = true`: see explanation on the stopping criterion below;
138138
- `χ::F = NormLinf(1)`: norm used to define the trust-region;`
139139
- `D::L = nothing`: diagonal quasi-Newton approximation used for the model φ. If nothing is provided and `reg_nlp.model` is not a diagonal quasi-Newton approximation, a spectral gradient approximation is used.`
140140
141141
The algorithm stops either when `√(ξₖ/νₖ) < atol + rtol*√(ξ₀/ν₀) ` or `ξₖ < 0` and `√(-ξₖ/νₖ) < neg_tol` where ξₖ := f(xₖ) + h(xₖ) - φ(sₖ; xₖ) - ψ(sₖ; xₖ), and √(ξₖ/νₖ) is a stationarity measure.
142+
Alternatively, if `reduce_TR = true`, then ξₖ₁ := f(xₖ) + h(xₖ) - φ(sₖ₁; xₖ) - ψ(sₖ₁; xₖ) is used instead of ξₖ, where sₖ₁ is the Cauchy point.
142143
143144
# Output
144145
The value returned is a `GenericExecutionStats`, see `SolverCore.jl`.

0 commit comments

Comments
 (0)