{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The preconditioner " }, { "__type": "ParamRef", "__tag": 4071, "name": "M" }, { "__type": "Text", "__tag": 4046, "value": " should be a matrix such that " }, { "__type": "InlineCode", "__tag": 4051, "value": "M @ A" }, { "__type": "Text", "__tag": 4046, "value": " has a smaller condition number than " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": ", see " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__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": "x", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The converged solution." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "info", "annotation": "integer", "desc": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Provides convergence information:" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "0successful exit >0 : convergence to tolerance not achieved, number of iterations <0 : parameter breakdown" } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Solve " }, { "__type": "InlineCode", "__tag": 4051, "value": "Ax = b" }, { "__type": "Text", "__tag": 4046, "value": " with the BIConjugate Gradient STABilized method." } ] } ], "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": "A", "annotation": "{sparse array, ndarray, LinearOperator}", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The real or complex N-by-N matrix of the linear system. Alternatively, " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": " can be a linear operator which can produce " }, { "__type": "InlineCode", "__tag": 4051, "value": "Ax" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "A^T x" }, { "__type": "Text", "__tag": 4046, "value": " using, e.g., " }, { "__type": "InlineCode", "__tag": 4051, "value": "scipy.sparse.linalg.LinearOperator" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "b", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Right hand side of the linear system. Has shape (N,) or (N,1)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "x0", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Starting guess for the solution." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rtol, atol", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Parameters for the convergence test. For convergence, " }, { "__type": "InlineCode", "__tag": 4051, "value": "norm(b - A @ x) <= max(rtol*norm(b), atol)" }, { "__type": "Text", "__tag": 4046, "value": " should be satisfied. The default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "atol=0." }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "rtol=1e-5" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxiter", "annotation": "integer", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of iterations. Iteration will stop after maxiter steps even if the specified tolerance has not been achieved." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "M", "annotation": "{sparse array, ndarray, LinearOperator}", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Preconditioner for " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": ". It should approximate the inverse of " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": " (see Notes). Effective preconditioning dramatically improves the rate of convergence, which implies that fewer iterations are needed to reach a given error tolerance." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "callback", "annotation": "function", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "User-supplied function to call after each iteration. It is called as " }, { "__type": "InlineCode", "__tag": 4051, "value": "callback(xk)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "xk" }, { "__type": "Text", "__tag": 4046, "value": " is the current solution vector." } ] } ] } ] } ], "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/sparse/linalg/_isolve/iterative.py", "item_line": 158, "item_type": "function", "aliases": [ "scipy.sparse.linalg.bicgstab" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.sparse import csc_array\nfrom scipy.sparse.linalg import bicgstab\nR = np.array([[4, 2, 0, 1],\n [3, 0, 0, 2],\n [0, 1, 1, 1],\n [0, 2, 1, 0]])\nA = csc_array(R)\nb = np.array([-1, -0.5, -1, 2])\nx, exit_code = bicgstab(A, b, atol=1e-5)\nprint(exit_code) # 0 indicates successful convergence\nnp.allclose(A.dot(x), b)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "A", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "b", "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": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "rtol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "1e-05" }, { "__type": "SigParam", "__tag": 4030, "name": "atol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "0.0" }, { "__type": "SigParam", "__tag": 4030, "name": "maxiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "M", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "callback", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "bicgstab" }, "references": [ ".. [1] \"Preconditioner\", Wikipedia, ", " https://en.wikipedia.org/wiki/Preconditioner", ".. [2] \"Biconjugate gradient stabilized method\", ", " Wikipedia, https://en.wikipedia.org/wiki/Biconjugate_gradient_stabilized_method" ], "qa": "scipy.sparse.linalg._isolve.iterative:bicgstab", "arbitrary": [], "local_refs": [ "A", "M", "atol", "b", "callback", "info", "maxiter", "rtol", "x", "x0" ] }