{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function uses the Schur decomposition method to compute the matrix square root following " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " and for real matrices " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": ". Moreover, note that, there exist matrices that have square roots that are not polynomials in " }, { "__type": "InlineCode", "__tag": 4051, "value": "A" }, { "__type": "Text", "__tag": 4046, "value": ". For a classical example from " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": ", the matrix satisfies " } ] }, { "__type": "Code", "__tag": 4050, "value": "[ a, a**2 + 1]**2 [-1, 0]\n[-1, -a] = [ 0, -1]", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "for any scalar " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " but it is not a polynomial in " }, { "__type": "InlineCode", "__tag": 4051, "value": "-I" }, { "__type": "Text", "__tag": 4046, "value": ". Thus, they will not be found by this function." } ] } ], "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": "sqrtm", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Computed matrix squareroot of " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": " with same size " }, { "__type": "InlineCode", "__tag": 4051, "value": "(..., n, n)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "errest", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Frobenius norm of the estimated error, ||err||_F / ||A||_F. Only returned, if " }, { "__type": "InlineCode", "__tag": 4051, "value": "disp" }, { "__type": "Text", "__tag": 4046, "value": " is set to " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": ". This return argument will be removed in version 1.20.0 and only the sqrtm result will be returned." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 1.16.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute, if exists, the matrix square root." } ] } ], "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": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input with last two dimensions are square " }, { "__type": "InlineCode", "__tag": 4051, "value": "(..., n, n)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "disp", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Print warning if error in the result is estimated large instead of returning estimated error. (Default: True)" } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 1.16.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "ParamRef", "__tag": 4071, "name": "disp" }, { "__type": "Text", "__tag": 4046, "value": " argument is deprecated and will be removed in SciPy 1.18.0. The previously returned error estimate can be computed as " }, { "__type": "InlineCode", "__tag": 4051, "value": "norm(X @ X - A, 'fro')**2 / norm(A, 'fro')" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "blocksize", "annotation": "integer, optional", "desc": [ { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 1.16.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "ParamRef", "__tag": 4071, "name": "blocksize" }, { "__type": "Text", "__tag": 4046, "value": " argument is deprecated as it is unused by the algorithm and will be removed in SciPy 1.18.0." } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The matrix square root of " }, { "__type": "InlineCode", "__tag": 4051, "value": "A" }, { "__type": "Text", "__tag": 4046, "value": " is a matrix " }, { "__type": "InlineCode", "__tag": 4051, "value": "X" }, { "__type": "Text", "__tag": 4046, "value": " such that " }, { "__type": "InlineCode", "__tag": 4051, "value": "X @ X = A" }, { "__type": "Text", "__tag": 4046, "value": ". Every square matrix is not guaranteed to have a matrix square root, for example, the array " }, { "__type": "InlineCode", "__tag": 4051, "value": "[[0, 1], [0, 0]]" }, { "__type": "Text", "__tag": 4046, "value": " does not have a square root." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Moreover, not every real matrix has a real square root. Hence, for real-valued matrices the return type can be complex if, numerically, there is an eigenvalue on the negative real axis." } ] }, { "__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/_matfuncs.py", "item_line": 415, "item_type": "function", "aliases": [ "scipy.linalg.sqrtm" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import sqrtm\na = np.array([[1.0, 3.0], [1.0, 4.0]])\nr = sqrtm(a)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "r\nr.dot(r)\n", "execution_status": "failure" } ], "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": "disp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "blocksize", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "sqrtm" }, "references": [ ".. [1] Edvin Deadman, Nicholas J. Higham, Rui Ralha (2013)", " \"Blocked Schur Algorithms for Computing the Matrix Square Root,", " Lecture Notes in Computer Science, 7782. pp. 171-182.", " :doi:`10.1016/0024-3795(87)90118-2`", ".. [2] Nicholas J. Higham (1987) \"Computing real square roots of a real", " matrix\", Linear Algebra and its Applications, 88/89:405-430.", " :doi:`10.1016/0024-3795(87)90118-2`" ], "qa": "scipy.linalg._matfuncs:sqrtm", "arbitrary": [], "local_refs": [ "A", "blocksize", "disp", "errest", "sqrtm" ] }