numpy.lib.mixins.NDArrayOperatorsMixin

class numpy.lib.mixins.NDArrayOperatorsMixin [source]

Mixin определяющий все специальные методы операторов с использованием __array_ufunc__.

Этот класс реализует специальные методы для почти всех встроенных операторов Python, определённых в модуле operator, включая сравнения (==, >, и т.д.) и арифметические (+, *, -, и т.д.), делегируя вызов методу __array_ufunc__, который должен быть реализован подклассами.

Этот класс пока не реализует специальные операторы, соответствующие matmul (@), поскольку np.matmul пока не является NumPy ufunc.

Он полезен для написания классов, которые не наследуются от numpy.ndarray, но которые должны поддерживать арифметические операции и универсальные функции NumPy, такие как массивы, как описано в Механизм переопределения Ufunc.

В качестве простого примера рассмотрим это реализацию класса ArrayLike , который просто оборачивает массив NumPy и гарантирует, что результат любой арифметической операции также является объектом ArrayLike.

class ArrayLike(np.lib.mixins.NDArrayOperatorsMixin):
    def __init__(self, value):
        self.value = np.asarray(value)

    # One might also consider adding the built-in list type to this
    # list, to support operations like np.add(array_like, list)
    _HANDLED_TYPES = (np.ndarray, numbers.Number)

    def __array_ufunc__(self, ufunc, method, *inputs, **kwargs):
        out = kwargs.get('out', ())
        for x in inputs + out:
            # Only support operations with instances of _HANDLED_TYPES.
            # Use ArrayLike instead of type(self) for isinstance to
            # allow subclasses that don't override __array_ufunc__ to
            # handle ArrayLike objects.
            if not isinstance(x, self._HANDLED_TYPES + (ArrayLike,)):
                return NotImplemented

        # Defer to the implementation of the ufunc on unwrapped values.
        inputs = tuple(x.value if isinstance(x, ArrayLike) else x
                       for x in inputs)
        if out:
            kwargs['out'] = tuple(
                x.value if isinstance(x, ArrayLike) else x
                for x in out)
        result = getattr(ufunc, method)(*inputs, **kwargs)

        if type(result) is tuple:
            # multiple return values
            return tuple(type(self)(x) for x in result)
        elif method == 'at':
            # no return value
            return None
        else:
            # one return value
            return type(self)(result)

    def __repr__(self):
        return '%s(%r)' % (type(self).__name__, self.value)

При взаимодействии между объектами ArrayLike и числами или массивами NumPy, результат всегда будет другим объектом ArrayLike.

>>> x = ArrayLike([1, 2, 3])
>>> x - 1
ArrayLike(array([0, 1, 2]))
>>> 1 - x
ArrayLike(array([ 0, -1, -2]))
>>> np.arange(3) - x
ArrayLike(array([-1, -1, -1]))
>>> x - np.arange(3)
ArrayLike(array([1, 1, 1]))

Обратите внимание, что в отличие от numpy.ndarray, ArrayLike не разрешает операции с произвольными, нераспознанными типами. Это гарантирует, что взаимодействия с ArrayLike сохраняют хорошо определённую иерархию приведения типов.