nums.numpy.any

nums.numpy.any(a, axis=None, out=None, keepdims=False)[source]

Test whether any array element along a given axis evaluates to True.

This docstring was copied from numpy.any.

Some inconsistencies with the NumS version may exist.

Returns single boolean unless axis is not None

Parameters

  • a (BlockArray) – 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 OR reduction is performed. The default (axis=None) is to perform a logical OR over all the dimensions of the input array. axis may be negative, in which case it counts from the last to the first axis. If this is a tuple of ints, a reduction is performed on multiple axes, instead of a single axis or all the axes as before.

  • out (BlockArray, optional) – Alternate output array in which to place the result. It must have the same shape as the expected output and its type is preserved (e.g., if it is of type float, then it will remain so, returning 1.0 for True and 0.0 for False, regardless of the type of a).

  • 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 any method of sub-classes of BlockArray, however any non-default value will be. If the sub-class’ method does not implement keepdims any exceptions will be raised.

Returns

any – A new BlockArray is returned unless out is specified, in which case a reference to out is returned.

Return type

BlockArray

See also

any

equivalent method

all

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

Notes

Not a Number (NaN), positive infinity and negative infinity evaluate to True because these are not equal to zero.

‘out’ is currently not supported

Examples

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

>>> nps.any(nps.array([[True, False], [True, True]])).get()  
array(True)

>>> nps.any(nps.array([[True, False], [False, False]]), axis=0).get()  
array([ True, False])

>>> nps.any(nps.array([-1, 0, 5])).get()  
array(True)

>>> nps.any(nps.array(nps.nan)).get()  
array(True)

previous

nums.numpy.alltrue

next

nums.numpy.average