{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "During the finiteness check (if selected), the entire matrix " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is checked. During decomposition, " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is assumed to be symmetric or Hermitian (as applicable), and only the half selected by option " }, { "__type": "ParamRef", "__tag": 4071, "name": "lower" }, { "__type": "Text", "__tag": 4046, "value": " is referenced. Consequently, if " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is asymmetric/non-Hermitian, " }, { "__type": "CrossRef", "__tag": 4002, "value": "cholesky", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_cholesky:cholesky" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " may still succeed if the symmetric/Hermitian matrix represented by the selected half is positive definite, yet it may fail if an element in the other half is non-finite." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "LinAlgError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Raised if decomposition fails." } ] } ] } ] } ], "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": "c", "annotation": "(..., M, M) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Matrix whose upper or lower triangle contains the Cholesky factor of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". Other parts of the matrix contain random data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "lower", "annotation": "ndarray, bool", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Flag indicating whether the factor is in the lower or upper triangle" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the Cholesky decomposition of a matrix, to use in cho_solve." } ] } ], "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": "(..., M, M) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Matrix to be decomposed" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "lower", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to compute the upper or lower triangular Cholesky factorization. During decomposition, only the selected half of the matrix is referenced. (Default: upper-triangular)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_a", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to overwrite data in " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " (may improve performance). Default is False. See " }, { "__type": "CrossRef", "__tag": 4002, "value": "tutorial_linalg_overwrite", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "tutorial:linalg" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " for details." } ] } ] }, { "__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 entire input matrix contains 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": "Returns a matrix containing the Cholesky decomposition, " }, { "__type": "InlineCode", "__tag": 4051, "value": "A = L L*" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "A = U* U" }, { "__type": "Text", "__tag": 4046, "value": " of a Hermitian positive-definite matrix " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". The return value can be directly used as the first parameter to cho_solve." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "warning", "base_type": "warning", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "warning " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "overwrite_a" }, { "__type": "Text", "__tag": 4046, "value": " is disabled, this function matches " }, { "__type": "CrossRef", "__tag": 4002, "value": "cholesky", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_cholesky:cholesky" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and zeros the other triangle. If it is enabled, the returned matrix may contain random data in the entries not used by the Cholesky decomposition, saving out on the explicit putting to 0 done by " }, { "__type": "CrossRef", "__tag": 4002, "value": "cholesky", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_cholesky:cholesky" }, "kind": "module" }, { "__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": "build-install/usr/lib/python3.14/site-packages/scipy/linalg/_decomp_cholesky.py", "item_line": 125, "item_type": "function", "aliases": [ "scipy.linalg.cho_factor" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import cho_factor\nA = np.array([[9, 3, 1, 5], [3, 7, 5, 1], [1, 5, 9, 2], [5, 1, 2, 6]],\n dtype=float, order=\"F\")\nA_ref = np.copy(A)\nc, low = cho_factor(A)\n", "execution_status": "success", "out": "" }, { "__type": "Code", "__tag": 4050, "value": "c\n", "execution_status": "failure", "out": "array([[ 3. , 1. , 0.33, 1.67],\n [ 0. , 2.45, 1.91, -0.27],\n [ 0. , 0. , 2.29, 0.86],\n [ 0. , 0. , 0. , 1.55]])\n" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(c.T @ c - A, np.zeros((4, 4)))\nc, low = cho_factor(A, overwrite_a=True)\n", "execution_status": "success", "out": "" }, { "__type": "Code", "__tag": 4050, "value": "c\n", "execution_status": "failure", "out": "array([[ 3. , 1. , 0.33, 1.67],\n [ 3. , 2.45, 1.91, -0.27],\n [ 1. , 5. , 2.29, 0.86],\n [ 5. , 1. , 2. , 1.55]])\n" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(np.triu(c).T @ np.triu(c) - A_ref, np.zeros((4, 4)))\n", "execution_status": "success", "out": "True\n" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "cho_solve", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_cholesky:cho_solve" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Solve a linear set equations using the Cholesky factorization of a matrix." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "cholesky", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_cholesky:cholesky" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the Cholesky decomposition and explicitly put the other triangle to 0." } ] } ], "type": null } ], "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": "lower", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite_a", "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": "cho_factor" }, "references": null, "qa": "scipy.linalg._decomp_cholesky:cho_factor", "arbitrary": [], "local_refs": [ "a", "c", "check_finite", "lower", "overwrite_a" ] }