`heat.array_api._utility_functions`

Module Contents

all(x: heat.array_api._array_object.Array, /, *, axis: int | Tuple[int, Ellipsis] | None = None, keepdims: bool = False) → heat.array_api._array_object.Array[source]

Tests whether all input array elements evaluate to True along a specified axis.

Parameters:

x (Array) – Input array.
axis (Optional[Union[int, Tuple[int, ...]]]) – Axis or axes along which to perform a logical AND reduction. By default, a logical AND reduction is performed over the entire array.
keepdims (bool) – If True, the reduced axes (dimensions) are included in the result as singleton dimensions. Otherwise, if False, the reduced axes (dimensions) are be included in the result. Default: False.

any(x: heat.array_api._array_object.Array, /, *, axis: int | Tuple[int, Ellipsis] | None = None, keepdims: bool = False) → heat.array_api._array_object.Array[source]

Tests whether any input array element evaluates to True along a specified axis.

Parameters:

x (Array) – Input array.
axis (Optional[Union[int, Tuple[int, ...]]]) – Axis or axes along which to perform a logical OR reduction. By default, a logical OR reduction is performed over the entire array.
keepdims (bool) – If True, the reduced axes (dimensions) are included in the result as singleton dimensions. Otherwise, if False, the reduced axes (dimensions) are be included in the result. Default: False.