Implement a forward binary method with a ufunc, e.g., __add__.c H t | rt S | | S Nr
NotImplementedselfotherufuncs r funcz _binary_method..func s+ ' ' "! !uT5!!! __{}__format__name__r namer s ` r _binary_methodr s6 " " " " " OOD))DM Kr c F fd}d | |_ |S )zAImplement a reflected binary method with a ufunc, e.g., __radd__.c H t | rt S || S r
r r s r r z&_reflected_binary_method..func s+ ' ' "! !uUD!!!r z__r{}__r r s ` r _reflected_binary_methodr s8 " " " " " $$T**DM Kr c F fd}d | |_ |S )zAImplement an in-place binary method with a ufunc, e.g., __iadd__.c " | || f S )N)out r s r r z$_inplace_binary_method..func& s uT5tg....r z__i{}__r r s ` r _inplace_binary_methodr$ $ s6 / / / / / $$T**DM Kr c ` t | | t | | t | | fS )zEImplement forward, reflected and inplace binary methods with a ufunc.)r r r$ )r r s r _numeric_methodsr& , s3 5$ ' ' $UD 1 1 "5$ / / 1 1r c F fd}d | |_ |S )z.Implement a unary special method with a ufunc.c | S r
r# )r r s r r z_unary_method..func5 s uT{{r r r r s ` r
_unary_methodr) 3 s4 OOD))DM Kr c e Zd ZdZdZ eej d Z eej d Z
eej d Z eej
d Z eej d Z eej d Z eej d \ ZZZ eej d
\ ZZZ eej d \ Z Z Z eej d \ Z!Z"Z# eej$ d
\ Z%Z&Z' eej( d \ Z)Z*Z+ eej, d \ Z-Z.Z/ eej0 d Z1 e2ej0 d Z3 eej4 d \ Z5Z6Z7 eej8 d \ Z9Z:Z; eej< d \ Z=Z>Z? eej@ d \ ZAZBZC eejD d \ ZEZFZG eejH d \ ZIZJZK eLejM d ZN eLejO d ZP eLejQ d ZR eLejS d ZTdS ) r a
Mixin defining all operator special methods using __array_ufunc__.
This class implements the special methods for almost all of Python's
builtin operators defined in the `operator` module, including comparisons
(``==``, ``>``, etc.) and arithmetic (``+``, ``*``, ``-``, etc.), by
deferring to the ``__array_ufunc__`` method, which subclasses must
implement.
It is useful for writing classes that do not inherit from `numpy.ndarray`,
but that should support arithmetic and numpy universal functions like
arrays as described in `A Mechanism for Overriding Ufuncs
`_.
As an trivial example, consider this implementation of an ``ArrayLike``
class that simply wraps a NumPy array and ensures that the result of any
arithmetic operation is also an ``ArrayLike`` object::
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)
In interactions between ``ArrayLike`` objects and numbers or numpy arrays,
the result is always another ``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]))
Note that unlike ``numpy.ndarray``, ``ArrayLike`` does not allow operations
with arbitrary, unrecognized types. This ensures that interactions with
ArrayLike preserve a well-defined casting hierarchy.
.. versionadded:: 1.13
r# ltleeqnegtgeaddsubmulmatmultruedivfloordivmoddivmodpowlshiftrshiftandxorornegposabsinvertN)Ur
__module__ __qualname____doc__ __slots__r umless__lt__
less_equal__le__equal__eq__ not_equal__ne__greater__gt__
greater_equal__ge__r& r1 __add____radd____iadd__subtract__sub____rsub____isub__multiply__mul____rmul____imul__r4
__matmul__ __rmatmul__ __imatmul__ true_divide __truediv__ __rtruediv__ __itruediv__ floor_divide __floordiv__
__rfloordiv__
__ifloordiv__ remainder__mod____rmod____imod__r8
__divmod__r __rdivmod__power__pow____rpow____ipow__
left_shift
__lshift__ __rlshift__ __ilshift__ right_shift
__rshift__ __rrshift__ __irshift__ bitwise_and__and____rand____iand__ bitwise_xor__xor____rxor____ixor__
bitwise_or__or____ror____ior__r) negative__neg__positive__pos__absolute__abs__rB
__invert__r# r r r r ; s K KX I
^BGT
*
*F
^BM4
0
0F
^BHd
+
+F
^BL$
/
/F
^BJ
-
-F
^B ,d
3
3F #3"2265"A"A GXx"2"22;"F"F GXx"2"22;"F"F GXx+;+;
8, , (J [ /?.>
/# /#+K |1A1A
2% 2%.L- "2"22<"G"G GXx 844J**29h??K #3"228U"C"C GXx+;+;
x,! ,!(J [+;+;
," ,"(J ["2"22>5"I"I GXx"2"22>5"I"I GXx / /
t D D FGW mBK//GmBK//GmBK//G ry(33JJJr N) rE
numpy.corer rG __all__r
r r r$ r& r) r r# r r r s K K " " " " " " #
# 1 1 1 v4 v4 v4 v4 v4 v4 v4 v4 v4 v4r