numpy.isin

numpy.isin(element, test_elements, assume_unique=False, invert=False, *, kind=None)[source]

Вычисляет element in test_elements, транслируя по element только. Возвращает булеву массив того же размера, что и element, который равен True, где элемент element присутствует в test_elements, и False в противном случае.

Параметры:

elementarray_like

Входной массив.

test_elementsarray_like

Значения, с которыми нужно сравнить каждый элемент element. Этот аргумент сплющивается, если это массив или array_like. См. примечания для поведения с не-array-like параметрами.

assume_uniquebool, optional

Если True, предполагается, что входные массивы уникальны, что может ускорить вычисление. По умолчанию False.

invertbool, optional

Если True, значения в возвращаемом массиве инвертируются, как если бы вычислялось element not in test_elements. По умолчанию False. np.isin(a, b, invert=True) эквивалентно (но быстрее), чем np.invert(np.isin(a, b)).

kind{None, ‘sort’, ‘table’}, optional

Алгоритм, который необходимо использовать. Это не повлияет на конечный результат, но повлияет на скорость и использование памяти. По умолчанию None, автоматически выбирается на основе соображений памяти.

• Если ‘sort’, используется подход, основанный на сортировке слиянием. Это потребует памяти примерно в 6 раз больше суммы размеров element и test_elements, не учитывая размер типов данных.
• Если ‘table’, используется подход, похожий на сортировку подсчётом, основанный на таблице поиска. Доступен только для булевых и целочисленных массивов. Это потребует памяти, равной размеру element плюс разнице между максимальным и минимальным значением test_elements. assume_unique не имеет эффекта, когда используется опция ‘table’.
• Если None, автоматически выбирается ‘table’, если требуемое выделение памяти меньше или равно 6-кратной сумме размеров element и test_elements, в противном случае используется ‘sort’. Это сделано для того, чтобы по умолчанию не использовать большое количество памяти, даже если ‘table’ может быть быстрее в большинстве случаев. Если выбран ‘table’, assume_unique не повлияет.

Возвращает:

isinndarray, bool

Имеет такую же форму, что и element. Значения element[isin] находятся в test_elements.

Примечания

isin - это поэлементная функция, версия ключевого слова python in. isin(a, b) примерно эквивалентно np.array([item in b for item in a]), если a и b являются одномерными последовательностями.

element и test_elements преобразуются в массивы, если они еще не являются таковыми. Если test_elements является множеством (или другой коллекцией, не являющейся последовательностью), оно будет преобразовано в массив объектов с одним элементом, а не в массив значений, содержащихся в test_elements. Это следствие способа обработки конструктором array коллекций, не являющихся последовательностями. Преобразование множества в список обычно дает желаемое поведение.

Использование kind='table' имеет тенденцию быть быстрее, чем kind=’sort’, если верно следующее соотношение: log10(len(test_elements)) > (log10(max(test_elements)-min(test_elements)) - 2.27) / 0.927, но может использовать больше памяти. Значение по умолчанию для kind будет автоматически выбрано только на основе использования памяти, поэтому можно вручную установить kind='table', если можно расширить ограничения памяти.

New in version 1.13.0.

Примеры

>>> element = 2*np.arange(4).reshape((2, 2))
>>> element
array([[0, 2],
       [4, 6]])
>>> test_elements = [1, 2, 4, 8]
>>> mask = np.isin(element, test_elements)
>>> mask
array([[False,  True],
       [ True, False]])
>>> element[mask]
array([2, 4])

Индексы совпадающих значений можно получить с помощью nonzero:

>>> np.nonzero(mask)
(array([0, 1]), array([1, 0]))

Тест также можно инвертировать:

>>> mask = np.isin(element, test_elements, invert=True)
>>> mask
array([[ True, False],
       [False,  True]])
>>> element[mask]
array([0, 6])

Из-за того, как array обрабатывает множества, следующее не работает как ожидается:

>>> test_set = {1, 2, 4, 8}
>>> np.isin(element, test_set)
array([[False, False],
       [False, False]])

Преобразование множества в список дает ожидаемый результат:

>>> np.isin(element, list(test_set))
array([[False,  True],
       [ True, False]])