{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function implements the Dual Annealing optimization. This stochastic approach derived from " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "3" }, { "__type": "Text", "__tag": 4046, "value": " combines the generalization of CSA (Classical Simulated Annealing) and FSA (Fast Simulated Annealing) " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": " coupled to a strategy for applying a local search on accepted locations " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "4" }, { "__type": "Text", "__tag": 4046, "value": ". An alternative implementation of this same algorithm is described in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "5" }, { "__type": "Text", "__tag": 4046, "value": " and benchmarks are presented in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "6" }, { "__type": "Text", "__tag": 4046, "value": ". This approach introduces an advanced method to refine the solution found by the generalized annealing process. This algorithm uses a distorted Cauchy-Lorentz visiting distribution, with its shape controlled by the parameter " }, { "__type": "InlineMath", "__tag": 4057, "value": "q_{v}" } ] }, { "__type": "Math", "__tag": 4058, "value": "g_{q_{v}}(\\Delta x(t)) \\propto \\frac{ \\\n\\left[T_{q_{v}}(t) \\right]^{-\\frac{D}{3-q_{v}}}}{ \\\n\\left[{1+(q_{v}-1)\\frac{(\\Delta x(t))^{2}} { \\\n\\left[T_{q_{v}}(t)\\right]^{\\frac{2}{3-q_{v}}}}}\\right]^{ \\\n\\frac{1}{q_{v}-1}+\\frac{D-1}{2}}}" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Where " }, { "__type": "InlineMath", "__tag": 4057, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": " is the artificial time. This visiting distribution is used to generate a trial jump distance " }, { "__type": "InlineMath", "__tag": 4057, "value": "\\Delta x(t)" }, { "__type": "Text", "__tag": 4046, "value": " of variable " }, { "__type": "InlineMath", "__tag": 4057, "value": "x(t)" }, { "__type": "Text", "__tag": 4046, "value": " under artificial temperature " }, { "__type": "InlineMath", "__tag": 4057, "value": "T_{q_{v}}(t)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "From the starting point, after calling the visiting distribution function, the acceptance probability is computed as follows:" } ] }, { "__type": "Math", "__tag": 4058, "value": "p_{q_{a}} = \\min{\\{1,\\left[1-(1-q_{a}) \\beta \\Delta E \\right]^{ \\\n\\frac{1}{1-q_{a}}}\\}}" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Where " }, { "__type": "InlineMath", "__tag": 4057, "value": "q_{a}" }, { "__type": "Text", "__tag": 4046, "value": " is a acceptance parameter. For " }, { "__type": "InlineMath", "__tag": 4057, "value": "q_{a}<1" }, { "__type": "Text", "__tag": 4046, "value": ", zero acceptance probability is assigned to the cases where" } ] }, { "__type": "Math", "__tag": 4058, "value": "[1-(1-q_{a}) \\beta \\Delta E] < 0" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The artificial temperature " }, { "__type": "InlineMath", "__tag": 4057, "value": "T_{q_{v}}(t)" }, { "__type": "Text", "__tag": 4046, "value": " is decreased according to" } ] }, { "__type": "Math", "__tag": 4058, "value": "T_{q_{v}}(t) = T_{q_{v}}(1) \\frac{2^{q_{v}-1}-1}{\\left( \\\n1 + t\\right)^{q_{v}-1}-1}" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Where " }, { "__type": "InlineMath", "__tag": 4057, "value": "q_{v}" }, { "__type": "Text", "__tag": 4046, "value": " is the visiting parameter." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.2.0" } ] } ] } ], "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 a " }, { "__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. Important attributes are: " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " the solution array, " }, { "__type": "InlineCode", "__tag": 4051, "value": "fun" }, { "__type": "Text", "__tag": 4046, "value": " the value of the function at the solution, and " }, { "__type": "InlineCode", "__tag": 4051, "value": "message" }, { "__type": "Text", "__tag": 4046, "value": " which describes the cause of the termination. See " }, { "__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": "Find the global minimum of a function using Dual Annealing." } ] } ], "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", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The objective function to be minimized. Must be in the form " }, { "__type": "InlineCode", "__tag": 4051, "value": "f(x, *args)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " is the argument in the form of a 1-D array and " }, { "__type": "InlineCode", "__tag": 4051, "value": "args" }, { "__type": "Text", "__tag": 4046, "value": " is a tuple of any additional fixed parameters needed to completely specify the function." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bounds", "annotation": "sequence or `Bounds`", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Bounds for variables. There are two ways to specify the bounds:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Instance of " }, { "__type": "CrossRef", "__tag": 4002, "value": "Bounds", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.optimize._constraints:Bounds" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " class." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sequence of " }, { "__type": "InlineCode", "__tag": 4051, "value": "(min, max)" }, { "__type": "Text", "__tag": 4046, "value": " pairs for each element in " }, { "__type": "InlineRole", "__tag": 4003, "value": "x", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "args", "annotation": "tuple, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Any additional fixed parameters needed to completely specify the objective function." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxiter", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The maximum number of global search iterations. Default value is 1000." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "minimizer_kwargs", "annotation": "dict, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Keyword arguments to be passed to the local minimizer (" }, { "__type": "InlineRole", "__tag": 4003, "value": "minimize", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "). An important option could be " }, { "__type": "InlineCode", "__tag": 4051, "value": "method" }, { "__type": "Text", "__tag": 4046, "value": " for the minimizer method to use. If no keyword arguments are provided, the local minimizer defaults to 'L-BFGS-B' and uses the already supplied bounds. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "minimizer_kwargs" }, { "__type": "Text", "__tag": 4046, "value": " is specified, then the dict must contain all parameters required to control the local minimization. " }, { "__type": "ParamRef", "__tag": 4071, "name": "args" }, { "__type": "Text", "__tag": 4046, "value": " is ignored in this dict, as it is passed automatically. " }, { "__type": "ParamRef", "__tag": 4071, "name": "bounds" }, { "__type": "Text", "__tag": 4046, "value": " is not automatically passed on to the local minimizer as the method may not support them." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "initial_temp", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The initial temperature, use higher values to facilitates a wider search of the energy landscape, allowing dual_annealing to escape local minima that it is trapped in. Default value is 5230. Range is (0.01, 5.e4]." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "restart_temp_ratio", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "During the annealing process, temperature is decreasing, when it reaches " }, { "__type": "InlineCode", "__tag": 4051, "value": "initial_temp * restart_temp_ratio" }, { "__type": "Text", "__tag": 4046, "value": ", the reannealing process is triggered. Default value of the ratio is 2e-5. Range is (0, 1)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "visit", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Parameter for visiting distribution. Default value is 2.62. Higher values give the visiting distribution a heavier tail, this makes the algorithm jump to a more distant region. The value range is (1, 3]." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "accept", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Parameter for acceptance distribution. It is used to control the probability of acceptance. The lower the acceptance parameter, the smaller the probability of acceptance. Default value is -5.0 with a range (-1e4, -5]." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxfun", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Soft limit for the number of objective function calls. If the algorithm is in the middle of a local search, this number will be exceeded, the algorithm will stop just after the local search is done. Default value is 1e7." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rng", "annotation": "{None, int, `numpy.random.Generator`}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " is passed by keyword, types other than " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.Generator", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random._generator:Generator" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " are passed to " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.default_rng", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random:default_rng" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " to instantiate a " }, { "__type": "InlineCode", "__tag": 4051, "value": "Generator" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " is already a " }, { "__type": "InlineCode", "__tag": 4051, "value": "Generator" }, { "__type": "Text", "__tag": 4046, "value": " instance, then the provided instance is used. Specify " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " for repeatable function behavior." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If this argument is passed by position or " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " is passed by keyword, legacy behavior for the argument " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " applies:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " is None (or " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "), the " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.RandomState", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random.mtrand:RandomState" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " singleton is used." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " is an int, a new " }, { "__type": "InlineCode", "__tag": 4051, "value": "RandomState" }, { "__type": "Text", "__tag": 4046, "value": " instance is used, seeded with " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " is already a " }, { "__type": "InlineCode", "__tag": 4051, "value": "Generator" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "RandomState" }, { "__type": "Text", "__tag": 4046, "value": " instance then that instance is used." } ] } ] } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 1.15.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "As part of the " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "SPEC-007" } ], "url": "https://scientific-python.org/specs/spec-0007/", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " transition from use of " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.RandomState", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random.mtrand:RandomState" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.Generator", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random._generator:Generator" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", this keyword was changed from " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": ". For an interim period, both keywords will continue to work, although only one may be specified at a time. After the interim period, function calls using the " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " keyword will emit warnings. The behavior of both " }, { "__type": "ParamRef", "__tag": 4071, "name": "seed" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " are outlined above, but only the " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " keyword should be used in new code." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specify " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " for repeatable minimizations. The random numbers generated only affect the visiting distribution function and new coordinates generation." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "no_local_search", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "no_local_search" }, { "__type": "Text", "__tag": 4046, "value": " is set to True, a traditional Generalized Simulated Annealing will be performed with no local search strategy applied." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "callback", "annotation": "callable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A callback function with signature " }, { "__type": "InlineCode", "__tag": 4051, "value": "callback(x, f, context)" }, { "__type": "Text", "__tag": 4046, "value": ", which will be called for all minima found. " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "f" }, { "__type": "Text", "__tag": 4046, "value": " are the coordinates and function value of the latest minimum found, and " }, { "__type": "InlineCode", "__tag": 4051, "value": "context" }, { "__type": "Text", "__tag": 4046, "value": " has one of the following values:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "0" }, { "__type": "Text", "__tag": 4046, "value": ": minimum detected in the annealing process." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "1" }, { "__type": "Text", "__tag": 4046, "value": ": detection occurred in the local search process." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "2" }, { "__type": "Text", "__tag": 4046, "value": ": detection done in the dual annealing process." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the callback implementation returns True, the algorithm will stop." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "x0", "annotation": "ndarray, shape(n,), optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Coordinates of a single N-D starting point." } ] } ] } ] } ], "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/_dual_annealing.py", "item_line": 452, "item_type": "function", "aliases": [ "scipy.optimize.dual_annealing" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "The following example is a 10-D problem, with many local minima.\nThe function involved is called Rastrigin\n(https://en.wikipedia.org/wiki/Rastrigin_function)\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.optimize import dual_annealing\nfunc = lambda x: np.sum(x*x - 10*np.cos(2*np.pi*x)) + 10*np.size(x)\nlw = [-5.12] * 10\nup = [5.12] * 10\nret = dual_annealing(func, bounds=list(zip(lw, up)))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ret.x\nret.fun\n", "execution_status": "failure" } ], "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": "bounds", "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": "maxiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1000" }, { "__type": "SigParam", "__tag": 4030, "name": "minimizer_kwargs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "initial_temp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "5230.0" }, { "__type": "SigParam", "__tag": 4030, "name": "restart_temp_ratio", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "2e-05" }, { "__type": "SigParam", "__tag": 4030, "name": "visit", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "2.62" }, { "__type": "SigParam", "__tag": 4030, "name": "accept", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-5.0" }, { "__type": "SigParam", "__tag": 4030, "name": "maxfun", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "10000000.0" }, { "__type": "SigParam", "__tag": 4030, "name": "rng", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "no_local_search", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "callback", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "x0", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "seed", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "dual_annealing" }, "references": [ ".. [1] Tsallis C. Possible generalization of Boltzmann-Gibbs", " statistics. Journal of Statistical Physics, 52, 479-487 (1988).", ".. [2] Tsallis C, Stariolo DA. Generalized Simulated Annealing.", " Physica A, 233, 395-406 (1996).", ".. [3] Xiang Y, Sun DY, Fan W, Gong XG. Generalized Simulated", " Annealing Algorithm and Its Application to the Thomson Model.", " Physics Letters A, 233, 216-220 (1997).", ".. [4] Xiang Y, Gong XG. Efficiency of Generalized Simulated", " Annealing. Physical Review E, 62, 4473 (2000).", ".. [5] Xiang Y, Gubian S, Suomela B, Hoeng J. Generalized", " Simulated Annealing for Efficient Global Optimization: the GenSA", " Package for R. The R Journal, Volume 5/1 (2013).", ".. [6] Mullen, K. Continuous Global Optimization in R. Journal of", " Statistical Software, 60(6), 1 - 45, (2014).", " :doi:`10.18637/jss.v060.i06`" ], "qa": "scipy.optimize._dual_annealing:dual_annealing", "arbitrary": [], "local_refs": [ "accept", "args", "bounds", "callback", "func", "initial_temp", "maxfun", "maxiter", "minimizer_kwargs", "no_local_search", "res", "restart_temp_ratio", "rng", "visit", "x0" ] }