{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": [], "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 a truncated Newton (TNC) algorithm." } ] } ], "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": "eps", "annotation": "float or ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineRole", "__tag": 4003, "value": "jac is None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " the absolute step size used for numerical approximation of the jacobian via forward differences." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "scale", "annotation": "list of floats", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Scaling factors to apply to each variable. If None, the factors are up-low for interval bounded variables and 1+|x] for the others. Defaults to None." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "offset", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Value to subtract from each variable. If None, the offsets are (up+low)/2 for interval bounded variables and x for the others." } ] } ] }, { "__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." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxCGit", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of hessian*vector evaluations per main iteration. If maxCGit == 0, the direction chosen is -gradient if maxCGit < 0, maxCGit is set to max(1,min(50,n/2)). Defaults to -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "eta", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Severity of the line search. If < 0 or > 1, set to 0.25. Defaults to -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "stepmx", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum step for the line search. May be increased during call. If too small, it will be set to 10.0. Defaults to 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "accuracy", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Relative precision for finite difference calculations. If <= machine_precision, set to sqrt(machine_precision). Defaults to 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "minfev", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimum function value estimate. Defaults to 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ftol", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Precision goal for the value of f in the stopping criterion. If ftol < 0.0, ftol is set to 0.0 defaults to -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "xtol", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Precision goal for the value of x in the stopping criterion (after applying x scaling factors). If xtol < 0.0, xtol is set to sqrt(machine_precision). Defaults to -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "gtol", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Precision goal for the value of the projected gradient in the stopping criterion (after applying x scaling factors). If gtol < 0.0, gtol is set to 1e-2 * sqrt(accuracy). Setting it to 0.0 is not recommended. Defaults to -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rescale", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Scaling factor (in log10) used to trigger f value rescaling. If 0, rescale at each iteration. If a large value, never rescale. If < 0, rescale is set to 1.3." } ] } ] }, { "__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 the jacobian. 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": "maxfun", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of function evaluations. If None, " }, { "__type": "ParamRef", "__tag": 4071, "name": "maxfun" }, { "__type": "Text", "__tag": 4046, "value": " is set to max(100, 10*len(x0)). Defaults to None." } ] } ] }, { "__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/_tnc.py", "item_line": 285, "item_type": "function", "aliases": [ "scipy.optimize._minimize._minimize_tnc" ], "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": "fun", "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": "eps", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1e-08" }, { "__type": "SigParam", "__tag": 4030, "name": "scale", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "offset", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "mesg_num", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "maxCGit", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__type": "SigParam", "__tag": 4030, "name": "eta", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__type": "SigParam", "__tag": 4030, "name": "stepmx", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "accuracy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "minfev", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "ftol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__type": "SigParam", "__tag": 4030, "name": "xtol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__type": "SigParam", "__tag": 4030, "name": "gtol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__type": "SigParam", "__tag": 4030, "name": "rescale", "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": "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": "maxfun", "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_tnc" }, "references": null, "qa": "scipy.optimize._tnc:_minimize_tnc", "arbitrary": [], "local_refs": [ "accuracy", "disp", "eps", "eta", "finite_diff_rel_step", "ftol", "gtol", "maxCGit", "maxfun", "minfev", "offset", "rescale", "scale", "stepmx", "workers", "xtol" ] }