Skip to content

Commit a0f7b90

Browse files
update doc for R2N with store_h
1 parent 70601cd commit a0f7b90

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/R2N.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ where φ(s ; xₖ) = f(xₖ) + ∇f(xₖ)ᵀs + ½ sᵀBₖs is a quadratic appr
126126
127127
For advanced usage, first define a solver "R2NSolver" to preallocate the memory used in the algorithm, and then call `solve!`:
128128
129-
solver = R2NSolver(reg_nlp; m_monotone = 1)
129+
solver = R2NSolver(reg_nlp; m_monotone = 1, store_h = false)
130130
solve!(solver, reg_nlp)
131131
132132
stats = RegularizedExecutionStats(reg_nlp)
@@ -152,7 +152,8 @@ For advanced usage, first define a solver "R2NSolver" to preallocate the memory
152152
- `θ::T = 1/(1 + eps(T)^(1 / 5))`: is the model decrease fraction with respect to the decrease of the Cauchy model;
153153
- `opnorm_maxiter::Int = 5`: how many iterations of the power method to use to compute the operator norm of Bₖ. If a negative number is provided, then Arpack is used instead;
154154
- `m_monotone::Int = 1`: monotonicity parameter. By default, R2N is monotone but the non-monotone variant will be used if `m_monotone > 1`;
155-
- `sub_kwargs::NamedTuple = NamedTuple()`: a named tuple containing the keyword arguments to be sent to the subsolver. The solver will fail if invalid keyword arguments are provided to the subsolver. For example, if the subsolver is `R2Solver`, you can pass `sub_kwargs = (max_iter = 100, σmin = 1e-6,)`.
155+
- `store_h::Bool = false`: whether the solver stores the Hessian or quasi-Newton approximation in sparse format or not. For quasi-Newton models, this should always be false.
156+
- `sub_kwargs::Dict{Symbol}`: a dictionary containing the keyword arguments to be sent to the subsolver. The solver will fail if invalid keyword arguments are provided to the subsolver.
156157
157158
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.
158159

0 commit comments

Comments
 (0)