{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "NumPy has a logaddexp function which is very similar to " }, { "__type": "CrossRef", "__tag": 4002, "value": "logsumexp", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.special._logsumexp:logsumexp" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", but only handles two arguments. " }, { "__type": "InlineRole", "__tag": 4003, "value": "logaddexp.reduce", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is similar to this function, but may be less stable." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The logarithm is a multivalued function: for each " }, { "__type": "InlineMath", "__tag": 4057, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " there is an infinite number of " }, { "__type": "InlineMath", "__tag": 4057, "value": "z" }, { "__type": "Text", "__tag": 4046, "value": " such that " }, { "__type": "InlineMath", "__tag": 4057, "value": "exp(z) = x" }, { "__type": "Text", "__tag": 4046, "value": ". The convention is to return the " }, { "__type": "InlineMath", "__tag": 4057, "value": "z" }, { "__type": "Text", "__tag": 4046, "value": " whose imaginary part lies in " }, { "__type": "InlineMath", "__tag": 4057, "value": "(-pi, pi]" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "logsumexp", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.special._logsumexp:logsumexp" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ✅ \nPyTorch ✅ ✅ \nJAX ✅ ✅ \nDask ✅ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "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": "res", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The result, " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.log(np.sum(np.exp(a)))" }, { "__type": "Text", "__tag": 4046, "value": " calculated in a numerically more stable way. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " is given then " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.log(np.sum(b*np.exp(a)))" }, { "__type": "Text", "__tag": 4046, "value": " is returned. If " }, { "__type": "InlineCode", "__tag": 4051, "value": "return_sign" }, { "__type": "Text", "__tag": 4046, "value": " is True, " }, { "__type": "InlineCode", "__tag": 4051, "value": "res" }, { "__type": "Text", "__tag": 4046, "value": " contains the log of the absolute value of the argument." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sgn", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "return_sign" }, { "__type": "Text", "__tag": 4046, "value": " is True, this will be an array of floating-point numbers matching res containing +1, 0, -1 (for real-valued inputs) or a complex phase (for complex inputs). This gives the sign of the argument of the logarithm in " }, { "__type": "InlineCode", "__tag": 4051, "value": "res" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "InlineCode", "__tag": 4051, "value": "return_sign" }, { "__type": "Text", "__tag": 4046, "value": " is False, only one result is returned." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the log of the sum of exponentials of input elements." } ] } ], "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": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "None or int or tuple of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Axis or axes over which the sum is taken. By default " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " is None, and all elements are summed." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.11.0" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "b", "annotation": "array-like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Scaling factor for exp(" }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ") must be of the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " or broadcastable to " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". These values may be negative in order to implement subtraction." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.12.0" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "keepdims", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original array." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.15.0" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "return_sign", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If this is set to True, the result will be a pair containing sign information; if False, results that are negative will be returned as NaN. Default is False (no sign information)." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.16.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "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/special/_logsumexp.py", "item_line": 15, "item_type": "function", "aliases": [ "scipy.special.logsumexp" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.special import logsumexp\na = np.arange(10)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "logsumexp(a)\nnp.log(np.sum(np.exp(a)))\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nWith weights\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.arange(10)\nb = np.arange(10, 0, -1)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "logsumexp(a, b=b)\nnp.log(np.sum(b*np.exp(a)))\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nReturning a sign flag\n\n" }, { "__type": "Code", "__tag": 4050, "value": "logsumexp([1,2],b=[1,-1],return_sign=True)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nNotice that `logsumexp` does not directly support masked arrays. To use it\non a masked array, convert the mask into zero weights:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.ma.array([np.log(2), 2, np.log(3)],\n mask=[False, True, False])\nb = (~a.mask).astype(int)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "logsumexp(a.data, b=b), np.log(5)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.logaddexp", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "numpy.logaddexp" }, "kind": "module" }, "descriptions": [], "type": "data" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.logaddexp2", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "numpy.logaddexp2" }, "kind": "module" }, "descriptions": [], "type": "data" } ], "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": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "keepdims", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "return_sign", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "logsumexp" }, "references": null, "qa": "scipy.special._logsumexp:logsumexp", "arbitrary": [], "local_refs": [ "a", "axis", "b", "keepdims", "res", "return_sign", "sgn" ] }