{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Permutation matrices are costly since they are nothing but row reorder of " }, { "__type": "InlineCode", "__tag": 4051, "value": "L" }, { "__type": "Text", "__tag": 4046, "value": " and hence indices are strongly recommended to be used instead if the permutation is required. The relation in the 2D case then becomes simply " }, { "__type": "InlineCode", "__tag": 4051, "value": "A = L[P, :] @ U" }, { "__type": "Text", "__tag": 4046, "value": ". In higher dimensions, it is better to use " }, { "__type": "ParamRef", "__tag": 4071, "name": "permute_l" }, { "__type": "Text", "__tag": 4046, "value": " to avoid complicated indexing tricks." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In 2D case, if one has the indices however, for some reason, the permutation matrix is still needed then it can be constructed by " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.eye(M)[P, :]" }, { "__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": "", "annotation": "(p, l, u) | (pl, u):", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The tuple " }, { "__type": "InlineRole", "__tag": 4003, "value": "(p, l, u)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is returned if " }, { "__type": "ParamRef", "__tag": 4071, "name": "permute_l" }, { "__type": "Text", "__tag": 4046, "value": " is " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": " (default) else the tuple " }, { "__type": "InlineRole", "__tag": 4003, "value": "(pl, u)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is returned, where:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "p" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "p" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "l" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "l" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "pl" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "pl" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "u" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "u" } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute LU decomposition of a matrix with partial pivoting." } ] } ], "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": "Array to decompose" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "permute_l", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Perform the multiplication P*L (Default: do not permute)" } ] } ] }, { "__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 improve 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." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "p_indices", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " the permutation information is returned as row indices. The default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": " for backwards-compatibility reasons." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The decomposition satisfies " } ] }, { "__type": "Code", "__tag": 4050, "value": "A = P @ L @ U", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where " }, { "__type": "InlineCode", "__tag": 4051, "value": "P" }, { "__type": "Text", "__tag": 4046, "value": " is a permutation matrix, " }, { "__type": "InlineCode", "__tag": 4051, "value": "L" }, { "__type": "Text", "__tag": 4046, "value": " lower triangular with unit diagonal elements, and " }, { "__type": "InlineCode", "__tag": 4051, "value": "U" }, { "__type": "Text", "__tag": 4046, "value": " upper triangular. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "permute_l" }, { "__type": "Text", "__tag": 4046, "value": " is set to " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " then " }, { "__type": "InlineCode", "__tag": 4051, "value": "L" }, { "__type": "Text", "__tag": 4046, "value": " is returned already permuted and hence satisfying " }, { "__type": "InlineCode", "__tag": 4051, "value": "A = L @ U" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "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/_decomp_lu.py", "item_line": 216, "item_type": "function", "aliases": [ "scipy.linalg.lu" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import lu\nA = np.array([[2, 5, 8, 7], [5, 2, 2, 8], [7, 5, 6, 6], [5, 4, 4, 8]])\np, l, u = lu(A)\nnp.allclose(A, p @ l @ u)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "p # Permutation matrix\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "p, _, _ = lu(A, p_indices=True)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "p\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(A, l[p, :] @ u)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nWe can also use nd-arrays, for example, a demonstration with 4D array:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rng = np.random.default_rng()\nA = rng.uniform(low=-4, high=4, size=[3, 2, 4, 8])\np, l, u = lu(A)\np.shape, l.shape, u.shape\nnp.allclose(A, p @ l @ u)\nPL, U = lu(A, permute_l=True)\nnp.allclose(A, PL @ U)\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": "permute_l", "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" }, { "__type": "SigParam", "__tag": 4030, "name": "p_indices", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "lu" }, "references": null, "qa": "scipy.linalg._decomp_lu:lu", "arbitrary": [], "local_refs": [ "a", "check_finite", "overwrite_a", "p_indices", "permute_l" ] }