scipp.max#

scipp.max(x, dim=None, *, out=None)#

Element-wise max over the specified dimension or all dimensions if not provided.

Parameters

  • x (Variable) – Input data.

  • dim (Optional[str], default: None) – Optional dimension along which to calculate the max. If not given, the max over all dimensions is calculated.

  • out (Optional[Variable], default: None) – Optional output buffer.

Raises

If the dimension does not exist, or the dtype cannot be summed, e.g., if it is a string.

Returns

Variable – The max of the input values.

Seealso

scipp.nanmax(), scipp.min().