scipy.special.

logsumexp#

scipy.special.logsumexp(a, axis=None, b=None, keepdims=False, return_sign=False)[source]#

计算输入元素指数和的对数。

参数:
aarray_like

输入数组。

axisNone 或 int 或 int 元组，可选

对其进行求和的轴或多个轴。 默认情况下，axis 为 None，并对所有元素求和。

0.11.0 版本新增。

b类数组，可选

exp(a) 的缩放因子必须与 a 具有相同的形状，或者可广播到 a。 这些值可能为负数，以便实现减法。

0.12.0 版本新增。

keepdimsbool，可选

如果将其设置为 True，则缩减的轴将保留在结果中，作为大小为 1 的维度。 使用此选项，结果将与原始数组正确广播。

0.15.0 版本新增。

return_signbool，可选

如果将其设置为 True，则结果将是一对包含符号信息；如果为 False，则负数结果将作为 NaN 返回。 默认为 False（无符号信息）。

0.16.0 版本新增。

返回值:
resndarray

结果，np.log(np.sum(np.exp(a))) 以数值上更稳定的方式计算。如果给出 b，则返回 np.log(np.sum(b*np.exp(a)))。如果 return_sign 为 True，则 res 包含参数绝对值的对数。

sgnndarray

如果 return_sign 为 True，这将是一个与 res 匹配的浮点数数组，包含 +1、0、-1（对于实值输入）或复相位（对于复数输入）。 这给出了 res 中对数参数的符号。 如果 return_sign 为 False，则仅返回一个结果。

参见

numpy.logaddexp
numpy.logaddexp2

注释

NumPy 有一个 logaddexp 函数，它与 logsumexp 非常相似，但仅处理两个参数。 logaddexp.reduce 类似于此函数，但可能不太稳定。

对数是一个多值函数：对于每个 \(x\)，都有无数个 \(z\) 使得 \(exp(z) = x\)。 约定是返回虚部位于 \((-pi, pi]\) 中的 \(z\)。

logsumexp 除了 NumPy 之外，还实验性地支持 Python Array API Standard 兼容的后端。 请考虑通过设置环境变量 SCIPY_ARRAY_API=1 并提供 CuPy、PyTorch、JAX 或 Dask 数组作为数组参数来测试这些功能。 支持以下后端和设备（或其他功能）的组合。

库

CPU

GPU

NumPy

✅

不适用

CuPy

不适用

✅

PyTorch

✅

✅

JAX

✅

✅

Dask

✅

不适用

有关更多信息，请参见 支持数组 API 标准。

示例

>>> import numpy as np
>>> from scipy.special import logsumexp
>>> a = np.arange(10)
>>> logsumexp(a)
9.4586297444267107
>>> np.log(np.sum(np.exp(a)))
9.4586297444267107

带权重

>>> a = np.arange(10)
>>> b = np.arange(10, 0, -1)
>>> logsumexp(a, b=b)
9.9170178533034665
>>> np.log(np.sum(b*np.exp(a)))
9.9170178533034647

返回符号标志

>>> logsumexp([1,2],b=[1,-1],return_sign=True)
(1.5413248546129181, -1.0)

请注意，logsumexp 不直接支持掩码数组。 要在掩码数组上使用它，请将掩码转换为零权重

>>> a = np.ma.array([np.log(2), 2, np.log(3)],
...                  mask=[False, True, False])
>>> b = (~a.mask).astype(int)
>>> logsumexp(a.data, b=b), np.log(5)
1.6094379124341005, 1.6094379124341005
在此页上