bundles / scipy latest / scipy / optimize / _trustregion_constr / minimize_trustregion_constr / _minimize_trustregion_constr
function
scipy.optimize._trustregion_constr.minimize_trustregion_constr:_minimize_trustregion_constr
source: /scipy/optimize/_trustregion_constr/minimize_trustregion_constr.py :117
Signature
def _minimize_trustregion_constr ( fun , x0 , args , grad , hess , hessp , bounds , constraints , xtol = 1e-08 , gtol = 1e-08 , barrier_tol = 1e-08 , sparse_jacobian = None , callback = None , maxiter = 1000 , verbose = 0 , finite_diff_rel_step = None , initial_constr_penalty = 1.0 , initial_tr_radius = 1.0 , initial_barrier_parameter = 0.1 , initial_barrier_tolerance = 0.1 , factorization_method = None , disp = False , workers = None ) Summary
Minimize a scalar function subject to constraints.
Parameters
gtol: float, optionalTolerance for termination by the norm of the Lagrangian gradient. The algorithm will terminate when both the infinity norm (i.e., max abs value) of the Lagrangian gradient and the constraint violation are smaller than
gtol. Default is 1e-8.xtol: float, optionalTolerance for termination by the change of the independent variable. The algorithm will terminate when
tr_radius < xtol, wheretr_radiusis the radius of the trust region used in the algorithm. Default is 1e-8.barrier_tol: float, optionalThreshold on the barrier parameter for the algorithm termination. When inequality constraints are present, the algorithm will terminate only when the barrier parameter is less than
barrier_tol. Default is 1e-8.sparse_jacobian: {bool, None}, optionalDetermines how to represent Jacobians of the constraints. If bool, then Jacobians of all the constraints will be converted to the corresponding format. If None (default), then Jacobians won't be converted, but the algorithm can proceed only if they all have the same format.
initial_tr_radius: float, optionalInitial trust radius. The trust radius gives the maximum distance between solution points in consecutive iterations. It reflects the trust the algorithm puts in the local approximation of the optimization problem. For an accurate local approximation the trust-region should be large and for an approximation valid only close to the current point it should be a small one. The trust radius is automatically updated throughout the optimization process, with
initial_tr_radiusbeing its initial value. Default is 1 (recommended in [1], p. 19).initial_constr_penalty: float, optionalInitial constraints penalty parameter. The penalty parameter is used for balancing the requirements of decreasing the objective function and satisfying the constraints. It is used for defining the merit function:
merit_function(x) = fun(x) + constr_penalty * constr_norm_l2(x), whereconstr_norm_l2(x)is the l2 norm of a vector containing all the constraints. The merit function is used for accepting or rejecting trial points andconstr_penaltyweights the two conflicting goals of reducing objective function and constraints. The penalty is automatically updated throughout the optimization process, withinitial_constr_penaltybeing its initial value. Default is 1 (recommended in [1], p 19).initial_barrier_parameter, initial_barrier_tolerance: float, optionalInitial barrier parameter and initial tolerance for the barrier subproblem. Both are used only when inequality constraints are present. For dealing with optimization problems
min_x f(x)subject to inequality constraintsc(x) <= 0the algorithm introduces slack variables, solving the problemmin_(x,s) f(x) + barrier_parameter*sum(ln(s))subject to the equality constraintsc(x) + s = 0instead of the original problem. This subproblem is solved for decreasing values ofbarrier_parameterand with decreasing tolerances for the termination, starting withinitial_barrier_parameterfor the barrier parameter andinitial_barrier_tolerancefor the barrier tolerance. Default is 0.1 for both values (recommended in [1] p. 19). Also note thatbarrier_parameterandbarrier_toleranceare updated with the same prefactor.factorization_method: string or None, optionalMethod to factorize the Jacobian of the constraints. Use None (default) for the auto selection or one of:
'NormalEquation' (requires scikit-sparse)
'AugmentedSystem'
'QRFactorization'
'SVDFactorization'
The methods 'NormalEquation' and 'AugmentedSystem' can be used only with sparse constraints. The projections required by the algorithm will be computed using, respectively, the normal equation and the augmented system approaches explained in [1]. 'NormalEquation' computes the Cholesky factorization of
A A.Tand 'AugmentedSystem' performs the LU factorization of an augmented system. They usually provide similar results. 'AugmentedSystem' is used by default for sparse matrices.The methods 'QRFactorization' and 'SVDFactorization' can be used only with dense constraints. They compute the required projections using, respectively, QR and SVD factorizations. The 'SVDFactorization' method can cope with Jacobian matrices with deficient row rank and will be used whenever other factorization methods fail (which may imply the conversion of sparse matrices to a dense format when required). By default, 'QRFactorization' is used for dense matrices.
finite_diff_rel_step: None or array_like, optionalRelative step size for the finite difference approximation.
maxiter: int, optionalMaximum number of algorithm iterations. Default is 1000.
verbose: {0, 1, 2, 3}, optionalLevel of algorithm's verbosity:
0 (default)work silently.
1display a termination report.
2display progress during iterations.
3display progress during iterations (more complete report).
disp: bool, optionalIf True (default), then
verbosewill be set to 1 if it was 0.workers: int, map-like callable, optionalA map-like callable, such as
multiprocessing.Pool.mapfor evaluating any numerical differentiation in parallel. This evaluation is carried out asworkers(fun, iterable).
Returns
: `OptimizeResult` with the fields documented below. Note the following:All values corresponding to the constraints are ordered as they were passed to the solver. And values corresponding to
boundsconstraints are put after other constraints.All numbers of function, Jacobian or Hessian evaluations correspond to numbers of actual Python function calls. It means, for example, that if a Jacobian is estimated by finite differences, then the number of Jacobian evaluations will be zero and the number of function evaluations will be incremented by all calls during the finite difference estimation.
x: ndarray, shape (n,)Solution found.
optimality: floatInfinity norm of the Lagrangian gradient at the solution.
constr_violation: floatMaximum constraint violation at the solution.
fun: floatObjective function at the solution.
grad: ndarray, shape (n,)Gradient of the objective function at the solution.
lagrangian_grad: ndarray, shape (n,)Gradient of the Lagrangian function at the solution.
nit: intTotal number of iterations.
nfev: integerNumber of the objective function evaluations.
njev: integerNumber of the objective function gradient evaluations.
nhev: integerNumber of the objective function Hessian evaluations.
cg_niter: intTotal number of the conjugate gradient method iterations.
method: {'equality_constrained_sqp', 'tr_interior_point'}Optimization method used.
constr: list of ndarrayList of constraint values at the solution.
jac: list of {ndarray, sparse array}List of the Jacobian matrices of the constraints at the solution.
v: list of ndarrayList of the Lagrange multipliers for the constraints at the solution. For an inequality constraint a positive multiplier means that the upper bound is active, a negative multiplier means that the lower bound is active and if a multiplier is zero it means the constraint is not active.
constr_nfev: list of intNumber of constraint evaluations for each of the constraints.
constr_njev: list of intNumber of Jacobian matrix evaluations for each of the constraints.
constr_nhev: list of intNumber of Hessian evaluations for each of the constraints.
tr_radius: floatRadius of the trust region at the last iteration.
constr_penalty: floatPenalty parameter at the last iteration, see
initial_constr_penalty.barrier_tolerance: floatTolerance for the barrier subproblem at the last iteration. Only for problems with inequality constraints.
barrier_parameter: floatBarrier parameter at the last iteration. Only for problems with inequality constraints.
execution_time: floatTotal execution time.
message: strTermination message.
status: {0, 1, 2, 3, 4}Termination status:
0The maximum number of function evaluations is exceeded.
1
gtoltermination condition is satisfied.2
xtoltermination condition is satisfied.3
callbackraisedStopIteration.4Constraint violation exceeds 'gtol'.
cg_stop_cond: intReason for CG subproblem termination at the last iteration:
0CG subproblem not evaluated.
1Iteration limit was reached.
2Reached the trust-region boundary.
3Negative curvature detected.
4Tolerance was satisfied.
Aliases
-
scipy.optimize._minimize._minimize_trustregion_constr