{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Uses inverse parabolic interpolation when possible to speed up convergence of golden section method." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Does not ensure that the minimum lies in the range specified by " }, { "__type": "ParamRef", "__tag": 4071, "name": "brack" }, { "__type": "Text", "__tag": 4046, "value": ". See " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.optimize.fminbound", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.optimize._optimize:fminbound" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": "xmin", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optimum point." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fval", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "(Optional output) Optimum function value." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "iter", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "(Optional output) Number of iterations." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "funcalls", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "(Optional output) Number of objective function evaluations made." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Given a function of one variable and a possible bracket, return a local minimizer of the function isolated to a fractional precision of tol." } ] } ], "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": "func", "annotation": "callable f(x,*args)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Objective function." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "args", "annotation": "tuple, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Additional arguments (if present)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "brack", "annotation": "tuple, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Either a triple " }, { "__type": "InlineCode", "__tag": 4051, "value": "(xa, xb, xc)" }, { "__type": "Text", "__tag": 4046, "value": " satisfying " }, { "__type": "InlineCode", "__tag": 4051, "value": "xa < xb < xc" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "func(xb) < func(xa) and func(xb) < func(xc)" }, { "__type": "Text", "__tag": 4046, "value": ", or a pair " }, { "__type": "InlineCode", "__tag": 4051, "value": "(xa, xb)" }, { "__type": "Text", "__tag": 4046, "value": " to be used as initial points for a downhill bracket search (see " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.optimize.bracket", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.optimize._optimize:bracket" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "). The minimizer " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " will not necessarily satisfy " }, { "__type": "InlineCode", "__tag": 4051, "value": "xa <= x <= xb" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "tol", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Relative error in solution " }, { "__type": "InlineRole", "__tag": 4003, "value": "xopt", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " acceptable for convergence." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "full_output", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, return all output args (xmin, fval, iter, funcalls)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxiter", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of iterations in solution." } ] } ] } ] } ], "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/_optimize.py", "item_line": 2620, "item_type": "function", "aliases": [ "scipy.optimize.brent" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "We illustrate the behaviour of the function when `brack` is of\nsize 2 and 3 respectively. In the case where `brack` is of the\nform ``(xa, xb)``, we can see for the given values, the output does\nnot necessarily lie in the range ``(xa, xb)``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "def f(x):\n return (x-1)**2\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "from scipy import optimize\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "minimizer = optimize.brent(f, brack=(1, 2))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "minimizer\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "res = optimize.brent(f, brack=(-1, 0.5, 2), full_output=True)\nxmin, fval, iter, funcalls = res\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "f(xmin), fval\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "minimize_scalar", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.optimize._minimize:minimize_scalar" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Interface to minimization algorithms for scalar univariate functions. See the 'Brent' " }, { "__type": "InlineRole", "__tag": 4003, "value": "method", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " in particular." } ] } ], "type": null } ], "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": "args", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "()" }, { "__type": "SigParam", "__tag": 4030, "name": "brack", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "tol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1.48e-08" }, { "__type": "SigParam", "__tag": 4030, "name": "full_output", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "maxiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "500" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "brent" }, "references": null, "qa": "scipy.optimize._optimize:brent", "arbitrary": [], "local_refs": [ "args", "brack", "full_output", "func", "funcalls", "fval", "iter", "maxiter", "tol", "xmin" ] }