{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function does not check the input array for being Hermitian/symmetric in order to allow for representing arrays with only their upper/lower triangular parts." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function serves as a one-liner shorthand for " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.linalg.eigh", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "?", "kind": "module", "path": "scipy.linalg._decomp:eigh" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " with the option " }, { "__type": "InlineCode", "__tag": 4051, "value": "eigvals_only=True" }, { "__type": "Text", "__tag": 4046, "value": " to get the eigenvalues and not the eigenvectors. Here it is kept as a legacy convenience. It might be beneficial to use the main function to have full control and to be a bit more pythonic." } ] } ], "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": "If eigenvalue computation does not converge, an error occurred, or b matrix is not definite positive. Note that if input matrices are not symmetric or Hermitian, no error will be reported but results will be wrong." } ] } ] } ] } ], "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": "w", "annotation": "(..., M) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The M (M<=N) selected eigenvalues, in ascending order, each repeated according to its multiplicity." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Solves a standard or generalized eigenvalue problem for a complex Hermitian or real symmetric 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": "(..., N, N) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A complex Hermitian or real symmetric matrix whose eigenvalues will be computed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "b", "annotation": "(..., N, N) array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A complex Hermitian or real symmetric definite positive matrix in. If omitted, identity matrix is assumed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "lower", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether the pertinent array data is taken from the lower or upper triangle of " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " and, if applicable, " }, { "__type": "InlineCode", "__tag": 4051, "value": "b" }, { "__type": "Text", "__tag": 4046, "value": ". (Default: lower)" } ] } ] }, { "__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": "overwrite_b", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to overwrite data in " }, { "__type": "InlineCode", "__tag": 4051, "value": "b" }, { "__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": "type", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For the generalized problems, this keyword specifies the problem type to be solved for " }, { "__type": "InlineCode", "__tag": 4051, "value": "w" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "v" }, { "__type": "Text", "__tag": 4046, "value": " (only takes 1, 2, 3 as possible inputs) " } ] }, { "__type": "Code", "__tag": 4050, "value": "1 => a @ v = w @ b @ v\n2 => a @ b @ v = w @ v\n3 => b @ a @ v = w @ v", "execution_status": null, "out": "" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This keyword is ignored for standard problems." } ] } ] }, { "__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 matrices contain 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": "subset_by_index", "annotation": "iterable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If provided, this two-element iterable defines the start and the end indices of the desired eigenvalues (ascending order and 0-indexed). To return only the second smallest to fifth smallest eigenvalues, " }, { "__type": "InlineCode", "__tag": 4051, "value": "[1, 4]" }, { "__type": "Text", "__tag": 4046, "value": " is used. " }, { "__type": "InlineCode", "__tag": 4051, "value": "[n-3, n-1]" }, { "__type": "Text", "__tag": 4046, "value": " returns the largest three. Only available with \"evr\", \"evx\", and \"gvx\" drivers. The entries are directly converted to integers via " }, { "__type": "InlineCode", "__tag": 4051, "value": "int()" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "subset_by_value", "annotation": "iterable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If provided, this two-element iterable defines the half-open interval " }, { "__type": "InlineCode", "__tag": 4051, "value": "(a, b]" }, { "__type": "Text", "__tag": 4046, "value": " that, if any, only the eigenvalues between these values are returned. Only available with \"evr\", \"evx\", and \"gvx\" drivers. Use " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.inf" }, { "__type": "Text", "__tag": 4046, "value": " for the unconstrained ends. Not supported for > 2D inputs due to the possibility of different numbers of selected eigenvalues per slice." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "driver", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Defines which LAPACK driver should be used. Valid options are \"ev\", \"evd\", \"evr\", \"evx\" for standard problems and \"gv\", \"gvd\", \"gvx\" for generalized (where b is not None) problems. See the Notes section of " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.linalg.eigh", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "?", "kind": "module", "path": "scipy.linalg._decomp:eigh" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Find eigenvalues array " }, { "__type": "InlineCode", "__tag": 4051, "value": "w" }, { "__type": "Text", "__tag": 4046, "value": " of array " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "b" }, { "__type": "Text", "__tag": 4046, "value": " is positive definite such that for every eigenvalue λ (i-th entry of w) and its eigenvector vi (i-th column of v) satisfies " } ] }, { "__type": "Code", "__tag": 4050, "value": " a @ vi = λ * b @ vi\nvi.conj().T @ a @ vi = λ\nvi.conj().T @ b @ vi = 1", "execution_status": null, "out": "" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In the standard problem, b is assumed to be the identity matrix." } ] } ], "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.py", "item_line": 933, "item_type": "function", "aliases": [ "scipy.linalg.eigvalsh" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "For more examples see `scipy.linalg.eigh`.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import eigvalsh\nA = np.array([[6, 3, 1, 5], [3, 0, 5, 1], [1, 5, 6, 2], [5, 1, 2, 2]])\nw = eigvalsh(A)\n", "execution_status": "success", "out": "" }, { "__type": "Code", "__tag": 4050, "value": "w\n", "execution_status": "failure", "out": "array([-3.75, -0.76, 6.09, 12.42])\n" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "eigh", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp:eigh" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "eigenvalues and right eigenvectors for symmetric/Hermitian arrays" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "eigvals", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp:eigvals" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "eigenvalues of general arrays" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "eigvals_banded", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp:eigvals_banded" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "eigenvalues for symmetric/Hermitian band matrices" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "eigvalsh_tridiagonal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._decomp:eigvalsh_tridiagonal" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "eigenvalues of symmetric/Hermitian tridiagonal matrices" } ] } ], "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": "b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "lower", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite_a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite_b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "type", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "check_finite", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "subset_by_index", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "subset_by_value", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "driver", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "eigvalsh" }, "references": null, "qa": "scipy.linalg._decomp:eigvalsh", "arbitrary": [], "local_refs": [ "a", "b", "check_finite", "driver", "lower", "overwrite_a", "overwrite_b", "subset_by_index", "subset_by_value", "type", "w" ] }