Fixed #83 Check for NaN

Author: seanlaw

stumpy/core.py

@@ -73,6 +73,23 @@ def z_norm(a, axis=0):
     return (a - np.mean(a, axis, keepdims=True)) / np.std(a, axis, keepdims=True)
 
 
+def check_nan(a):  # pragma: no cover
+    """
+    Check if the array contains NaNs
+
+    Raises
+    ------
+    ValueError
+        If the array contains a NaN
+    """
+
+    if np.any(np.isnan(a)):
+        msg = f"Input array contains one or more NaNs"
+        raise ValueError(msg)
+
+    return
+
+
 def check_dtype(a, dtype=np.floating):  # pragma: no cover
     """
     Check if the array type of `a` is of type specified by `dtype` parameter.

stumpy/gpu_stump.py

@@ -404,12 +404,14 @@ def gpu_stump(
 
     T_A = np.asarray(T_A)
     core.check_dtype(T_A)
+    core.check_nan(T_A)
     if T_B is None:  # Self join!
         T_B = T_A
         ignore_trivial = True
     T_B = np.asarray(T_B)
 
     core.check_dtype(T_B)
+    core.check_nan(T_B)
     core.check_window_size(m)
 
     if ignore_trivial is False and core.are_arrays_equal(T_A, T_B):  # pragma: no cover

stumpy/mstump.py

@@ -437,6 +437,7 @@ def mstump(T, m):
         raise ValueError(f"{err}")
 
     core.check_dtype(T)
+    core.check_nan(T)
     core.check_window_size(m)
 
     d = T.shape[0]

stumpy/mstumped.py

@@ -64,6 +64,7 @@ def mstumped(dask_client, T, m):
         raise ValueError(f"{err}")
 
     core.check_dtype(T)
+    core.check_nan(T)
     core.check_window_size(m)
 
     d = T.shape[0]

stumpy/stamp.py

@@ -126,7 +126,9 @@ def stamp(T_A, T_B, m, ignore_trivial=False):
     """
 
     core.check_dtype(T_A)
+    core.check_nan(T_A)
     core.check_dtype(T_B)
+    core.check_nan(T_B)
     core.check_window_size(m)
     subseq_T_B = core.rolling_window(T_B, m)
     excl_zone = int(np.ceil(m / 2))

stumpy/stomp.py

@@ -64,9 +64,11 @@ def stomp(T_A, m, T_B=None, ignore_trivial=True):
     Note that left and right matrix profiles are only available for self-joins.
     """
     core.check_dtype(T_A)
+    core.check_nan(T_A)
     if T_B is None:
         T_B = T_A
     core.check_dtype(T_B)
+    core.check_nan(T_B)
     core.check_window_size(m)
 
     if ignore_trivial is False and core.are_arrays_equal(T_A, T_B):  # pragma: no cover

stumpy/stump.py

@@ -391,6 +391,7 @@ def stump(T_A, m, T_B=None, ignore_trivial=True):
 
     T_A = np.asarray(T_A)
     core.check_dtype(T_A)
+    core.check_nan(T_A)
     if T_B is None:  # Self join!
         T_B = T_A
         ignore_trivial = True
@@ -402,6 +403,7 @@ def stump(T_A, m, T_B=None, ignore_trivial=True):
         raise ValueError(f"T_B is {T_B.ndim}-dimensional and must be 1-dimensional")
 
     core.check_dtype(T_B)
+    core.check_nan(T_B)
     core.check_window_size(m)
 
     if ignore_trivial is False and core.are_arrays_equal(T_A, T_B):  # pragma: no cover

stumpy/stumped.py

@@ -83,6 +83,7 @@ def stumped(dask_client, T_A, m, T_B=None, ignore_trivial=True):
 
     T_A = np.asarray(T_A)
     core.check_dtype(T_A)
+    core.check_nan(T_A)
     if T_B is None:
         T_B = T_A
     T_B = np.asarray(T_B)
@@ -93,6 +94,7 @@ def stumped(dask_client, T_A, m, T_B=None, ignore_trivial=True):
         raise ValueError(f"T_B is {T_B.ndim}-dimensional and must be 1-dimensional")
 
     core.check_dtype(T_B)
+    core.check_nan(T_B)
     core.check_window_size(m)
 
     if ignore_trivial is False and core.are_arrays_equal(T_A, T_B):  # pragma: no cover