nlcpy.prod

nlcpy.prod(a, axis=None, dtype=None, out=None, keepdims=False, initial=nlcpy._NoValue, where=True)

Returns the product of array elements over a given axis.

Parameters

aarray_like: Input data.
axisNone or int or tuple of ints, optional: Axis or axes along which a product is performed. The default, axis = None, will calculate the product of all the elements in the input array. If axis is negative it counts from the last to the first axis. If axis is a tuple of ints, a product is performed on all of the axes specified in the tuple instead of a single axis or all the axes as before.
dtypedtype, optional: The type of the returned array, as well as of the accumulator in which the elements are multiplied. The dtype of a is used by default unless a has an integer dtype of less precision than the default platform integer. In that case, if a is signed then the platform integer is used while if a is unsigned then an unsigned integer of the same precision as the platform integer is used.
outndarray, optional: Alternative output array in which to place the result. It must have the same shape as the expected output, but the type of the output values will be cast if necessary.
keepdimsbool, optional: If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array. If the default value is passed, then keepdims will not be passed through to the prod method of sub-classes of nlcpy.ndarray(), however any non-default value will be. If the sub-class’ method does not implement keepdims any exceptions will be raised.
initialscalar, optional: The starting value for this product. See nlcpy.ufunc.reduce() for details.
wherearray_like of bool, optional: Elements to include in the product. See nlcpy.ufunc.reduce() for details.

Returns

product_along_axisndarray, see dtype parameter above.: An array shaped as a but with the specified axis removed. If axis is None or a is a scalar value, this function returns the result as a 0-dimention array. Returns a reference to out if specified.

See also

nlcpy.ndarray.prod: Equivalent method.

Note

Arithmetic is modular when using integer types, and no error is raised on overflow:

>>> import nlcpy as vp
>>> x = vp.array([536870910, 536870910, 536870910, 536870910])
>>> vp.prod(x)
array(6917529010461212688)

The product of an empty array is the neutral element 1:

>>> vp.prod([])
array(1.)

Restriction

If an ndarray is passed to where and where.shape != a.shape, NotImplementedError occurs.
If an ndarray is passed to out and out.shape != product_along_axis.shape, NotImplementedError occurs.

Examples

By default, calculate the product of all elements:

>>> import nlcpy as vp
>>> vp.prod([1.,2.])
array(2.)

Even when the input array is two-dimensional:

>>> vp.prod([[1.,2.],[3.,4.]])
array(24.)

But we can also specify the axis over which to multiply:

>>> vp.prod([[1.,2.],[3.,4.]], axis=1)
array([ 2., 12.])

Or select specific elements to include:

>>> vp.prod([1., vp.nan, 3.], where=[True, False, True])
array(3.)

If the type of x is unsigned, then the output type is the unsigned platform integer:

>>> x = vp.array([1, 2, 3], dtype=vp.uint32)
>>> vp.prod(x).dtype == vp.uint
True

If x is of a signed integer type, then the output type is the default platform integer:

>>> x = vp.array([1, 2, 3], dtype=vp.int32)
>>> vp.prod(x).dtype == int
True

You can also start the product with a value other than one:

>>> vp.prod([1, 2], initial=5)
array(10)