jax.numpy.alltrue

jax.numpy.alltrue(a, axis=None, out=None, keepdims=None, *, where=None)

Test whether all array elements along a given axis evaluate to True.

LAX-backend implementation of all().

Original docstring below.

Parameters
  • a (array_like) – Input array or object that can be converted to an array.

  • axis (None or int or tuple of ints, optional) – Axis or axes along which a logical AND reduction is performed. The default (axis=None) is to perform a logical AND over all the dimensions of the input array. axis may be negative, in which case it counts from the last to the first axis.

  • keepdims (bool, optional) –

    If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.

    If the default value is passed, then keepdims will not be passed through to the all method of sub-classes of ndarray, however any non-default value will be. If the sub-class’ method does not implement keepdims any exceptions will be raised.

Returns

all – A new boolean or array is returned unless out is specified, in which case a reference to out is returned.

Return type

ndarray, bool