jax.numpy.nansum#

jax.numpy.nansum(a, axis=None, dtype=None, out=None, keepdims=False, initial=None, where=None)[源代码]#

返回给定轴上的数组元素之和,忽略 NaN。

JAX 实现的 numpy.nansum()

参数:
  • a (ArrayLike) – 输入数组。

  • axis (Axis) – int 或 int 序列,默认值=None。计算和的轴。如果为 None,则沿扁平化数组计算总和。

  • dtype (DTypeLike | None) – 输出数组的类型。默认值=None。

  • keepdims (bool) – bool,默认值=False。如果为 True,则缩减的轴将保留在结果中,大小为 1。

  • initial (ArrayLike | None) – int 或 array,默认值=None。总和的初始值。

  • where (ArrayLike | None) – 布尔 dtype 数组,默认值=None。用于求和的元素。数组应与输入广播兼容。

  • out (None) – JAX 未使用。

返回值:

一个数组,包含给定轴上数组元素的总和,忽略 NaN。如果给定轴上的所有元素均为 NaN,则返回 0。

返回类型:

Array

参见

示例

默认情况下,jnp.nansum 计算扁平化数组的元素总和。

>>> nan = jnp.nan
>>> x = jnp.array([[3, nan, 4, 5],
...                [nan, -2, nan, 7],
...                [2, 1, 6, nan]])
>>> jnp.nansum(x)
Array(26., dtype=float32)

如果 axis=1,则沿轴 1 计算总和。

>>> jnp.nansum(x, axis=1)
Array([12.,  5.,  9.], dtype=float32)

如果 keepdims=True,则输出的 ndim 将与输入的相同。

>>> jnp.nansum(x, axis=1, keepdims=True)
Array([[12.],
       [ 5.],
       [ 9.]], dtype=float32)

要仅包含特定元素来计算总和,可以使用 where

>>> where=jnp.array([[1, 0, 1, 0],
...                  [0, 0, 1, 1],
...                  [1, 1, 1, 0]], dtype=bool)
>>> jnp.nansum(x, axis=1, keepdims=True, where=where)
Array([[7.],
       [7.],
       [9.]], dtype=float32)

如果 where 在所有元素上均为 False,则 jnp.nansum 沿给定轴返回 0。

>>> where = jnp.array([[False],
...                    [False],
...                    [False]])
>>> jnp.nansum(x, axis=0, keepdims=True, where=where)
Array([[0., 0., 0., 0.]], dtype=float32)