{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The KKT multipliers are returned in the " }, { "__type": "InlineCode", "__tag": 4051, "value": "OptimizeResult.multipliers" }, { "__type": "Text", "__tag": 4046, "value": " attribute as a NumPy array. Denoting the dimension of the equality constraints with " }, { "__type": "InlineCode", "__tag": 4051, "value": "meq" }, { "__type": "Text", "__tag": 4046, "value": ", and of inequality constraints with " }, { "__type": "InlineCode", "__tag": 4051, "value": "mineq" }, { "__type": "Text", "__tag": 4046, "value": ", then the returned array slice " }, { "__type": "InlineCode", "__tag": 4051, "value": "m[:meq]" }, { "__type": "Text", "__tag": 4046, "value": " contains the multipliers for the equality constraints, and the remaining " }, { "__type": "InlineCode", "__tag": 4051, "value": "m[meq:meq + mineq]" }, { "__type": "Text", "__tag": 4046, "value": " contains the multipliers for the inequality constraints. The multipliers corresponding to bound inequalities are not returned. See " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " pp. 321 or " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": " for an explanation of how to interpret these multipliers. The internal QP problem is solved using the methods given in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "3" }, { "__type": "Text", "__tag": 4046, "value": " Chapter 25." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note that if new-style " }, { "__type": "CrossRef", "__tag": 4002, "value": "NonlinearConstraint", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.optimize._constraints:NonlinearConstraint" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "CrossRef", "__tag": 4002, "value": "LinearConstraint", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.optimize._constraints:LinearConstraint" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " were used, then " }, { "__type": "InlineCode", "__tag": 4051, "value": "minimize" }, { "__type": "Text", "__tag": 4046, "value": " converts them first to old-style constraint dicts. It is possible for a single new-style constraint to simultaneously contain both inequality and equality constraints. This means that if there is mixing within a single constraint, then the returned list of multipliers will have a different length than the original new-style constraints." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "res", "annotation": "OptimizeResult", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The optimization result represented as an " }, { "__type": "CrossRef", "__tag": 4002, "value": "OptimizeResult", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.optimize._optimize:OptimizeResult" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " object. In this dict-like object the following fields are of particular importance: " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " the solution array, " }, { "__type": "InlineCode", "__tag": 4051, "value": "success" }, { "__type": "Text", "__tag": 4046, "value": " a Boolean flag indicating if the optimizer exited successfully, " }, { "__type": "InlineCode", "__tag": 4051, "value": "message" }, { "__type": "Text", "__tag": 4046, "value": " which describes the reason for termination, and " }, { "__type": "InlineCode", "__tag": 4051, "value": "multipliers" }, { "__type": "Text", "__tag": 4046, "value": " which contains the Karush-Kuhn-Tucker (KKT) multipliers for the QP approximation used in solving the original nonlinear problem. See " }, { "__type": "InlineCode", "__tag": 4051, "value": "Notes" }, { "__type": "Text", "__tag": 4046, "value": " below. See also " }, { "__type": "CrossRef", "__tag": 4002, "value": "OptimizeResult", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.optimize._optimize:OptimizeResult" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for a description of other attributes." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimize a scalar function of one or more variables using Sequential Least Squares Programming (SLSQP)." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "ftol", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Precision target for the value of f in the stopping criterion. This value controls the final accuracy for checking various optimality conditions; gradient of the lagrangian and absolute sum of the constraint violations should be lower than " }, { "__type": "InlineCode", "__tag": 4051, "value": "ftol" }, { "__type": "Text", "__tag": 4046, "value": ". Similarly, computed step size and the objective function changes are checked against this value. Default is 1e-6." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "eps", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Step size used for numerical approximation of the Jacobian." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "disp", "annotation": "bool", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Set to True to print convergence messages. If False, " }, { "__type": "InlineRole", "__tag": 4003, "value": "verbosity", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is ignored and set to 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxiter", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of iterations. Default value is 100." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "finite_diff_rel_step", "annotation": "None or array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "jac in ['2-point', '3-point', 'cs']" }, { "__type": "Text", "__tag": 4046, "value": " the relative step size to use for numerical approximation of " }, { "__type": "ParamRef", "__tag": 4071, "name": "jac" }, { "__type": "Text", "__tag": 4046, "value": ". The absolute step size is computed as " }, { "__type": "InlineCode", "__tag": 4051, "value": "h = rel_step * sign(x) * max(1, abs(x))" }, { "__type": "Text", "__tag": 4046, "value": ", possibly adjusted to fit into the bounds. For " }, { "__type": "InlineCode", "__tag": 4051, "value": "method='3-point'" }, { "__type": "Text", "__tag": 4046, "value": " the sign of " }, { "__type": "InlineRole", "__tag": 4003, "value": "h", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is ignored. If None (default) then step is selected automatically." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "workers", "annotation": "int, map-like callable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A map-like callable, such as " }, { "__type": "InlineRole", "__tag": 4003, "value": "multiprocessing.Pool.map", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for evaluating any numerical differentiation in parallel. This evaluation is carried out as " }, { "__type": "InlineCode", "__tag": 4051, "value": "workers(fun, iterable)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.16.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/optimize/_slsqp_py.py", "item_line": 219, "item_type": "function", "aliases": [ "scipy.optimize._minimize._minimize_slsqp" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "func", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "x0", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "args", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "()" }, { "__type": "SigParam", "__tag": 4030, "name": "jac", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "bounds", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "constraints", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "()" }, { "__type": "SigParam", "__tag": 4030, "name": "maxiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "100" }, { "__type": "SigParam", "__tag": 4030, "name": "ftol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1e-06" }, { "__type": "SigParam", "__tag": 4030, "name": "iprint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "disp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "eps", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1.4901161193847656e-08" }, { "__type": "SigParam", "__tag": 4030, "name": "callback", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "finite_diff_rel_step", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "workers", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "unknown_options", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "VAR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "_minimize_slsqp" }, "references": [ ".. [1] Nocedal, J., and S J Wright, 2006, \"Numerical Optimization\", Springer,", " New York.", ".. [2] Kraft, D., \"A software package for sequential quadratic programming\",", " 1988, Tech. Rep. DFVLR-FB 88-28, DLR German Aerospace Center, Germany.", ".. [3] Lawson, C. L., and R. J. Hanson, 1995, \"Solving Least Squares Problems\",", " SIAM, Philadelphia, PA." ], "qa": "scipy.optimize._slsqp_py:_minimize_slsqp", "arbitrary": [], "local_refs": [ "disp", "eps", "finite_diff_rel_step", "ftol", "maxiter", "res", "workers" ] }