corrections

lib/errors/Mape.cs

@@ -1,25 +1,10 @@
 namespace QuanTAlib;
 
-/// <summary>
-/// Represents a Mean Absolute Percentage Error calculator that measures the average absolute percentage difference
-/// between actual values and predicted values.
-/// </summary>
-/// <remarks>
-/// The Mape class calculates the Mean Absolute Percentage Error using a circular buffer
-/// to efficiently manage the data points within the specified period.
-/// </remarks>
 public class Mape : AbstractBase
 {
     private readonly CircularBuffer _actualBuffer;
     private readonly CircularBuffer _predictedBuffer;
 
-    /// <summary>
-    /// Initializes a new instance of the Mape class with the specified period.
-    /// </summary>
-    /// <param name="period">The period over which to calculate the Mean Absolute Percentage Error.</param>
-    /// <exception cref="ArgumentOutOfRangeException">
-    /// Thrown when period is less than 1.
-    /// </exception>
     public Mape(int period)
     {
         if (period < 1)
@@ -33,20 +18,12 @@ public class Mape : AbstractBase
         Init();
     }
 
-    /// <summary>
-    /// Initializes a new instance of the Mape class with the specified source and period.
-    /// </summary>
-    /// <param name="source">The source object to subscribe to for value updates.</param>
-    /// <param name="period">The period over which to calculate the Mean Absolute Percentage Error.</param>
     public Mape(object source, int period) : this(period)
     {
         var pubEvent = source.GetType().GetEvent("Pub");
         pubEvent?.AddEventHandler(source, new ValueSignal(Sub));
     }
 
-    /// <summary>
-    /// Initializes the Mape instance by clearing the buffers.
-    /// </summary>
     public override void Init()
     {
         base.Init();
@@ -54,10 +31,6 @@ public class Mape : AbstractBase
         _predictedBuffer.Clear();
     }
 
-    /// <summary>
-    /// Manages the state of the Mape instance based on whether new values are being processed.
-    /// </summary>
-    /// <param name="isNew">Indicates whether the current inputs are new values.</param>
     protected override void ManageState(bool isNew)
     {
         if (isNew)
@@ -67,18 +40,6 @@ public class Mape : AbstractBase
         }
     }
 
-    /// <summary>
-    /// Performs the Mean Absolute Percentage Error calculation for the current period.
-    /// </summary>
-    /// <returns>
-    /// The calculated Mean Absolute Percentage Error value for the current period.
-    /// </returns>
-    /// <remarks>
-    /// This method calculates the Mean Absolute Percentage Error using the formula:
-    /// MAPE = (sum(|actual - predicted| / |actual|) / n) * 100
-    /// where actual is each actual value, predicted is each predicted value, and n is the number of values.
-    /// If any actual value is zero, it is excluded from the calculation to avoid division by zero.
-    /// </remarks>
     protected override double Calculation()
     {
         ManageState(Input.IsNew);
@@ -96,37 +57,18 @@ public class Mape : AbstractBase
             var predictedValues = _predictedBuffer.GetSpan().ToArray();
 
             double sumAbsolutePercentageError = 0;
-            int validCount = 0;
-
             for (int i = 0; i < _actualBuffer.Count; i++)
             {
                 if (actualValues[i] != 0)
                 {
                     sumAbsolutePercentageError += Math.Abs((actualValues[i] - predictedValues[i]) / actualValues[i]);
-                    validCount++;
                 }
             }
 
-            if (validCount > 0)
-            {
-                mape = (sumAbsolutePercentageError / validCount) * 100;
-            }
+            mape = sumAbsolutePercentageError / _actualBuffer.Count;
         }
 
         IsHot = _index >= WarmupPeriod;
         return mape;
     }
-
-    /// <summary>
-    /// Calculates the Mean Absolute Percentage Error for the given actual and predicted values.
-    /// </summary>
-    /// <param name="actual">The actual value.</param>
-    /// <param name="predicted">The predicted value.</param>
-    /// <returns>The calculated Mean Absolute Percentage Error.</returns>
-    public double Calc(double actual, double predicted)
-    {
-        Input = new TValue(DateTime.Now, actual);
-        Input2 = new TValue(DateTime.Now, predicted);
-        return Calculation();
-    }
 }