ak.prod — Awkward Array documentation

# ak.prod

Defined in awkward.operations.reducers on line 351.

ak.prod(array, axis=None, keepdims=False, mask_identity=False)
  Parameters:

    - array – Data to multiply.

    - axis (None or int) – If None, combine all values from the array into a single scalar result; if an int, group by that axis: `0` is the outermost, `1` is the first level of nested lists, etc., and negative `axis` counts from the innermost: `-1` is the innermost, `-2` is the next level up, etc.

    - keepdims (bool) – If False, this reducer decreases the number of dimensions by 1; if True, the reduced values are wrapped in a new length-1 dimension so that the result of this operation may be broadcasted with the original array.

    - mask_identity (bool) – If True, reducing over empty lists results in None (an option type); otherwise, reducing over empty lists results in the operation’s identity.

Multiplies elements of `array` (many types supported, including all Awkward Arrays and Records). The identity of multiplication is `1` and it is usually not masked. This operation is the same as NumPy’s prod if all lists at a given dimension have the same length and no None values, but it generalizes to cases where they do not.

See `ak.sum` for a more complete description of nested list and missing value (None) handling in reducers.