xorbits.numpy.iterable

xorbits.numpy.iterable(y)

Check whether or not an object can be iterated over.

Parameters

y (object) – Input object.

Returns

b – Return True if the object has an iterator method or is a sequence and False otherwise.

Return type

bool

Examples

>>> np.iterable([1, 2, 3])  
True
>>> np.iterable(2)  
False

Notes

In most cases, the results of np.iterable(obj) are consistent with isinstance(obj, collections.abc.Iterable). One notable exception is the treatment of 0-dimensional arrays:

>>> from collections.abc import Iterable  
>>> a = np.array(1.0)  # 0-dimensional numpy array  
>>> isinstance(a, Iterable)  
True
>>> np.iterable(a)  
False

Warning

This method has not been implemented yet. Xorbits will try to execute it with numpy.

This docstring was copied from numpy.