reorganized npfuncs.py and ufuncs.py

Author: alixdamman

larray/__init__.py

@@ -12,14 +12,14 @@
 from larray.core.session import Session, local_arrays, global_arrays, arrays
 from larray.core.constants import nan, inf, pi, e, euler_gamma
 from larray.core.metadata import Metadata
-from larray.core.npfuncs import (where, clip, degrees, radians, unwrap, angle, real, imag,
-                                 round, around, round_, fix, i0, sinc, convolve, nan_to_num,
-                                 real_if_close, inverse, interp, )
+from larray.core.npfuncs import (round, around, round_, where, inverse, i0, sinc, clip,
+                                 angle, real, imag, convolve, nan_to_num, real_if_close, interp)
 from larray.core.ufuncs import (sin, cos, tan, arcsin, arccos, arctan, hypot, arctan2, sinh, cosh,
                                 tanh, arcsinh, arccosh, arctanh, conj, rint, floor, ceil, trunc,
                                 exp, expm1, exp2, log, log10, log2, log1p, logaddexp, logaddexp2,
                                 signbit, copysign, frexp, ldexp, sqrt, absolute, fabs, sign,
-                                fmax, fmin, isnan, isinf, maximum, minimum)
+                                fmax, fmin, isnan, isinf, maximum, minimum, degrees, radians,
+                                unwrap, fix)
 
 from larray.inout.misc import from_lists, from_string
 from larray.inout.pandas import from_frame, from_series
@@ -58,14 +58,13 @@
     'maximum', 'minimum',
     'sin', 'cos', 'tan', 'arcsin', 'arccos', 'arctan', 'hypot', 'arctan2', 'degrees', 'radians',
     'unwrap', 'sinh', 'cosh', 'tanh', 'arcsinh', 'arccosh', 'arctanh',
-    'angle', 'real', 'imag', 'conj',
-    'round', 'around', 'round_', 'rint', 'fix', 'floor', 'ceil', 'trunc',
-    'exp', 'expm1', 'exp2', 'log', 'log10', 'log2', 'log1p', 'logaddexp', 'logaddexp2',
-    'i0', 'sinc', 'signbit', 'copysign', 'frexp', 'ldexp',
-    'convolve', 'sqrt', 'absolute', 'fabs', 'sign', 'fmax', 'fmin', 'nan_to_num',
-    'real_if_close', 'interp', 'isnan', 'isinf', 'inverse',
+    'conj', 'rint', 'fix', 'floor', 'ceil', 'trunc', 'exp', 'expm1', 'exp2',
+    'log', 'log10', 'log2', 'log1p', 'logaddexp', 'logaddexp2',
+    'signbit', 'copysign', 'frexp', 'ldexp', 'sqrt', 'absolute', 'fabs',
+    'sign', 'fmax', 'fmin', 'isnan', 'isinf',
     # npfuncs
-    'where', 'clip',
+    'round', 'around', 'round_', 'where', 'inverse', 'i0', 'sinc', 'angle', 'real', 'imag',
+    'convolve', 'nan_to_num', 'real_if_close', 'interp', 'clip',
     # inout
     'from_lists', 'from_string', 'from_frame', 'from_series', 'read_csv', 'read_tsv',
     'read_eurostat', 'read_excel', 'read_hdf', 'read_sas', 'open_excel', 'Workbook',

larray/core/npfuncs.py

@@ -1,5 +1,4 @@
-# numpy ufuncs -- this module is excluded from pytest
-# http://docs.scipy.org/doc/numpy/reference/routines.math.html
+# numpy funcs which are not ufuncs -- this module is excluded from pytest
 
 import numpy as np
 
@@ -14,25 +13,13 @@ def wrapper(*args, **kwargs):
         _copy_npfunc_doc(wrapper, npfunc)
     return wrapper
 
-# Trigonometric functions
-
-degrees = broadcastify(np.degrees)
-radians = broadcastify(np.radians)
-unwrap = broadcastify(np.unwrap)
-
-# Handling complex numbers
-
-angle = broadcastify(np.angle)
-real = broadcastify(np.real)
-imag = broadcastify(np.imag)
 
 # Rounding
 
 # all 3 are equivalent, I am unsure I should support around and round_
-round = broadcastify(np.round)
 around = broadcastify(np.around)
 round_ = broadcastify(np.round_)
-fix = broadcastify(np.fix)
+round = broadcastify(np.round)
 
 # Sums, products, differences
 
@@ -50,14 +37,22 @@ def wrapper(*args, **kwargs):
 # cross = broadcastify(np.cross)
 # trapz = broadcastify(np.trapz)
 
-
 # Other special functions
 
 i0 = broadcastify(np.i0)
 sinc = broadcastify(np.sinc)
 
+# Handling complex numbers
+
+angle = broadcastify(np.angle)
+real = broadcastify(np.real)
+imag = broadcastify(np.imag)
+
 # Miscellaneous
 
+# put clip here even it is a ufunc because it ends up within a recursion loop with LArray.clip
+clip = broadcastify(np.clip)
+
 where = broadcastify(np.where, copy_doc=False)
 where.__doc__ = r"""
     Return elements, either from `x` or `y`, depending on `condition`.
@@ -116,10 +111,9 @@ def wrapper(*args, **kwargs):
      a3   9.0  10.0   5.0  7.75
 """
 
-clip = broadcastify(np.clip)
-convolve = broadcastify(np.convolve)
 nan_to_num = broadcastify(np.nan_to_num)
 real_if_close = broadcastify(np.real_if_close)
+convolve = broadcastify(np.convolve)
 inverse = broadcastify(np.linalg.inv)
 
 # XXX: create a new LArray method instead ?

