Fixed #876 Improved Q_subseq_isconstant description

Author: seanlaw

stumpy/core.py

@@ -1640,9 +1640,9 @@ def mass(
         corresponding value set to False in this boolean array.
 
     Q_subseq_isconstant : numpy.ndarray or function, default None
-        A boolean array that indicates whether a subsequence in `Q` is constant
+        A boolean array that indicates whether the subsequence in `Q` is constant
         (True). Alternatively, a custom, user-defined function that returns a
-        boolean array that indicates whether a subsequence in `Q` is constant
+        boolean array that indicates whether the subsequence in `Q` is constant
         (True). The function must only take two arguments, `a`, a 1-D array,
         and `w`, the window size, while additional arguments may be specified
         by currying the user-defined function using `functools.partial`. Any
@@ -1812,7 +1812,7 @@ def _mass_distance_matrix(
         Sliding standard deviation of `T`
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` is constant (True)
+        A boolean array that indicates whether the subsequence in `Q` is constant (True)
 
     T_subseq_isconstant : numpy.ndarray
         A boolean array that indicates whether a subsequence in `T` is constant (True)
@@ -1898,9 +1898,9 @@ def mass_distance_matrix(
         corresponding value set to False in this boolean array.
 
     Q_subseq_isconstant : numpy.ndarray, function, default None
-        A boolean array that indicates whether a subsequence in `Q` is constant
+        A boolean array that indicates whether the subsequence in `Q` is constant
         (True). Alternatively, a custom, user-defined function that returns a
-        boolean array that indicates whether a subsequence in `Q` is constant
+        boolean array that indicates whether the subsequence in `Q` is constant
         (True). The function must only take two arguments, `a`, a 1-D array,
         and `w`, the window size, while additional arguments may be specified
         by currying the user-defined function using `functools.partial`. Any

stumpy/gpu_stump.py

@@ -90,7 +90,7 @@ def _compute_and_update_PI_kernel(
         A boolean array that indicates whether a subsequence in `T` is constant (True)
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` is constant (True)
+        A boolean array that indicates whether the subsequence in `Q` is constant (True)
 
     w : int
         The total number of sliding windows to iterate over

stumpy/maamp.py

@@ -28,7 +28,7 @@ def _multi_mass_absolute(Q, T, m, Q_subseq_isfinite, T_subseq_isfinite, p=2.0):
         Window size
 
     Q_subseq_isfinite : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` contains a
+        A boolean array that indicates whether the subsequence in `Q` contains a
         `np.nan`/`np.inf` value (False)
 
     T_subseq_isfinite : numpy.ndarray
@@ -499,7 +499,7 @@ def _get_first_maamp_profile(
         The half width for the exclusion zone relative to the `start`.
 
     T_B_subseq_isfinite : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` contains a
+        A boolean array that indicates whether a subsequence in `T_B` contains a
         `np.nan`/`np.inf` value (False)
 
     p : float, default 2.0

stumpy/mpdist.py

@@ -57,7 +57,7 @@ def _mpdist_vect(
         Sliding standard deviation of `T`
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` is constant (True)
+        A boolean array that indicates whether the subsequence in `Q` is constant (True)
 
     T_subseq_isconstant : numpy.ndarray
         A boolean array that indicates whether a subsequence in `T` is constant (True)

stumpy/mstump.py

@@ -55,7 +55,7 @@ def _multi_mass(
         A boolean array that indicates whether a subsequence in `T` is constant (True)
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` is constant (True)
+        A boolean array that indicates whether the subsequence in `Q` is constant (True)
 
     query_idx : int, default None
         This is the index position along each of the time series in `T`, where
@@ -483,7 +483,7 @@ def _multi_distance_profile(
         A boolean array that indicates whether a subsequence in `T_A` is constant (True)
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `T_B` is
+        A boolean array that indicates whether the subsequence in `T_B` is
         constant (True)
 
     include : numpy.ndarray, default None
@@ -875,7 +875,7 @@ def _compute_multi_D(
         sliding window
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a query subsequence in `Q`
+        A boolean array that indicates whether the query subsequence in `Q`
         is constant (True)
 
     T_subseq_isconstant : numpy.ndarray
@@ -1009,7 +1009,7 @@ def _mstump(
         is constant (True)
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a query subsequence in `Q`
+        A boolean array that indicates whether the query subsequence in `Q`
         is constant (True)
 
     k : int

stumpy/scrump.py

@@ -78,7 +78,7 @@ def _preprocess_prescrump(
         Sliding window standard deviation for `T_B`
 
     Q_subseq_isconstant : numpy.ndarray
-        A boolean array that indicates whether a subsequence in `Q` is constant (True)
+        A boolean array that indicates whether the subsequence in `Q` is constant (True)
 
     T_subseq_isconstant : numpy.ndarray
         A boolean array that indicates whether a subsequence in `T` is constant (True)

stumpy/stamp.py

@@ -64,7 +64,7 @@ def _mass_PI(
         corresponding value set to False in this boolean array.
 
     Q_subseq_isconstant : numpy.ndarray or function, default None
-        A boolean array that indicates whether a subsequence in `Q` is constant
+        A boolean array that indicates whether the subsequence in `Q` is constant
         (True). Alternatively, a custom, user-defined function that returns a
         boolean array that indicates whether a subsequence in `Q` is constant
         (True). The function must only take two arguments, `a`, a 1-D array,