where

where(condition: array, x1: array | int | float | complex | bool, x2: array | int | float | complex | bool, /) → array

Returns elements chosen from x1 or x2 depending on condition.

Parameters:

  • condition (array) – when True, yield x1_i; otherwise, yield x2_i. Should have a boolean data type. Must be broadcast-compatible with x1 and x2 (see Broadcasting).

  • x1 (Union[array, int, float, complex, bool]) – first input array. Must be broadcast-compatible with condition and x2 (see Broadcasting).

  • x2 (Union[array, int, float, complex, bool]) – second input array. Must be broadcast-compatible with condition and x1 (see Broadcasting).

Returns:

out (array) – an array with elements from x1 where condition is True, and elements from x2 elsewhere. The returned array must have a data type determined by Type Promotion Rules rules with the arrays x1 and x2.

Notes

  • At least one of x1 and x2 must be an array.

  • If either x1 or x2 is a scalar value, the returned array must have a data type determined according to Mixing arrays with Python scalars.

Changed in version 2024.12: Added scalar argument support.

Changed in version 2024.12: Clarified that the condition argument should have a boolean data type.