Ctrl+K

jax.numpy.nancumprod

Contents

jax.numpy.nancumprod#

jax.numpy.nancumprod(a, axis=None, dtype=None, out=None)[source]#

Return the cumulative product of array elements over a given axis treating Not a

LAX-backend implementation of numpy.nancumprod().

Unlike the numpy counterpart, when dtype is not specified the output dtype will always match the dtype of the input.

Original docstring below.

Numbers (NaNs) as one. The cumulative product does not change when NaNs are encountered and leading NaNs are replaced by ones.

Ones are returned for slices that are all-NaN or empty.

Added in version 1.12.0.

Parameters:

  • a (array_like) – Input array.

  • axis (int, optional) – Axis along which the cumulative product is computed. By default the input is flattened.

  • dtype (dtype, optional) – Type of the returned array, as well as of the accumulator in which the elements are multiplied. If dtype is not specified, it defaults to the dtype of a, unless a has an integer dtype with a precision less than that of the default platform integer. In that case, the default platform integer is used instead.

  • out (None)

Returns:

nancumprod – A new array holding the result is returned unless out is specified, in which case it is returned.

Return type:

ndarray

Contents