Prepare for release.

Author: sinshu

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v1.0.4
+
+* Added `Special.GetMemoryFromUnmanagedPointer` to support matrices backed by unmanaged memory.
+* Added `DynamicTimeWarping`.
+
 # v1.0.3
 
 * Indexers for `Vec<T>` and `Mat<T>` now return `ref T`, improving usability.

NumFlat/NumFlat.csproj

@@ -8,7 +8,7 @@
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <Title>NumFlat</Title>
-    <Version>1.0.3</Version>
+    <Version>1.0.4</Version>
     <Authors>Nobuaki Tanaka</Authors>
     <Description>A numerical computation library for C#</Description>
     <PackageProjectUrl>https://github.com/sinshu/numflat</PackageProjectUrl>

NumFlat/TimeSeries/DynamicTimeWarping.cs

@@ -33,7 +33,7 @@ public static class DynamicTimeWarping
         /// <returns>
         /// The DTW distance between the input sequences.
         /// </returns>
-        public static double GetDistance<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance, int w = int.MaxValue)
+        public static double GetDistance<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance, int w)
         {
             ThrowHelper.ThrowIfNull(xs, nameof(xs));
             ThrowHelper.ThrowIfNull(ys, nameof(ys));
@@ -52,6 +52,32 @@ public static double GetDistance<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys,
             return Compute(xs, ys, distance, w, false).Distance;
         }
 
+        /// <summary>
+        /// Applies the DTW (dynamic time warping) matching algorithm to the given two sequences.
+        /// </summary>
+        /// <typeparam name="T">
+        /// The type of elements in the first sequence.
+        /// </typeparam>
+        /// <typeparam name="U">
+        /// The type of elements in the second sequence.
+        /// </typeparam>
+        /// <param name="xs">
+        /// The first input sequence.
+        /// </param>
+        /// <param name="ys">
+        /// The second input sequence.
+        /// </param>
+        /// <param name="distance">
+        /// An instance of <see cref="IDistance{T, U}"/> to compute the distance between two elements.
+        /// </param>
+        /// <returns>
+        /// The DTW distance between the input sequences.
+        /// </returns>
+        public static double GetDistance<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance)
+        {
+            return GetDistance(xs, ys, distance, int.MaxValue);
+        }
+
         /// <summary>
         /// Applies the DTW (dynamic time warping) matching algorithm to the given two sequences.
         /// </summary>
@@ -77,7 +103,7 @@ public static double GetDistance<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys,
         /// <returns>
         /// A tuple containing the DTW distance and the alignment path between the input sequences.
         /// </returns>
-        public static (double Distance, IndexPair[] Alignment) GetDistanceAndAlignment<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance, int w = int.MaxValue)
+        public static (double Distance, IndexPair[] Alignment) GetDistanceAndAlignment<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance, int w)
         {
             ThrowHelper.ThrowIfNull(xs, nameof(xs));
             ThrowHelper.ThrowIfNull(ys, nameof(ys));
@@ -97,6 +123,32 @@ public static (double Distance, IndexPair[] Alignment) GetDistanceAndAlignment<T
             return (result.Distance, result.Alignment!);
         }
 
+        /// <summary>
+        /// Applies the DTW (dynamic time warping) matching algorithm to the given two sequences.
+        /// </summary>
+        /// <typeparam name="T">
+        /// The type of elements in the first sequence.
+        /// </typeparam>
+        /// <typeparam name="U">
+        /// The type of elements in the second sequence.
+        /// </typeparam>
+        /// <param name="xs">
+        /// The first input sequence.
+        /// </param>
+        /// <param name="ys">
+        /// The second input sequence.
+        /// </param>
+        /// <param name="distance">
+        /// An instance of <see cref="IDistance{T, U}"/> to compute the distance between two elements.
+        /// </param>
+        /// <returns>
+        /// A tuple containing the DTW distance and the alignment path between the input sequences.
+        /// </returns>
+        public static (double Distance, IndexPair[] Alignment) GetDistanceAndAlignment<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance)
+        {
+            return GetDistanceAndAlignment(xs, ys, distance, int.MaxValue);
+        }
+
         private static (double Distance, IndexPair[]? Alignment) Compute<T, U>(IReadOnlyList<T> xs, IReadOnlyList<U> ys, IDistance<T, U> distance, int w, bool computeAlignment)
         {
             var n = xs.Count;

README.md

@@ -706,7 +706,7 @@ Matrix 3x3-Double
     - ⬜ Bayes classifier
     - ⬜ SVM (support vector machine)
 * ⬜ Time series
-    - ⬜ DTW (dynamic time warping)
+    - ✅ DTW (dynamic time warping)
     - ⬜ HMM (hidden Markov model)
 * 🚧 Signal processing
     - ✅ FFT (fast Fourier transform)