reservoirflow.utils.helpers.isin#

reservoirflow.utils.helpers.isin(x: tuple, in_data)#

Check if x in or not.

This function checks if x is in data. If x itself is a python iterable or array (e.g. coords), x will be converted to a tuple to allow for the check.

Parameters:

x (int, tuple, list, tuple, np.ndarray) – int (e.g. id) or list-like (e.g. coords) of len 3.
data (list, set, tuple, np.ndarray) – list-like of int or tuples of len 3.

Returns:

True is x in data, otherwise False

Return type:

Boolean