Return the maximum of an array or maximum along an axis, ignoring any NaNs. When all-NaN slices are encountered a ``RuntimeWarning`` is raised and NaN is returned for that slice. Parameters ---------- a : array_like Array containing numbers whose maximum is desired
(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue,
where=np._NoValue)
| 368 | |
| 369 | @array_function_dispatch(_nanmax_dispatcher) |
| 370 | def nanmax(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue, |
| 371 | where=np._NoValue): |
| 372 | """ |
| 373 | Return the maximum of an array or maximum along an axis, ignoring any |
| 374 | NaNs. When all-NaN slices are encountered a ``RuntimeWarning`` is |
| 375 | raised and NaN is returned for that slice. |
| 376 | |
| 377 | Parameters |
| 378 | ---------- |
| 379 | a : array_like |
| 380 | Array containing numbers whose maximum is desired. If `a` is not an |
| 381 | array, a conversion is attempted. |
| 382 | axis : {int, tuple of int, None}, optional |
| 383 | Axis or axes along which the maximum is computed. The default is to compute |
| 384 | the maximum of the flattened array. |
| 385 | out : ndarray, optional |
| 386 | Alternate output array in which to place the result. The default |
| 387 | is ``None``; if provided, it must have the same shape as the |
| 388 | expected output, but the type will be cast if necessary. See |
| 389 | :ref:`ufuncs-output-type` for more details. |
| 390 | |
| 391 | .. versionadded:: 1.8.0 |
| 392 | keepdims : bool, optional |
| 393 | If this is set to True, the axes which are reduced are left |
| 394 | in the result as dimensions with size one. With this option, |
| 395 | the result will broadcast correctly against the original `a`. |
| 396 | |
| 397 | If the value is anything but the default, then |
| 398 | `keepdims` will be passed through to the `max` method |
| 399 | of sub-classes of `ndarray`. If the sub-classes methods |
| 400 | does not implement `keepdims` any exceptions will be raised. |
| 401 | |
| 402 | .. versionadded:: 1.8.0 |
| 403 | initial : scalar, optional |
| 404 | The minimum value of an output element. Must be present to allow |
| 405 | computation on empty slice. See `~numpy.ufunc.reduce` for details. |
| 406 | |
| 407 | .. versionadded:: 1.22.0 |
| 408 | where : array_like of bool, optional |
| 409 | Elements to compare for the maximum. See `~numpy.ufunc.reduce` |
| 410 | for details. |
| 411 | |
| 412 | .. versionadded:: 1.22.0 |
| 413 | |
| 414 | Returns |
| 415 | ------- |
| 416 | nanmax : ndarray |
| 417 | An array with the same shape as `a`, with the specified axis removed. |
| 418 | If `a` is a 0-d array, or if axis is None, an ndarray scalar is |
| 419 | returned. The same dtype as `a` is returned. |
| 420 | |
| 421 | See Also |
| 422 | -------- |
| 423 | nanmin : |
| 424 | The minimum value of an array along a given axis, ignoring any NaNs. |
| 425 | amax : |
| 426 | The maximum value of an array along a given axis, propagating any NaNs. |
| 427 | fmax : |