{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " is a matrix, then all array results are returned as matrices." } ] } ], "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 computation does not converge." } ] } ] } ] } ], "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": "x", "annotation": "{(N,), (N, K)} ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Least-squares solution. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " is two-dimensional, the solutions are in the " }, { "__type": "InlineRole", "__tag": 4003, "value": "K", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " columns of " }, { "__type": "CrossRef", "__tag": 4002, "value": "x", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "x" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "residuals", "annotation": "{(1,), (K,), (0,)} ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sums of squared residuals: Squared Euclidean 2-norm for each column in " }, { "__type": "InlineCode", "__tag": 4051, "value": "b - a @ x" }, { "__type": "Text", "__tag": 4046, "value": ". If the rank of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is < N or M <= N, this is an empty array. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " is 1-dimensional, this is a (1,) shape array. Otherwise the shape is (K,)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rank", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Rank of matrix " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "s", "annotation": "(min(M, N),) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Singular values of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__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": "Return the least-squares solution to a linear matrix equation." } ] } ], "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": "\"Coefficient\" matrix." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "b", "annotation": "{(M,), (M, K)} array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Ordinate or \"dependent variable\" values. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " is two-dimensional, the least-squares solution is calculated for each of the " }, { "__type": "InlineRole", "__tag": 4003, "value": "K", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " columns of " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rcond", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Cut-off ratio for small singular values of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". For the purposes of rank determination, singular values are treated as zero if they are smaller than " }, { "__type": "ParamRef", "__tag": 4071, "name": "rcond" }, { "__type": "Text", "__tag": 4046, "value": " times the largest singular value of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". The default uses the machine precision times " }, { "__type": "InlineCode", "__tag": 4051, "value": "max(M, N)" }, { "__type": "Text", "__tag": 4046, "value": ". Passing " }, { "__type": "InlineCode", "__tag": 4051, "value": "-1" }, { "__type": "Text", "__tag": 4046, "value": " will use machine precision." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 2.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Previously, the default was " }, { "__type": "InlineCode", "__tag": 4051, "value": "-1" }, { "__type": "Text", "__tag": 4046, "value": ", but a warning was given that this would change." } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Computes the vector " }, { "__type": "CrossRef", "__tag": 4002, "value": "x", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "x" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " that approximately solves the equation " }, { "__type": "InlineCode", "__tag": 4051, "value": "a @ x = b" }, { "__type": "Text", "__tag": 4046, "value": ". The equation may be under-, well-, or over-determined (i.e., the number of linearly independent rows of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " can be less than, equal to, or greater than its number of linearly independent columns). If " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is square and of full rank, then " }, { "__type": "CrossRef", "__tag": 4002, "value": "x", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "x" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " (but for round-off error) is the \"exact\" solution of the equation. Else, " }, { "__type": "CrossRef", "__tag": 4002, "value": "x", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "x" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " minimizes the Euclidean 2-norm " }, { "__type": "InlineMath", "__tag": 4057, "value": "||b - ax||" }, { "__type": "Text", "__tag": 4046, "value": ". If there are multiple minimizing solutions, the one with the smallest 2-norm " }, { "__type": "InlineMath", "__tag": 4057, "value": "||x||" }, { "__type": "Text", "__tag": 4046, "value": " is returned." } ] } ], "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/numpy/linalg/_linalg.py", "item_line": 2417, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.linalg.lstsq" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Fit a line, ``y = mx + c``, through some noisy data-points:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nx = np.array([0, 1, 2, 3])\ny = np.array([-1, 0.2, 0.9, 2.1])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nBy examining the coefficients, we see that the line should have a\ngradient of roughly 1 and cut the y-axis at, more or less, -1.\n\nWe can rewrite the line equation as ``y = Ap``, where ``A = [[x 1]]``\nand ``p = [[m], [c]]``. Now use `lstsq` to solve for `p`:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "A = np.vstack([x, np.ones(len(x))]).T\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "A\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "m, c = np.linalg.lstsq(A, y)[0]\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "m, c\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nPlot the data along with the fitted line:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import matplotlib.pyplot as plt\n_ = plt.plot(x, y, 'o', label='Original data', markersize=10)\n_ = plt.plot(x, m*x + c, 'r', label='Fitted line')\n_ = plt.legend()\nplt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "2.5.0.dev0+git20251130.2de293a", "kind": "assets", "path": "fig-77f433edf6332f64.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.linalg.lstsq", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "scipy.linalg.lstsq" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Similar function in SciPy." } ] } ], "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": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "rcond", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "lstsq" }, "references": null, "qa": "numpy.linalg:lstsq", "arbitrary": [], "local_refs": [ "a", "b", "rank", "rcond", "residuals", "s", "x" ] }