Return the product of array elements over a given axis treating Not a Numbers (NaNs) as ones. One is returned for slices that are all-NaN or empty. .. versionadded:: 1.10.0 Parameters ---------- a : array_like Array containing numbers whose product is desired.
(a, axis=None, dtype=None, out=None, keepdims=np._NoValue,
initial=np._NoValue, where=np._NoValue)
| 731 | |
| 732 | @array_function_dispatch(_nanprod_dispatcher) |
| 733 | def nanprod(a, axis=None, dtype=None, out=None, keepdims=np._NoValue, |
| 734 | initial=np._NoValue, where=np._NoValue): |
| 735 | """ |
| 736 | Return the product of array elements over a given axis treating Not a |
| 737 | Numbers (NaNs) as ones. |
| 738 | |
| 739 | One is returned for slices that are all-NaN or empty. |
| 740 | |
| 741 | .. versionadded:: 1.10.0 |
| 742 | |
| 743 | Parameters |
| 744 | ---------- |
| 745 | a : array_like |
| 746 | Array containing numbers whose product is desired. If `a` is not an |
| 747 | array, a conversion is attempted. |
| 748 | axis : {int, tuple of int, None}, optional |
| 749 | Axis or axes along which the product is computed. The default is to compute |
| 750 | the product of the flattened array. |
| 751 | dtype : data-type, optional |
| 752 | The type of the returned array and of the accumulator in which the |
| 753 | elements are summed. By default, the dtype of `a` is used. An |
| 754 | exception is when `a` has an integer type with less precision than |
| 755 | the platform (u)intp. In that case, the default will be either |
| 756 | (u)int32 or (u)int64 depending on whether the platform is 32 or 64 |
| 757 | bits. For inexact inputs, dtype must be inexact. |
| 758 | out : ndarray, optional |
| 759 | Alternate output array in which to place the result. The default |
| 760 | is ``None``. If provided, it must have the same shape as the |
| 761 | expected output, but the type will be cast if necessary. See |
| 762 | :ref:`ufuncs-output-type` for more details. The casting of NaN to integer |
| 763 | can yield unexpected results. |
| 764 | keepdims : bool, optional |
| 765 | If True, the axes which are reduced are left in the result as |
| 766 | dimensions with size one. With this option, the result will |
| 767 | broadcast correctly against the original `arr`. |
| 768 | initial : scalar, optional |
| 769 | The starting value for this product. See `~numpy.ufunc.reduce` |
| 770 | for details. |
| 771 | |
| 772 | .. versionadded:: 1.22.0 |
| 773 | where : array_like of bool, optional |
| 774 | Elements to include in the product. See `~numpy.ufunc.reduce` |
| 775 | for details. |
| 776 | |
| 777 | .. versionadded:: 1.22.0 |
| 778 | |
| 779 | Returns |
| 780 | ------- |
| 781 | nanprod : ndarray |
| 782 | A new array holding the result is returned unless `out` is |
| 783 | specified, in which case it is returned. |
| 784 | |
| 785 | See Also |
| 786 | -------- |
| 787 | numpy.prod : Product across array propagating NaNs. |
| 788 | isnan : Show which elements are NaN. |
| 789 | |
| 790 | Examples |
nothing calls this directly
no test coverage detected