simpeg.optimization.ProjectedGradient#
- class simpeg.optimization.ProjectedGradient(*, lower=-inf, upper=inf, cg_rtol=0.1, cg_maxiter=5, **kwargs)[source]#
Bases:
Bounded
,InexactCG
,Minimize
,Remember
Attributes
A used defined callback function.
Absolute tolerance for inner CG iterations.
Maximum number of CG iterations.
Relative tolerance for inner CG iterations.
The lower bound value.
InexactCG.maxIterCG has been deprecated.
InexactCG.tolCG has been deprecated.
The upper bound value.
counter
parent
print_type
Methods
activeSet
(x)If we are on a bound
bindingSet
(x)If we are on a bound and the negative gradient points away from the feasible set.
doEndIteration
(xt)Operation called at the end of each minimize iteration.
Called at the start of each minimize iteration. If you have things that also need to run in the method doStartIteration, you can create a method::.
Finds the search direction based on either CG or steepest descent.
finish
()Called at the end of the optimization. If you have things that also need to run in the method finish, you can create a method::.
inactiveSet
(x)The free variables.
minimize
(evalFunction, x0)Minimizes the function (evalFunction) starting at the location x0.
Changes the search direction based on some sort of linesearch or trust-region criteria.
Called if modifySearchDirection fails to find a descent direction.
printDone
([inLS])Called at the end of the optimization routine.
printInit
([inLS])Called at the beginning of the optimization routine.
printIter
([inLS])Called directly after function evaluations.
projection
(x)Make sure we are feasible.
Scales the search direction if appropriate.
startup
(x0)Called at the start of any new minimize call.
recall
remember
save
stoppingCriteria