{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "On exit, " }, { "__type": "InlineCode", "__tag": 4051, "value": "(ALPHAR(j) + ALPHAI(j)*i)/BETA(j), j=1,...,N" }, { "__type": "Text", "__tag": 4046, "value": ", will be the generalized eigenvalues. " }, { "__type": "InlineCode", "__tag": 4051, "value": "ALPHAR(j) + ALPHAI(j)*i" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "BETA(j),j=1,...,N" }, { "__type": "Text", "__tag": 4046, "value": " are the diagonals of the complex Schur form (S,T) that would result if the 2-by-2 diagonal blocks of the real generalized Schur form of (A,B) were further reduced to triangular form using complex unitary transformations. If ALPHAI(j) is zero, then the jth eigenvalue is real; if positive, then the " }, { "__type": "InlineCode", "__tag": 4051, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": "th and " }, { "__type": "InlineCode", "__tag": 4051, "value": "(j+1)" }, { "__type": "Text", "__tag": 4046, "value": "st eigenvalues are a complex conjugate pair, with " }, { "__type": "InlineCode", "__tag": 4051, "value": "ALPHAI(j+1)" }, { "__type": "Text", "__tag": 4046, "value": " negative." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.17.0" } ] } ] } ], "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": "AA", "annotation": "(N, N) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Generalized Schur form of A." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "BB", "annotation": "(N, N) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Generalized Schur form of B." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "alpha", "annotation": "(N,) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "alpha = alphar + alphai * 1j. See notes." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "beta", "annotation": "(N,) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See notes." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "Q", "annotation": "(N, N) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The left Schur vectors." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "Z", "annotation": "(N, N) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The right Schur vectors." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "QZ decomposition for a pair of matrices with reordering." } ] } ], "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": "(N, N) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "2-D array to decompose" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "B", "annotation": "(N, N) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "2-D array to decompose" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sort", "annotation": "{callable, 'lhp', 'rhp', 'iuc', 'ouc'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies whether the upper eigenvalues should be sorted. A callable may be passed that, given an ordered pair " }, { "__type": "InlineCode", "__tag": 4051, "value": "(alpha, beta)" }, { "__type": "Text", "__tag": 4046, "value": " representing the eigenvalue " }, { "__type": "InlineCode", "__tag": 4051, "value": "x = (alpha/beta)" }, { "__type": "Text", "__tag": 4046, "value": ", returns a boolean denoting whether the eigenvalue should be sorted to the top-left (True). For the real matrix pairs " }, { "__type": "InlineCode", "__tag": 4051, "value": "beta" }, { "__type": "Text", "__tag": 4046, "value": " is real while " }, { "__type": "InlineCode", "__tag": 4051, "value": "alpha" }, { "__type": "Text", "__tag": 4046, "value": " can be complex, and for complex matrix pairs both " }, { "__type": "InlineCode", "__tag": 4051, "value": "alpha" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "beta" }, { "__type": "Text", "__tag": 4046, "value": " can be complex. The callable must be able to accept a NumPy array. Alternatively, string parameters may be used:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'lhp' Left-hand plane (x.real < 0.0)" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'rhp' Right-hand plane (x.real > 0.0)" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'iuc' Inside the unit circle (x*x.conjugate() < 1.0)" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'ouc' Outside the unit circle (x*x.conjugate() > 1.0)" } ] } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "With the predefined sorting functions, an infinite eigenvalue (i.e., " }, { "__type": "InlineCode", "__tag": 4051, "value": "alpha != 0" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "beta = 0" }, { "__type": "Text", "__tag": 4046, "value": ") is considered to lie in neither the left-hand nor the right-hand plane, but it is considered to lie outside the unit circle. For the eigenvalue " }, { "__type": "InlineCode", "__tag": 4051, "value": "(alpha, beta) = (0, 0)" }, { "__type": "Text", "__tag": 4046, "value": ", the predefined sorting functions all return " }, { "__type": "InlineRole", "__tag": 4003, "value": "False", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "output", "annotation": "str {'real','complex'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Construct the real or complex QZ decomposition for real matrices. Default is 'real'." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_a", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the contents of A are overwritten." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_b", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the contents of B are overwritten." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "check_finite", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If true checks the elements of " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "B" }, { "__type": "Text", "__tag": 4046, "value": " are finite numbers. If false does no checking and passes matrix through to underlying algorithm." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__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_qz.py", "item_line": 322, "item_type": "function", "aliases": [ "scipy.linalg.ordqz" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import ordqz\nA = np.array([[2, 5, 8, 7], [5, 2, 2, 8], [7, 5, 6, 6], [5, 4, 4, 8]])\nB = np.array([[0, 6, 0, 0], [5, 0, 2, 1], [5, 2, 6, 6], [4, 7, 7, 7]])\nAA, BB, alpha, beta, Q, Z = ordqz(A, B, sort='lhp')\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nSince we have sorted for left half plane eigenvalues, negatives come first\n\n" }, { "__type": "Code", "__tag": 4050, "value": "(alpha/beta).real < 0\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "qz", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp_qz:qz" }, "kind": "module" }, "descriptions": [], "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": "B", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "sort", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "lhp" }, { "__type": "SigParam", "__tag": 4030, "name": "output", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "real" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite_a", "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": "check_finite", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ordqz" }, "references": null, "qa": "scipy.linalg._decomp_qz:ordqz", "arbitrary": [], "local_refs": [ "A", "AA", "B", "BB", "Q", "Z", "alpha", "beta", "check_finite", "output", "overwrite_a", "overwrite_b", "sort" ] }