{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Besides providing structure, this framework provides several important services for a vectorized optimization algorithm." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It handles common tasks involving iteration count, function evaluation count, a user-specified callback, and associated termination conditions." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It compresses the attributes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " to eliminate unnecessary computation on elements that have already converged." } ] } ] } ] } ], "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": "_RichResult", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The final result object" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Main loop of a vectorized scalar optimization 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": "work", "annotation": "_RichResult", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "All variables that need to be retained between iterations. Must contain attributes " }, { "__type": "InlineRole", "__tag": 4003, "value": "nit", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "nfev", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineRole", "__tag": 4003, "value": "success", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". All arrays are subject to being \"compressed\" if " }, { "__type": "InlineRole", "__tag": 4003, "value": "preserve_shape is False", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "; nest arrays that should not be compressed inside another object (e.g. " }, { "__type": "InlineRole", "__tag": 4003, "value": "dict", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "CrossRef", "__tag": 4002, "value": "_RichResult", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy._lib._util:_RichResult" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "callback", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "User-specified callback function" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "shape", "annotation": "tuple of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The shape of all output arrays" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxiter", "annotation": "", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of iterations of the algorithm" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "func", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The user-specified callable that is being optimized or solved" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "args", "annotation": "tuple", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Additional positional arguments to be passed to " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "NumPy dtype", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The common dtype of all abscissae and function values" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "pre_func_eval", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A function that accepts " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " and returns " }, { "__type": "InlineRole", "__tag": 4003, "value": "x", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", the active elements of " }, { "__type": "InlineRole", "__tag": 4003, "value": "x", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " at which " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " will be evaluated. May modify attributes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " with any algorithmic steps that need to happen at the beginning of an iteration, before " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " is evaluated," } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "post_func_eval", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A function that accepts " }, { "__type": "InlineRole", "__tag": 4003, "value": "x", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "func(x)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": ". May modify attributes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " with any algorithmic steps that need to happen in the middle of an iteration, after " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " is evaluated but before the termination check." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "check_termination", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A function that accepts " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " and returns " }, { "__type": "InlineRole", "__tag": 4003, "value": "stop", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", a boolean array indicating which of the active elements have met a termination condition." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "post_termination_check", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A function that accepts " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": ". May modify " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " with any algorithmic steps that need to happen after the termination check and before the end of the iteration." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "customize_result", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A function that accepts " }, { "__type": "CrossRef", "__tag": 4002, "value": "res", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "res" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "shape" }, { "__type": "Text", "__tag": 4046, "value": " and returns " }, { "__type": "ParamRef", "__tag": 4071, "name": "shape" }, { "__type": "Text", "__tag": 4046, "value": ". May modify " }, { "__type": "CrossRef", "__tag": 4002, "value": "res", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "res" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " (in-place) according to preferences (e.g. rearrange elements between attributes) and modify " }, { "__type": "ParamRef", "__tag": 4071, "name": "shape" }, { "__type": "Text", "__tag": 4046, "value": " if needed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "res_work_pairs", "annotation": "list of (str, str)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Identifies correspondence between attributes of " }, { "__type": "CrossRef", "__tag": 4002, "value": "res", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "res" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " and attributes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": "; i.e., attributes of active elements of " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " will be copied to the appropriate indices of " }, { "__type": "CrossRef", "__tag": 4002, "value": "res", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "res" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " when appropriate. The order determines the order in which _RichResult attributes will be pretty-printed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "preserve_shape", "annotation": "bool, default: False", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to compress the attributes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "work" }, { "__type": "Text", "__tag": 4046, "value": " (to avoid unnecessary computation on elements that have already converged)." } ] } ] } ] } ], "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/_lib/_elementwise_iterative_method.py", "item_line": 128, "item_type": "function", "aliases": [ "scipy.differentiate.eim._loop" ], "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": "work", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "callback", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "shape", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "maxiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__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": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "pre_func_eval", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "post_func_eval", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "check_termination", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "post_termination_check", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "customize_result", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "res_work_pairs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "xp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "preserve_shape", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "_loop" }, "references": null, "qa": "scipy._lib._elementwise_iterative_method:_loop", "arbitrary": [], "local_refs": [ "args", "callback", "check_termination", "customize_result", "dtype", "func", "maxiter", "post_func_eval", "post_termination_check", "pre_func_eval", "preserve_shape", "res", "res_work_pairs", "shape", "work" ] }