ak.where#

Defined in awkward.operations.ak_where on line 11.

ak.where(condition, *args, mergebool=True, highlevel=True, behavior=None)#
Parameters
  • condition – Array-like data (anything ak.to_layout recognizes) of booleans.

  • x – Optional array-like data (anything ak.to_layout recognizes) with the same length as condition.

  • y – Optional array-like data (anything ak.to_layout recognizes) with the same length as condition.

  • mergebool (bool, default is True) – If True, boolean and numeric data can be combined into the same buffer, losing information about False vs 0 and True vs 1; otherwise, they are kept in separate buffers with distinct types (using an ak.contents.UnionArray).

  • highlevel (bool, default is True) – If True, return an ak.Array; otherwise, return a low-level ak.contents.Content subclass.

  • behavior (None or dict) – Custom ak.behavior for the output array, if high-level.

This function has a one-argument form, condition without x or y, and a three-argument form, condition, x, and y. In the one-argument form, it is completely equivalent to NumPy’s nonzero function.

In the three-argument form, it acts as a vectorized ternary operator: condition, x, and y must all have the same length and

output[i] = x[i] if condition[i] else y[i]

for all i. The structure of x and y do not need to be the same; if they are incompatible types, the output will have ak.type.UnionType.