nansum

array_api_extra.nansum(a, /, *, axis=None, xp=None)

Return the sum of the array elements along a given axis, ignoring NaNs.

Parameters:

  • a (object) – Input array.

  • axis (int | tuple[int, ...] | None) – Axis or axes along which the sum is computed. The default is to compute the sum of the flattened array.

  • xp (ModuleType | None) – The standard-compatible namespace for a. Default: infer.

Returns:

An array of sum values along the given axis, ignoring NaNs.

Return type:

object

Examples

>>> import array_api_extra as xpx
>>> import array_api_strict as xp
>>> a = xp.asarray([[5, 3, xp.nan, 1], [4, xp.nan, 2, xp.nan]])
>>> xpx.nansum(a)
Array(15., dtype=array_api_strict.float64)
>>> xpx.nansum(a, axis=0)
Array([9., 3., 2., 1.], dtype=array_api_strict.float64)
>>> xpx.nansum(a, axis=1)
Array([9., 6.], dtype=array_api_strict.float64)