{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a wrapper to the " }, { "__type": "InlineCode", "__tag": 4051, "value": "*GETRF" }, { "__type": "Text", "__tag": 4046, "value": " routines from LAPACK. Unlike " }, { "__type": "CrossRef", "__tag": 4002, "value": "lu", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_lu:lu" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", it outputs the L and U factors into a single array and returns pivot indices instead of a permutation matrix." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "While the underlying " }, { "__type": "InlineCode", "__tag": 4051, "value": "*GETRF" }, { "__type": "Text", "__tag": 4046, "value": " routines return 1-based pivot indices, the " }, { "__type": "InlineCode", "__tag": 4051, "value": "piv" }, { "__type": "Text", "__tag": 4046, "value": " array returned by " }, { "__type": "InlineCode", "__tag": 4051, "value": "lu_factor" }, { "__type": "Text", "__tag": 4046, "value": " contains 0-based indices." } ] } ], "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": "lu", "annotation": "(M, N) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Matrix containing U in its upper triangle, and L in its lower triangle. The unit diagonal elements of L are not stored." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "piv", "annotation": "(K,) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Pivot indices representing the permutation matrix P: row i of matrix was interchanged with row piv[i]. Of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(K,)" }, { "__type": "Text", "__tag": 4046, "value": ", with " }, { "__type": "InlineCode", "__tag": 4051, "value": "K = min(M, N)" }, { "__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": "Compute pivoted LU decomposition of a matrix." } ] } ], "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, N) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Matrix to decompose" } ] } ] }, { "__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 A (may increase 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 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": "The decomposition is " } ] }, { "__type": "Code", "__tag": 4050, "value": "A = P L U", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where P is a permutation matrix, L lower triangular with unit diagonal elements, and U upper triangular." } ] }, { "__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/_decomp_lu.py", "item_line": 20, "item_type": "function", "aliases": [ "scipy.linalg.lu_factor" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import lu_factor\nA = np.array([[2, 5, 8, 7], [5, 2, 2, 8], [7, 5, 6, 6], [5, 4, 4, 8]])\nlu, piv = lu_factor(A)\npiv\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nConvert LAPACK's ``piv`` array to NumPy index and test the permutation\n\n" }, { "__type": "Code", "__tag": 4050, "value": "def pivot_to_permutation(piv):\n perm = np.arange(len(piv))\n for i in range(len(piv)):\n perm[i], perm[piv[i]] = perm[piv[i]], perm[i]\n return perm\np_inv = pivot_to_permutation(piv)\np_inv\nL, U = np.tril(lu, k=-1) + np.eye(4), np.triu(lu)\nnp.allclose(A[p_inv] - L @ U, np.zeros((4, 4)))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe P matrix in P L U is defined by the inverse permutation and\ncan be recovered using argsort:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "p = np.argsort(p_inv)\np\nnp.allclose(A - L[p] @ U, np.zeros((4, 4)))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nor alternatively:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "P = np.eye(4)[p]\nnp.allclose(A - P @ L @ U, np.zeros((4, 4)))\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "lu", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_lu:lu" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "gives lu factorization in more user-friendly format" } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "lu_solve", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_lu:lu_solve" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "solve an equation system using the LU factorization of a matrix" } ] } ], "type": "func" } ], "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": "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": "lu_factor" }, "references": null, "qa": "scipy.linalg._decomp_lu:lu_factor", "arbitrary": [], "local_refs": [ "a", "check_finite", "lu", "overwrite_a", "piv" ] }