Python numpy mixins.NDArrayOperatorsMixin用法及代码示例

本文简要介绍 python 语言中 numpy.lib.mixins.NDArrayOperatorsMixin 的用法。

用法:

class  numpy.lib.mixins.NDArrayOperatorsMixin

Mixin 使用 __array_ufunc__ 定义所有运算符的特殊方法。

这个类实现了几乎所有在 operator 模块中定义的Python内置运算符的特殊方法，包括比较(==，>等)和算术(+，*，-，等)，通过推迟到子类必须实现的__array_ufunc__方法。

它对于编写不从 numpy.ndarray 继承的类很有用，但应该支持算术和 numpy 通用函数，例如 A Mechanism for Overriding Ufuncs 中说明的数组。

作为一个简单的示例，请考虑 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 的交互保留明确定义的转换层次结构。