{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is an interface to the LAPACK routines dgeqrf, zgeqrf, dorgqr, zungqr, dgeqp3, and zgeqp3." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode=economic" }, { "__type": "Text", "__tag": 4046, "value": ", the shapes of Q and R are (M, K) and (K, N) instead of (M,M) and (M,N), with " }, { "__type": "InlineCode", "__tag": 4051, "value": "K=min(M,N)" }, { "__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": [ { "__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": "Q", "annotation": "float or complex ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Of shape (M, M), or (M, K) for " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode='economic'" }, { "__type": "Text", "__tag": 4046, "value": ". Not returned if " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode='r'" }, { "__type": "Text", "__tag": 4046, "value": ". Replaced by tuple " }, { "__type": "InlineCode", "__tag": 4051, "value": "(Q, TAU)" }, { "__type": "Text", "__tag": 4046, "value": " if " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode='raw'" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "R", "annotation": "float or complex ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Of shape (M, N), or (K, N) for " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode in ['economic', 'raw']" }, { "__type": "Text", "__tag": 4046, "value": ". " }, { "__type": "InlineCode", "__tag": 4051, "value": "K = min(M, N)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "P", "annotation": "int ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Of shape (N,) for " }, { "__type": "InlineCode", "__tag": 4051, "value": "pivoting=True" }, { "__type": "Text", "__tag": 4046, "value": ". Not returned if " }, { "__type": "InlineCode", "__tag": 4051, "value": "pivoting=False" }, { "__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 QR 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 be decomposed" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_a", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether data in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is overwritten (may improve performance if " }, { "__type": "ParamRef", "__tag": 4071, "name": "overwrite_a" }, { "__type": "Text", "__tag": 4046, "value": " is set to True by reusing the existing input data structure rather than creating a new one.)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "lwork", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Work array size, lwork >= a.shape[1]. If None or -1, an optimal size is computed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "{'full', 'r', 'economic', 'raw'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Determines what information is to be returned: either both Q and R ('full', default), only R ('r') or both Q and R but computed in economy-size ('economic', see Notes). The final option 'raw' (added in SciPy 0.11) makes the function return two matrices (Q, TAU) in the internal format used by LAPACK." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "pivoting", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether or not factorization should include pivoting for rank-revealing qr decomposition. If pivoting, compute the decomposition " }, { "__type": "InlineCode", "__tag": 4051, "value": "A[:, P] = Q @ R" }, { "__type": "Text", "__tag": 4046, "value": " as above, but where P is chosen such that the diagonal of R is non-increasing. Equivalently, albeit less efficiently, an explicit P matrix may be formed explicitly by permuting the rows or columns (depending on the side of the equation on which it is to be used) of an identity matrix. See Examples." } ] } ] }, { "__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": "Calculate the decomposition " }, { "__type": "InlineCode", "__tag": 4051, "value": "A = Q R" }, { "__type": "Text", "__tag": 4046, "value": " where Q is unitary/orthogonal and R 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_qr.py", "item_line": 27, "item_type": "function", "aliases": [ "scipy.linalg.qr" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import linalg\nrng = np.random.default_rng()\na = rng.standard_normal((9, 6))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "q, r = linalg.qr(a)\nnp.allclose(a, np.dot(q, r))\nq.shape, r.shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "r2 = linalg.qr(a, mode='r')\nnp.allclose(r, r2)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "q3, r3 = linalg.qr(a, mode='economic')\nq3.shape, r3.shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "q4, r4, p4 = linalg.qr(a, pivoting=True)\nd = np.abs(np.diag(r4))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.all(d[1:] <= d[:-1])\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(a[:, p4], np.dot(q4, r4))\nP = np.eye(p4.size)[p4]\nnp.allclose(a, np.dot(q4, r4) @ P)\nnp.allclose(a @ P.T, np.dot(q4, r4))\nq4.shape, r4.shape, p4.shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "q5, r5, p5 = linalg.qr(a, mode='economic', pivoting=True)\nq5.shape, r5.shape, p5.shape\nP = np.eye(6)[:, p5]\nnp.allclose(a @ P, np.dot(q5, r5))\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": "overwrite_a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "lwork", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "full" }, { "__type": "SigParam", "__tag": 4030, "name": "pivoting", "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": "qr" }, "references": null, "qa": "scipy.linalg._decomp_qr:qr", "arbitrary": [], "local_refs": [ "P", "Q", "R", "a", "check_finite", "lwork", "mode", "overwrite_a", "pivoting" ] }