RunningStatistics Combine Method Must Always Return a New Instance

cdrnet · cdrnet · commit 36c369c740e9 · 2023-08-01T08:11:34.000+02:00
Breaking: RunningStatistics is now sealed Closes #1021
diff --git a/src/Data.Matlab/Data.Matlab.csproj b/src/Data.Matlab/Data.Matlab.csproj
@@ -25,7 +25,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa
diff --git a/src/Data.Text/Data.Text.csproj b/src/Data.Text/Data.Text.csproj
@@ -25,7 +25,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa
diff --git a/src/FSharp/FSharp.fsproj b/src/FSharp/FSharp.fsproj
@@ -24,7 +24,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa
diff --git a/src/Numerics/Numerics.csproj b/src/Numerics/Numerics.csproj
@@ -25,7 +25,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa
diff --git a/src/Numerics/Statistics/RunningStatistics.cs b/src/Numerics/Statistics/RunningStatistics.cs
@@ -47,7 +47,7 @@ namespace MathNet.Numerics.Statistics
     /// It is not recommended to rely on this mechanism for durable persistence.
     /// </remarks>
     [DataContract(Namespace = "urn:MathNet/Numerics")]
-    public class RunningStatistics
+    public sealed class RunningStatistics
     {
         [DataMember(Order = 1)]
         long _n;
@@ -73,6 +73,17 @@ public class RunningStatistics
         public RunningStatistics()
         {
         }
+        
+        public RunningStatistics(RunningStatistics runningStatistics)
+        {
+            _n = runningStatistics._n;
+            _min = runningStatistics._min;
+            _max = runningStatistics._max;
+            _m1 = runningStatistics._m1;
+            _m2 = runningStatistics._m2;
+            _m3 = runningStatistics._m3;
+            _m4 = runningStatistics._m4;
+        }
 
         public RunningStatistics(IEnumerable<double> values)
         {
@@ -203,11 +214,11 @@ public static RunningStatistics Combine(RunningStatistics a, RunningStatistics b
         {
             if (a._n == 0)
             {
-                return b;
+                return new RunningStatistics(b);
             }
-            else if (b._n == 0)
+            if (b._n == 0)
             {
-                return a;
+                return new RunningStatistics(a);
             }
 
             long n = a._n + b._n;
diff --git a/src/Providers.CUDA/Providers.CUDA.csproj b/src/Providers.CUDA/Providers.CUDA.csproj
@@ -25,7 +25,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa
diff --git a/src/Providers.MKL/Providers.MKL.csproj b/src/Providers.MKL/Providers.MKL.csproj
@@ -25,7 +25,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa
diff --git a/src/Providers.OpenBLAS/Providers.OpenBLAS.csproj b/src/Providers.OpenBLAS/Providers.OpenBLAS.csproj
@@ -25,7 +25,7 @@ Random: NextBigIngegerSequence ~Silver-Fang
 Random: xoshiro256StarStar fix out of range exception ~Charlie Turndorf
 Precision: Perf: pre-compute negative powers ~Febin
 Optimizations: Remove static properties in LevenbergMarquardtMinimizer ~Jong Hyun Kim
-Root Finding: Newton-Raphson better handling of zero-evaluations
+Root Finding: Newton-Raphson better handling of zero-evaluations ~jkalias
 Fit.Curve and FindMinimum extended to accept two more parameters
 Fixed an index out of bounds issue when calculating BFGS minimizer with one variable ~Shiney
 Fixed Sparse COO NormalizeDuplicates ~Mohamed Moussa

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ namespace MathNet.Numerics.Statistics`
`47`	`47`	`/// It is not recommended to rely on this mechanism for durable persistence.`
`48`	`48`	`/// </remarks>`
`49`	`49`	`[DataContract(Namespace = "urn:MathNet/Numerics")]`
`50`		`- public class RunningStatistics`
	`50`	`+ public sealed class RunningStatistics`
`51`	`51`	`{`
`52`	`52`	`[DataMember(Order = 1)]`
`53`	`53`	`long _n;`
`@@ -73,6 +73,17 @@ public class RunningStatistics`
`73`	`73`	`public RunningStatistics()`
`74`	`74`	`{`
`75`	`75`	`}`
	`76`	`+`
	`77`	`+ public RunningStatistics(RunningStatistics runningStatistics)`
	`78`	`+ {`
	`79`	`+ _n = runningStatistics._n;`
	`80`	`+ _min = runningStatistics._min;`
	`81`	`+ _max = runningStatistics._max;`
	`82`	`+ _m1 = runningStatistics._m1;`
	`83`	`+ _m2 = runningStatistics._m2;`
	`84`	`+ _m3 = runningStatistics._m3;`
	`85`	`+ _m4 = runningStatistics._m4;`
	`86`	`+ }`
`76`	`87`
`77`	`88`	`public RunningStatistics(IEnumerable<double> values)`
`78`	`89`	`{`
`@@ -203,11 +214,11 @@ public static RunningStatistics Combine(RunningStatistics a, RunningStatistics b`
`203`	`214`	`{`
`204`	`215`	`if (a._n == 0)`
`205`	`216`	`{`
`206`		`- return b;`
	`217`	`+ return new RunningStatistics(b);`
`207`	`218`	`}`
`208`		`- else if (b._n == 0)`
	`219`	`+ if (b._n == 0)`
`209`	`220`	`{`
`210`		`- return a;`
	`221`	`+ return new RunningStatistics(a);`
`211`	`222`	`}`
`212`	`223`
`213`	`224`	`long n = a._n + b._n;`