gavindiaz/QuanTAlib
1
0
Fork 0
mirror of https://github.com/mihakralj/QuanTAlib.git synced 2026-08-15 00:58:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

corrections

Browse Source
This commit is contained in:
Miha Kralj
2024-10-13 17:18:31 -07:00
parent 2236f5f483
commit bbefc72d73
65 changed files with 669 additions and 1087 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/errors/Me.cs
-51
View File
@@ -1,25 +1,10 @@
namespace QuanTAlib;
/// <summary>
/// Represents a Mean Error calculator that measures the average difference
/// between actual values and predicted values.
/// </summary>
/// <remarks>
/// The Me class calculates the Mean Error using a circular buffer
/// to efficiently manage the data points within the specified period.
/// </remarks>
public class Me : AbstractBase
{
private readonly CircularBuffer _actualBuffer;
private readonly CircularBuffer _predictedBuffer;
/// <summary>
/// Initializes a new instance of the Me class with the specified period.
/// </summary>
/// <param name="period">The period over which to calculate the Mean Error.</param>
/// <exception cref="ArgumentOutOfRangeException">
/// Thrown when period is less than 1.
/// </exception>
public Me(int period)
{
if (period < 1)
@@ -33,20 +18,12 @@ public class Me : 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 Me(object source, int period) : this(period)
{
var pubEvent = source.GetType().GetEvent("Pub");
pubEvent?.AddEventHandler(source, new ValueSignal(Sub));
}
/// <summary>
/// Initializes the Me instance by clearing the buffers.
/// </summary>
public override void Init()
{
base.Init();
@@ -54,10 +31,6 @@ public class Me : AbstractBase
_predictedBuffer.Clear();
}
/// <summary>
/// Manages the state of the Me 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,17 +40,6 @@ public class Me : AbstractBase
}
}
/// <summary>
/// Performs the Mean Error calculation for the current period.
/// </summary>
/// <returns>
/// The calculated Mean Error value for the current period.
/// </returns>
/// <remarks>
/// This method calculates the Mean Error using the formula:
/// ME = sum(actual - predicted) / n
/// where actual is each actual value, predicted is each predicted value, and n is the number of values.
/// </remarks>
protected override double Calculation()
{
ManageState(Input.IsNew);
@@ -106,17 +68,4 @@ public class Me : AbstractBase
IsHot = _index >= WarmupPeriod;
return me;
}
/// <summary>
/// Calculates the Mean 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 Error.</returns>
public double Calc(double actual, double predicted)
{
Input = new TValue(DateTime.Now, actual);
Input2 = new TValue(DateTime.Now, predicted);
return Calculation();
}
}