{ "__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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "x", "annotation": "(M,) or (M, K) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The solution to the system a x = b. Returned shape depends on the shape of " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Solve the equation " }, { "__type": "InlineCode", "__tag": 4051, "value": "a @ x = b" }, { "__type": "Text", "__tag": 4046, "value": " for " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " is the banded matrix defined by " }, { "__type": "ParamRef", "__tag": 4071, "name": "ab" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": "(l, u)", "annotation": "(integer, integer)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of non-zero lower and upper diagonals" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ab", "annotation": "(`l` + `u` + 1, M) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Banded matrix" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "b", "annotation": "(M,) or (M, K) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Right-hand side" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_ab", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Discard data in " }, { "__type": "ParamRef", "__tag": 4071, "name": "ab" }, { "__type": "Text", "__tag": 4046, "value": " (may enhance performance)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_b", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Discard data in " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " (may enhance performance)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "check_finite", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to check that the input matrices contain only finite numbers. Disabling may give a performance gain, but may result in problems (crashes, non-termination) if the inputs do contain infinities or NaNs." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The matrix a is stored in " }, { "__type": "ParamRef", "__tag": 4071, "name": "ab" }, { "__type": "Text", "__tag": 4046, "value": " using the matrix diagonal ordered form " } ] }, { "__type": "Code", "__tag": 4050, "value": "ab[u + i - j, j] == a[i,j]", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Example of " }, { "__type": "ParamRef", "__tag": 4071, "name": "ab" }, { "__type": "Text", "__tag": 4046, "value": " (shape of a is (6,6), " }, { "__type": "InlineRole", "__tag": 4003, "value": "u", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " =1, " }, { "__type": "InlineRole", "__tag": 4003, "value": "l", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " =2) " } ] }, { "__type": "Code", "__tag": 4050, "value": "* a01 a12 a23 a34 a45\na00 a11 a22 a33 a44 a55\na10 a21 a32 a43 a54 *\na20 a31 a42 a53 * *", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The documentation is written assuming array arguments are of specified \"core\" shapes. However, array argument(s) of this function may have additional \"batch\" dimensions prepended to the core shape. In this case, the array is treated as a batch of lower-dimensional slices; see " }, { "__type": "InlineRole", "__tag": 4003, "value": "linalg_batch", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for details." } ] } ], "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/linalg/_basic.py", "item_line": 763, "item_type": "function", "aliases": [ "scipy.linalg.solve_banded" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Solve the banded system a x = b, where::\n\n [5 2 -1 0 0] [0]\n [1 4 2 -1 0] [1]\n a = [0 1 3 2 -1] b = [2]\n [0 0 1 2 2] [2]\n [0 0 0 1 1] [3]\n\nThere is one nonzero diagonal below the main diagonal (l = 1), and\ntwo above (u = 2). The diagonal banded form of the matrix is::\n\n [* * -1 -1 -1]\n ab = [* 2 2 2 2]\n [5 4 3 2 1]\n [1 1 1 1 *]\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import solve_banded\nab = np.array([[0, 0, -1, -1, -1],\n [0, 2, 2, 2, 2],\n [5, 4, 3, 2, 1],\n [1, 1, 1, 1, 0]])\nb = np.array([0, 1, 2, 2, 3])\nx = solve_banded((1, 2), ab, b)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "x\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "l_and_u", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "ab", "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": "overwrite_ab", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite_b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "check_finite", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "solve_banded" }, "references": null, "qa": "scipy.linalg._basic:solve_banded", "arbitrary": [], "local_refs": [ "(l", "ab", "b", "check_finite", "overwrite_ab", "overwrite_b", "u)", "x" ] }