{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "NaN values are propagated, that is if at least one item is NaN, the corresponding max value will be NaN as well. To ignore NaN values (MATLAB behavior), please use nanmax." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Don't use " }, { "__type": "CrossRef", "__tag": 4002, "value": "max", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:max" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for element-wise comparison of 2 arrays; when " }, { "__type": "InlineCode", "__tag": 4051, "value": "a.shape[0]" }, { "__type": "Text", "__tag": 4046, "value": " is 2, " }, { "__type": "InlineCode", "__tag": 4051, "value": "maximum(a[0], a[1])" }, { "__type": "Text", "__tag": 4046, "value": " is faster than " }, { "__type": "InlineCode", "__tag": 4051, "value": "max(a, axis=0)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": "max", "annotation": "ndarray or scalar", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " is None, the result is a scalar value. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " is an int, the result is an array of dimension " }, { "__type": "InlineCode", "__tag": 4051, "value": "a.ndim - 1" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " is a tuple, the result is an array of dimension " }, { "__type": "InlineCode", "__tag": 4051, "value": "a.ndim - len(axis)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return the maximum of an array or maximum 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 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 to operate. By default, flattened input is used. If this is a tuple of ints, the maximum is selected over multiple axes, instead of a single axis or all the axes as before." } ] } ] }, { "__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. Must be of the same shape and buffer length as the expected output. See " }, { "__type": "InlineRole", "__tag": 4003, "value": "ufuncs-output-type", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more details." } ] } ] }, { "__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": "InlineCode", "__tag": 4051, "value": "max" }, { "__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 minimum value of an output element. Must be present to allow computation on empty slice. 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 compare for the maximum. 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": "/numpy/_core/fromnumeric.py", "item_line": 3011, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.max" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\na = np.arange(4).reshape((2,2))\na\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.max(a) # Maximum of the flattened array\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.max(a, axis=0) # Maxima along the first axis\nnp.max(a, axis=1) # Maxima along the second axis\nnp.max(a, where=[False, True], initial=-1, axis=0)\nb = np.arange(5, dtype=float)\nb[2] = np.nan\nnp.max(b)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.max(b, where=~np.isnan(b), initial=-1)\nnp.nanmax(b)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nYou can use an initial value to compute the maximum of an empty slice, or\nto initialize it to a different value:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.max([[-50], [10]], axis=-1, initial=0)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nNotice that the initial value is used as one of the elements for which the\nmaximum is determined, unlike for the default argument Python's max\nfunction, which is only used for empty iterables.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.max([5], initial=6)\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "max([5], default=6)\n", "execution_status": "unexpected_exception" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "amin", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "amin" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The minimum value of an array along a given axis, propagating any NaNs." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "argmax", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "argmax" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return the indices of the maximum values." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "fmax", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "fmax" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Element-wise maximum of two arrays, ignoring any NaNs." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "fmin", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "fmin" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "maximum", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "maximum" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Element-wise maximum of two arrays, propagating any NaNs." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "minimum", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "minimum" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "nanmax", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "nanmax" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The maximum value of an array along a given axis, ignoring any NaNs." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "nanmin", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "nanmin" }, "kind": "module" }, "descriptions": [], "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": "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": "max" }, "references": null, "qa": "numpy:max", "arbitrary": [], "local_refs": [ "a", "axis", "initial", "keepdims", "max", "out", "where" ] }