{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": "ptp", "annotation": "ndarray or scalar", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The range of a given array - " }, { "__type": "InlineRole", "__tag": 4003, "value": "scalar", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " if array is one-dimensional or a new array holding the result along the given axis" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Range of values (maximum - minimum) along an 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 values." } ] } ] }, { "__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 along which to find the peaks. By default, flatten the array. " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " may be negative, in which case it counts from the last to the first axis. If this is a tuple of ints, a reduction is performed on multiple axes, instead of a single axis or all the axes as before." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "array_like", "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 and buffer length 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": "ptp", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "ptp" }, "kind": "local" }, { "__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." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The name of the function comes from the acronym for 'peak to peak'." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "warning", "base_type": "warning", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "warning " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "ptp", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "ptp" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " preserves the data type of the array. This means the return value for an input of signed integers with n bits (e.g. " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.int8", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:int8" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.int16", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:int16" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", etc) is also a signed integer with n bits. In that case, peak-to-peak values greater than " }, { "__type": "InlineCode", "__tag": 4051, "value": "2**(n-1)-1" }, { "__type": "Text", "__tag": 4046, "value": " will be returned as negative values. An example with a work-around is shown below." } ] } ] } ], "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": 2921, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.ptp" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nx = np.array([[4, 9, 2, 10],\n [6, 9, 7, 12]])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ptp(x, axis=1)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ptp(x, axis=0)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ptp(x)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nThis example shows that a negative value can be returned when\nthe input is an array of signed integers.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "y = np.array([[1, 127],\n [0, 127],\n [-1, 127],\n [-2, 127]], dtype=np.int8)\nnp.ptp(y, axis=1)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nA work-around is to use the `view()` method to view the result as\nunsigned integers with the same bit width:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ptp(y, axis=1).view(np.uint8)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "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": "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": "" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ptp" }, "references": null, "qa": "numpy:ptp", "arbitrary": [], "local_refs": [ "a", "axis", "keepdims", "out", "ptp" ] }