Merge pull request #80 from meokullu/v3_correction_0001

V3 correction 0001

CHANGELOG.md

@@ -11,6 +11,77 @@
 #### Removed
 -->
 
+### [3.0.0]
+#### Added
+* `SetTextMessageTurkish()` method added for setting all text messages that are used by naming ETA Turkish. [#78](https://github.com/meokullu/CalculateETA/issues/78)
+* `SetTextMessageAbbrevations()` method added for setting all text messages thatare used by naming ETA English abbrevations. [#78](https://github.com/meokullu/CalculateETA/issues/78)
+* `PreventSurgeByPercentage(long? eta, double discretePercentage)` method added into `Correction`
+* `PreventSurgeByPercentage(double? eta, double discretePercentage)` method added into `Correction`
+* `PreventSurgeByValueRepeatence(long? eta)` method added into `Correction`
+* `PreventSurgeByValueRepeatence(double? eta)` method added into `Correction`
+* `MultiThreading` and `Reporting` are added. Instance of each can be used repeatedly and simultaneously.
+
+#### Changed
+Following methods' parameter names are simplified. [#77](https://github.com/meokullu/CalculateETA/issues/77)
+* On `CalcETAAsync(int? index, int totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` parameter is replaced with `elapsed`.
+* On `CalcETAAsync(int totalIndex, long? totalElapsedTime)` method `totalElapsedTime` parameter is replaced with `elapsed`.
+* On `NameETAAsync(long? etaTimeInMs)` method `etaTimeInMs` parameter is replaced with `eta`.
+
+* On `NameETA(long? etaTimeInMs)` method `etaTimeInMs` parameter is replaced with `eta`.
+* On `NameETA(double? etaTime)` method `etaTime` parameter is replaced with `eta`.
+* On `NameETAUnsafe(long etaTimeInMs)` method `etaTimeInMs` parameter is replaced with `eta`.
+* On `NameETAUnsafe(double etaTime)` method `etaTime` parameter is replaced with `eta`.
+* On `NameETABetterVisual(long? etaTimeInMs)` method `etaTimeInMs` parameter is replaced with `eta`.
+* On `NameETABetterVisual(double? etaTime)` method `etaTime` parameter is replaced with `eta`.
+* On `NameETABetterVisualUnsafe(long etaTimeInMs)` method `ètaTimeInMs` is replaced with `eta`.
+* On `NameETABetterVisualUnsafe(double etaTime)` method `etaTime` is replaced with `eta`.
+* On `NumberFormatETA(long? etaTimeInMs)` method `etaTimeInMs` is replaced with `eta`.
+* On `NumberFormatETA(double? etaTime)` method `etaTime` is replaced with `eta`.
+* On `NumberFormatETAUnsafe(long etaTimeInMs)` method `etaTimeInMs` is replaced with `eta`.
+* On `NumberFormatETAUnsafe(double etaTime)` method `etaTime` is replaced with `eta`.
+* On `TimeSpanETA(long? etaTimeInMs)` method `etaTimeInMs` is replaced with `eta`.
+* On `TimeSpanETA(double? etaTime)` method `etaTime` is replaced with `eta`.
+* On `TimeSpanETAUnsafe(long etaTimeInMs)` method `etaTimeInMs` is replaced wtih `eta`.
+* On `TimeSpanETAUnsafe(double etaTime)` method `etaTime` is replaced wìth `eta`.
+
+* On `AddReport(this long? etaTime)` method `etaTime` is replaced with `eta`.
+* On `AddReport(this double? etaTime)` method `etaTime` is replaced with `eta`.
+
+* On `CalcETA(uint? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETA(uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETA(int? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETA(int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+
+* On `CalcETAUnsafe(uint? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETAUnsafe(uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAUnsafe(int? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETAUnsafe(int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced `elapsedTicks`.
+
+* On `CalcETA(uint? index, uint? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeMs` is replaced with `elapsed`.
+* On `CalcETA(uint? index, uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETA(int? index, int? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETA(int? index, int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+
+* On `CalcETAUnsafe(uint? index, uint? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETAUnsafe(uint? index, uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAUnsafe(int? index, int? totalIndex, long? totalElapsedTimeInMs)` method `totalElapsedTimeInMs` is replaced with `elapsed`.
+* On `CalcETAUnsafe(int? index, int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+
+* On `CalcETAHighDense(uint? index, uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAHighDense(int? index, int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAHighDenseUnsafe(uint? index, uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAHighDenseUnsafe(int? index, int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+
+* On `CalcETAHighDense(uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAHighDense(int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+* On `CalcETAHighDenseUnsafe(uint? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`
+* On `CalcETAHighDenseUnsafe(int? totalIndex, long? totalElapsedTicks, long? frequency)` method `totalElapsedTicks` is replaced with `elapsedTicks`.
+
+* `ResetCounterUint()` and `ResultCounter()` methods were unaccesible due to lack of marking them as static. Not they are marked as static.
+
+#### Removed
+* `NameETAUnSafe(double etaTime)` was marked as obsolote on version 2.4.0 with suggesting alternative as `NameETAUnsafe(double etaTime)` due to hypo. Now obsolote method is removed.
+
 ### [2.4.0]
 #### Added
 * `CalcMultiThread.cs` and `CalcSingleThread.cs` files are added.

CalculateETA/CalculateETA.csproj

@@ -12,22 +12,17 @@
     <PackageIcon>icon.png</PackageIcon>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageReleaseNotes>
-      v2.4.0
-      * CalcMultiThread.cs and CalcSingleThread.cs files are added.
-      * ClearListInDouble(), ClearListInLong(), GetCountListInDouble() and GetCountListInLong() method are added under Report.cs. (#71)
-      * NameETA(double etaTime), NameETAUnsafe(double etaTime), NameETABetterVisual(double etaTime), NameETABetterVisualUnsafe(double etaTime), NumberFormatETA(double etaTime) and NumberFormatETAUnsafe(double etaTime) methods are added for naming values in double under Visualizations.cs
-      * NameETAUnSafe(double etaTime) renamed as NameETAUnsafe(double etaTime).
-      * NameETABetterVisual(long? etaTimeInMs), NameETABetterVisual(double? etaTime), NameETABetterVisualUnsafe(long etaTimeInMs) and NameETABetterVisualUnsafe(double etaTime) was adding additional space.
-
+      v3.0.0
+      Adding PreventSurge modules and wide changes.
       See changelog (https://github.com/meokullu/CalculateETA/blob/master/CHANGELOG.md)
     </PackageReleaseNotes>
-    <Version>2.4.0</Version>
+    <Version>3.0.0</Version>
     <Description>CalculateETA is a project to calculate estimated time to arrive on loops whether it is in single-thread or multi-thread applicatons.</Description>
     <Copyright>Enes Okullu</Copyright>
     <RepositoryType>git</RepositoryType>
     <PackageTags>ETA; Time; LeftTime; Iterations; Time-Estimations; Multi-thread; Single-thread; loops</PackageTags>
-    <AssemblyVersion>2.4.0</AssemblyVersion>
-    <FileVersion>2.4.0</FileVersion>
+    <AssemblyVersion>3.0.0</AssemblyVersion>
+    <FileVersion>3.0.0</FileVersion>
     <PackageProjectUrl>https://meokullu.github.io/CalculateETA/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/meokullu/CalculateETA</RepositoryUrl>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>

CalculateETA/src/Async.cs

@@ -7,28 +7,28 @@ public partial class CalculateETA
         /// <summary>
         /// Calling <see cref="CalcETA(int?, int?, long?)"/> method with Task.Run().
         /// </summary>
-        public static async Task<long?> CalcETAAsync(int? index, int totalIndex, long? totalElapsedTimeInMs)
+        public static async Task<long?> CalcETAAsync(int? index, int totalIndex, long? elapsed)
         {
             // Calling method with provided values with Task.Run().
-            return await Task.Run(() => CalcETA(index: index, totalIndex: totalIndex, totalElapsedTimeInMs: totalElapsedTimeInMs));
+            return await Task.Run(() => CalcETA(index: index, totalIndex: totalIndex, elapsed: elapsed));
         }
 
         /// <summary>
         /// Calling <see cref="CalcETA(int?, long?)"/> method with Task.Run().
         /// </summary>
-        public static async Task<long?> CalcETAAsync(int? totalIndex, long? totalElapsedTime)
+        public static async Task<long?> CalcETAAsync(int? totalIndex, long? elapsed)
         {
             // Calling method with provided values with Task.Run().
-            return await Task.Run(() => CalcETA(totalIndex, totalElapsedTime));
+            return await Task.Run(() => CalcETA(totalIndex, elapsed));
         }
 
         /// <summary>
         /// Calling <see cref="NameETA(long?)"/> method with Task.Run()
         /// </summary>
-        public static async Task<string> NameETAAsync(long? etaTimeInMs)
+        public static async Task<string> NameETAAsync(long? eta)
         {
             // Calling method with provided values with Task.Run().
-            return await Task.Run(() => NameETA(etaTimeInMs: etaTimeInMs));
+            return await Task.Run(() => NameETA(eta: eta));
         }
     }
 }