{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In the case of a non-positive definite matrix " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": ", the solver " }, { "__type": "CrossRef", "__tag": 4002, "value": "solve_banded", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._basic:solve_banded" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " may be used." } ] } ], "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 " }, { "__type": "InlineCode", "__tag": 4051, "value": "a x = b" }, { "__type": "Text", "__tag": 4046, "value": ". Shape of return matches 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 Hermitian positive-definite 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": "ab", "annotation": "(``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": "lower", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Is the matrix in the lower form. (Default is upper form)" } ] } ] }, { "__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": "Uses Thomas' Algorithm, which is more efficient than standard LU factorization, but should only be used for Hermitian positive-definite matrices." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The matrix " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " is stored in " }, { "__type": "ParamRef", "__tag": 4071, "name": "ab" }, { "__type": "Text", "__tag": 4046, "value": " either in lower diagonal or upper diagonal ordered form:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "ab[u + i - j, j] == a[i,j] (if upper form; i <= j) ab[ i - j, j] == a[i,j] (if lower form; i >= j)" } ] } ] }, { "__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 " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " is (6, 6), number of upper diagonals, " }, { "__type": "InlineCode", "__tag": 4051, "value": "u" }, { "__type": "Text", "__tag": 4046, "value": " =2) " } ] }, { "__type": "Code", "__tag": 4050, "value": "upper form:\n* * a02 a13 a24 a35\n* a01 a12 a23 a34 a45\na00 a11 a22 a33 a44 a55\n\nlower form:\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": "Cells marked with * are not used." } ] }, { "__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. Note that calls with zero-size batches are unsupported and will raise a " }, { "__type": "InlineCode", "__tag": 4051, "value": "ValueError" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": 894, "item_type": "function", "aliases": [ "scipy.linalg.solveh_banded" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Solve the banded system ``A x = b``, where::\n\n [ 4 2 -1 0 0 0] [1]\n [ 2 5 2 -1 0 0] [2]\n A = [-1 2 6 2 -1 0] b = [2]\n [ 0 -1 2 7 2 -1] [3]\n [ 0 0 -1 2 8 2] [3]\n [ 0 0 0 -1 2 9] [3]\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import solveh_banded\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n``ab`` contains the main diagonal and the nonzero diagonals below the\nmain diagonal. That is, we use the lower form:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "ab = np.array([[ 4, 5, 6, 7, 8, 9],\n [ 2, 2, 2, 2, 2, 0],\n [-1, -1, -1, -1, 0, 0]])\nb = np.array([1, 2, 2, 3, 3, 3])\nx = solveh_banded(ab, b, lower=True)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "x\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nSolve the Hermitian banded system ``H x = b``, where::\n\n [ 8 2-1j 0 0 ] [ 1 ]\n H = [2+1j 5 1j 0 ] b = [1+1j]\n [ 0 -1j 9 -2-1j] [1-2j]\n [ 0 0 -2+1j 6 ] [ 0 ]\n\nIn this example, we put the upper diagonals in the array ``hb``:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "hb = np.array([[0, 2-1j, 1j, -2-1j],\n [8, 5, 9, 6 ]])\nb = np.array([1, 1+1j, 1-2j, 0])\nx = solveh_banded(hb, 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": "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": "lower", "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": "solveh_banded" }, "references": null, "qa": "scipy.linalg._basic:solveh_banded", "arbitrary": [], "local_refs": [ "ab", "b", "check_finite", "lower", "overwrite_ab", "overwrite_b", "x" ] }