scipy.special.

logsumexp#

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

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

参数:

aarray_like: 输入数组。
axisNone 或 int 或 ints 元组，可选: 在其上进行求和的轴或多个轴。默认情况下，axis 为 None，并且对所有元素求和。

在 0.11.0 版本中添加。
barray-like，可选: 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\)。

示例

>>> 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