Fixed #1002 Added Named Multi-dimensional Matrix Profiles

Author: seanlaw

stumpy/maamp.py

@@ -8,6 +8,7 @@
 from numba import njit, prange
 
 from . import config, core
+from .mmparray import mparray
 
 
 def _multi_mass_absolute(Q, T, m, Q_subseq_isfinite, T_subseq_isfinite, p=2.0):
@@ -979,4 +980,4 @@ def maamp(T, m, include=None, discords=False, p=2.0):
         discords,
     )
 
-    return P, I
+    return mparray(P_=P, I_=I)

stumpy/maamped.py

@@ -8,6 +8,7 @@
 
 from . import config, core
 from .maamp import _get_first_maamp_profile, _get_multi_p_norm, _maamp
+from .mmparray import mparray
 
 
 def _dask_maamped(
@@ -412,4 +413,4 @@ def maamped(client, T, m, include=None, discords=False, p=2.0):
         discords,
     )
 
-    return P, I
+    return mparray(P_=P, I_=I)

stumpy/mmparray.py

@@ -0,0 +1,3 @@
+from collections import namedtuple
+
+mparray = namedtuple("mparray", "P_,I_")

stumpy/mstump.py

@@ -10,6 +10,7 @@
 
 from . import config, core
 from .maamp import maamp, maamp_mdl, maamp_multi_distance_profile, maamp_subspace
+from .mmparray import mparray
 
 
 def _multi_mass(
@@ -1281,4 +1282,4 @@ def mstump(
         discords,
     )
 
-    return P, I
+    return mparray(P_=P, I_=I)

stumpy/mstumped.py

@@ -8,6 +8,7 @@
 
 from . import config, core
 from .maamped import maamped
+from .mmparray import mparray
 from .mstump import _get_first_mstump_profile, _get_multi_QT, _mstump
 
 
@@ -531,4 +532,4 @@ def mstumped(
         discords,
     )
 
-    return P, I
+    return mparray(P_=P, I_=I)

test.sh

@@ -19,6 +19,8 @@ do
         test_mode="gpu"
     elif [[ $var == "show" ]]; then
         test_mode="show"
+    elif [[ $var == "count" ]]; then
+        test_mode="count"
     elif [[ $var == "custom" ]]; then
         test_mode="custom"
     elif [[ $var == "report" ]]; then
@@ -273,6 +275,12 @@ check_links()
     pytest --check-links docs/Tutorial_*.ipynb notebooks/Tutorial_*.ipynb docs/*.md docs/*.rst  ./*.md ./*.rst
 }
 
+count()
+{
+    test_count=$(pytest --collect-only -q | sed '$d' | sed '$d' | wc -l | sed 's/ //g')
+    echo "Found $test_count Unit Tests"
+}
+
 clean_up()
 {
     echo "Cleaning Up"
@@ -340,6 +348,9 @@ elif [[ $test_mode == "report" ]]; then
 elif [[ $test_mode == "gpu" ]]; then
     echo "Executing GPU Unit Tests Only"
     test_gpu
+elif [[ $test_mode == "count" ]]; then
+    echo "Counting Unit Tests"
+    count
 elif [[ $test_mode == "links" ]]; then
     echo "Check Notebook Links  Only"
     check_links

tests/test_mmparray.py

@@ -0,0 +1,34 @@
+import naive
+import numpy as np
+import numpy.testing as npt
+import pytest
+
+from stumpy import maamp, mstump
+
+test_data = [
+    (np.array([[584, -11, 23, 79, 1001, 0, -19]], dtype=np.float64), 3),
+    (np.random.uniform(-1000, 1000, [5, 20]).astype(np.float64), 5),
+]
+
+
+@pytest.mark.parametrize("T, m", test_data)
+def test_mmparray_mstump(T, m):
+    excl_zone = int(np.ceil(m / 4))
+
+    ref_P, ref_I = naive.mstump(T, m, excl_zone)
+    comp = mstump(T, m)
+
+    npt.assert_almost_equal(ref_P, comp.P_)
+    npt.assert_almost_equal(ref_I, comp.I_)
+
+
+@pytest.mark.parametrize("T, m", test_data)
+def test_mmparray_maamp(T, m):
+    excl_zone = int(np.ceil(m / 4))
+
+    for p in [1.0, 2.0, 3.0]:
+        ref_P, ref_I = naive.maamp(T, m, excl_zone, p=p)
+        comp = maamp(T, m, p=p)
+
+        npt.assert_almost_equal(ref_P, comp.P_)
+        npt.assert_almost_equal(ref_I, comp.I_)