{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Arithmetic is modular when using integer types, and no error is raised on overflow. That means that, on a 32-bit platform:" } ] }, { "__type": "Code", "__tag": 4050, "value": ">>> x = np.array([536870910, 536870910, 536870910, 536870910])\n>>> np.prod(x)\n16 # may vary", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The product of an empty array is the neutral element 1:" } ] }, { "__type": "Code", "__tag": 4050, "value": ">>> np.prod([])\n1.0", "execution_status": null } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "product_along_axis", "annotation": "ndarray, see `dtype` parameter above.", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array shaped as " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " but with the specified axis removed. Returns a reference to " }, { "__type": "ParamRef", "__tag": 4071, "name": "out" }, { "__type": "Text", "__tag": 4046, "value": " if specified." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return the product of array elements over a given axis." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "a", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "None or int or tuple of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "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." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "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." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "dtype, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The type of the returned array, as well as of the accumulator in which the elements are multiplied. The dtype of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is used by default unless " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " has an integer dtype of less precision than the default platform integer. In that case, if " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is signed then the platform integer is used while if " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is unsigned then an unsigned integer of the same precision as the platform integer is used." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "ndarray, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "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." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "keepdims", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "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." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the default value is passed, then " }, { "__type": "ParamRef", "__tag": 4071, "name": "keepdims" }, { "__type": "Text", "__tag": 4046, "value": " will not be passed through to the " }, { "__type": "CrossRef", "__tag": 4002, "value": "prod", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:prod" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " method of sub-classes of " }, { "__type": "InlineRole", "__tag": 4003, "value": "ndarray", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", however any non-default value will be. If the sub-class' method does not implement " }, { "__type": "ParamRef", "__tag": 4071, "name": "keepdims" }, { "__type": "Text", "__tag": 4046, "value": " any exceptions will be raised." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "initial", "annotation": "scalar, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The starting value for this product. See " }, { "__type": "InlineRole", "__tag": 4003, "value": "~numpy.ufunc.reduce", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for details." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "where", "annotation": "array_like of bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Elements to include in the product. See " }, { "__type": "InlineRole", "__tag": 4003, "value": "~numpy.ufunc.reduce", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for details." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/_core/fromnumeric.py", "item_line": 3287, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.prod" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default, calculate the product of all elements:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.prod([1.,2.])\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nEven when the input array is two-dimensional:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.array([[1., 2.], [3., 4.]])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.prod(a)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nBut we can also specify the axis over which to multiply:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.prod(a, axis=1)\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.prod(a, axis=0)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nOr select specific elements to include:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.prod([1., np.nan, 3.], where=[True, False, True])\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nIf the type of `x` is unsigned, then the output type is\nthe unsigned platform integer:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.array([1, 2, 3], dtype=np.uint8)\nnp.prod(x).dtype == np.uint\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIf `x` is of a signed integer type, then the output type\nis the default platform integer:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.array([1, 2, 3], dtype=np.int8)\nnp.prod(x).dtype == int\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nYou can also start the product with a value other than one:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.prod([1, 2], initial=5)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ndarray.prod", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "ndarray.prod" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "equivalent method" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ufuncs-output-type", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "ufuncs-output-type" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "ref" } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "out", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "keepdims", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "initial", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "where", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "prod" }, "references": null, "qa": "numpy:prod", "arbitrary": [], "local_refs": [ "a", "axis", "dtype", "initial", "keepdims", "out", "product_along_axis", "where" ] }