larray/core/ufuncs.py

@@ -1,5 +1,6 @@
-# numpy ufuncs
+# numpy ufuncs -- this module is excluded from pytest
 # http://docs.scipy.org/doc/numpy/reference/routines.math.html
+# https://docs.scipy.org/doc/numpy/reference/ufuncs.html#available-ufuncs
 
 import numbers
 
@@ -114,22 +115,6 @@ def wrapper(*args, **kwargs):
 # list of available Numpy ufuncs
 # https://docs.scipy.org/doc/numpy/reference/ufuncs.html#available-ufuncs
 
-# Arithmetic operations
-
-# add = make_ufunc_shortcut(np.add)
-# reciprocal = make_ufunc_shortcut(np.reciprocal)
-# negative = make_ufunc_shortcut(np.negative)
-# multiply = make_ufunc_shortcut(np.multiply)
-# divide = make_ufunc_shortcut(np.divide)
-# power = make_ufunc_shortcut(np.power)
-# subtract = make_ufunc_shortcut(np.subtract)
-# true_divide = make_ufunc_shortcut(np.true_divide)
-# floor_divide = make_ufunc_shortcut(np.floor_divide)
-# fmod = make_ufunc_shortcut(np.fmod)
-# mod = make_ufunc_shortcut(np.mod)
-# remainder = make_ufunc_shortcut(np.remainder)
-# square = make_ufunc_shortcut(np.square)
-
 # Trigonometric functions
 
 sin = make_ufunc_shortcut(np.sin)
@@ -140,6 +125,9 @@ def wrapper(*args, **kwargs):
 arctan = make_ufunc_shortcut(np.arctan)
 arctan2 = make_ufunc_shortcut(np.arctan2)
 hypot = make_ufunc_shortcut(np.hypot)
+degrees = make_ufunc_shortcut(np.degrees)
+radians = make_ufunc_shortcut(np.radians)
+unwrap = make_ufunc_shortcut(np.unwrap)
 # deg2rad = make_ufunc_shortcut(np.deg2rad)
 # rad2deg = make_ufunc_shortcut(np.rad2deg)
 
@@ -155,20 +143,12 @@ def wrapper(*args, **kwargs):
 # Rounding
 
 rint = make_ufunc_shortcut(np.rint)
-
-# Floating functions
-
-isnan = make_ufunc_shortcut(np.isnan)
-isinf = make_ufunc_shortcut(np.isinf)
-signbit = make_ufunc_shortcut(np.signbit)
-copysign = make_ufunc_shortcut(np.copysign)
-ldexp = make_ufunc_shortcut(np.ldexp)
-frexp = make_ufunc_shortcut(np.frexp)
+# TODO: fix fails because of its 'out' argument
+fix = make_ufunc_shortcut(np.fix)
 # TODO: add examples for round, floor, ceil and trunc
 floor = make_ufunc_shortcut(np.floor)
 ceil = make_ufunc_shortcut(np.ceil)
 trunc = make_ufunc_shortcut(np.trunc)
-# modf = make_ufunc_shortcut(np.modf)
 
 # Exponents and logarithms
 
@@ -183,18 +163,43 @@ def wrapper(*args, **kwargs):
 logaddexp = make_ufunc_shortcut(np.logaddexp)
 logaddexp2 = make_ufunc_shortcut(np.logaddexp2)
 
+# Floating functions
+
+signbit = make_ufunc_shortcut(np.signbit)
+copysign = make_ufunc_shortcut(np.copysign)
+# TODO: understand why frexp fails
+frexp = make_ufunc_shortcut(np.frexp)
+ldexp = make_ufunc_shortcut(np.ldexp)
+
+# Arithmetic operations
+
+# add = make_ufunc_shortcut(np.add)
+# reciprocal = make_ufunc_shortcut(np.reciprocal)
+# positive = make_ufunc_shortcut(np.positive)
+# negative = make_ufunc_shortcut(np.negative)
+# multiply = make_ufunc_shortcut(np.multiply)
+# divide = make_ufunc_shortcut(np.divide)
+# power = make_ufunc_shortcut(np.power)
+# subtract = make_ufunc_shortcut(np.subtract)
+# true_divide = make_ufunc_shortcut(np.true_divide)
+# floor_divide = make_ufunc_shortcut(np.floor_divide)
+# fmod = make_ufunc_shortcut(np.fmod)
+# mod = make_ufunc_shortcut(np.mod)
+# modf = make_ufunc_shortcut(np.modf)
+# remainder = make_ufunc_shortcut(np.remainder)
+# divmod = make_ufunc_shortcut(np.divmod)
+
 # Handling complex numbers
 
 conj = make_ufunc_shortcut(np.conj)
 
 # Miscellaneous
 
 sqrt = make_ufunc_shortcut(np.sqrt)
+square = make_ufunc_shortcut(np.square)
 absolute = make_ufunc_shortcut(np.absolute)
 fabs = make_ufunc_shortcut(np.fabs)
 sign = make_ufunc_shortcut(np.sign)
-fmax = make_ufunc_shortcut(np.fmax)
-fmin = make_ufunc_shortcut(np.fmin)
 
 
 def maximum(x1, x2, out=None, dtype=None):
@@ -336,3 +341,7 @@ def minimum(x1, x2, out=None, dtype=None):
     """
     return np.minimum(x1, x2, out=out, dtype=dtype)
 
+fmax = make_ufunc_shortcut(np.fmax)
+fmin = make_ufunc_shortcut(np.fmin)
+isnan = make_ufunc_shortcut(np.isnan)
+isinf = make_ufunc_shortcut(np.isinf)