Skip to content

Commit e8a201a

Browse files
remove old doc
1 parent 4047e11 commit e8a201a

File tree

1 file changed

+1
-41
lines changed

1 file changed

+1
-41
lines changed

src/LMTR_alg.jl

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -510,44 +510,4 @@ function SolverCore.solve!(
510510
set_solution!(stats, xk)
511511
set_residuals!(stats, zero(T), sqrt_ξ1_νInv)
512512
return stats
513-
end
514-
515-
"""
516-
LMTR(nls, h, χ, options; kwargs...)
517-
518-
A trust-region Levenberg-Marquardt method for the problem
519-
520-
min ½ ‖F(x)‖² + h(x)
521-
522-
where F: ℝⁿ → ℝᵐ and its Jacobian J are Lipschitz continuous and h: ℝⁿ → ℝ is
523-
lower semi-continuous and proper.
524-
525-
At each iteration, a step s is computed as an approximate solution of
526-
527-
min ½ ‖J(x) s + F(x)‖₂² + ψ(s; x) subject to ‖s‖ ≤ Δ
528-
529-
where F(x) and J(x) are the residual and its Jacobian at x, respectively, ψ(s; x) = h(x + s),
530-
‖⋅‖ is a user-defined norm and Δ > 0 is a trust-region radius.
531-
532-
### Arguments
533-
534-
* `nls::AbstractNLSModel`: a smooth nonlinear least-squares problem
535-
* `h`: a regularizer such as those defined in ProximalOperators
536-
* `χ`: a norm used to define the trust region in the form of a regularizer
537-
* `options::ROSolverOptions`: a structure containing algorithmic parameters
538-
539-
### Keyword arguments
540-
541-
* `x0::AbstractVector`: an initial guess (default: `nls.meta.x0`)
542-
* `subsolver_logger::AbstractLogger`: a logger to pass to the subproblem solver
543-
* `subsolver`: the procedure used to compute a step (`PG`, `R2` or `TRDH`)
544-
* `subsolver_options::ROSolverOptions`: default options to pass to the subsolver.
545-
* `selected::AbstractVector{<:Integer}`: (default `1:nls.meta.nvar`).
546-
547-
### Return values
548-
549-
* `xk`: the final iterate
550-
* `Fobj_hist`: an array with the history of values of the smooth objective
551-
* `Hobj_hist`: an array with the history of values of the nonsmooth objective
552-
* `Complex_hist`: an array with the history of number of inner iterations.
553-
"""
513+
end

0 commit comments

Comments
 (0)