using System.Buffers; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; namespace QuanTAlib; /// /// MAAPE: Mean Arctangent Absolute Percentage Error /// /// /// MAAPE uses the arctangent function to bound the error between 0 and π/2, /// making it more robust to outliers and handling zero actual values gracefully. /// /// Formula: /// MAAPE = (1/n) * Σ arctan(|actual - predicted| / |actual|) /// /// Key properties: /// - Bounded output: always between 0 and π/2 (≈1.5708) /// - Handles zero actual values gracefully (approaches π/2) /// - Less sensitive to outliers than MAPE /// - Scale-independent /// [SkipLocalsInit] public sealed class Maape : BiInputIndicatorBase { private const double Epsilon = 1e-10; /// /// Creates a MAAPE (Mean Arctangent Absolute Percentage Error) indicator. /// /// Number of values to average (must be > 0) public Maape(int period) : base(period, $"Maape({period})") { } /// /// Computes arctangent of percentage error: arctan(|error| / |actual|) /// Returns π/2 when actual is near zero. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] protected override double ComputeError(double actual, double predicted) { double absActual = Math.Abs(actual); double absError = Math.Abs(actual - predicted); return absActual > Epsilon ? Math.Atan(absError / absActual) : Math.PI / 2.0; } /// /// Calculates Mean Arctangent Absolute Percentage Error for two time series. /// public static TSeries Batch(TSeries actual, TSeries predicted, int period) { if (actual.Count != predicted.Count) { throw new ArgumentException("Actual and predicted series must have the same length", nameof(predicted)); } int len = actual.Count; var t = new List(len); var v = new List(len); CollectionsMarshal.SetCount(t, len); CollectionsMarshal.SetCount(v, len); var tSpan = CollectionsMarshal.AsSpan(t); var vSpan = CollectionsMarshal.AsSpan(v); Batch(actual.Values, predicted.Values, vSpan, period); actual.Times.CopyTo(tSpan); return new TSeries(t, v); } /// /// Batch computation with O(1) rolling mean. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Batch(ReadOnlySpan actual, ReadOnlySpan predicted, Span output, int period) { if (actual.Length != predicted.Length || actual.Length != output.Length) { throw new ArgumentException("All spans must have the same length", nameof(output)); } if (period <= 0) { throw new ArgumentException("Period must be greater than 0", nameof(period)); } int len = actual.Length; if (len == 0) { return; } // Pre-compute arctangent errors const int StackAllocThreshold = 256; double[]? rented = len > StackAllocThreshold ? ArrayPool.Shared.Rent(len) : null; Span errors = rented != null ? rented.AsSpan(0, len) : stackalloc double[len]; try { ComputeAtanErrors(actual, predicted, errors); // Apply rolling mean ErrorHelpers.ApplyRollingMean(errors, output, period); } finally { if (rented != null) { ArrayPool.Shared.Return(rented); } } } public static (TSeries Results, Maape Indicator) Calculate(TSeries actual, TSeries predicted, int period) { var indicator = new Maape(period); TSeries results = Batch(actual, predicted, period); return (results, indicator); } /// /// Computes arctangent percentage errors. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ComputeAtanErrors( ReadOnlySpan actual, ReadOnlySpan predicted, Span output) { int len = actual.Length; double lastValidActual = 0.0; double lastValidPredicted = 0.0; bool foundActual = false; bool foundPredicted = false; // Find first valid values in a single pass for (int k = 0; k < len; k++) { if (!foundActual && double.IsFinite(actual[k])) { lastValidActual = actual[k]; foundActual = true; } if (!foundPredicted && double.IsFinite(predicted[k])) { lastValidPredicted = predicted[k]; foundPredicted = true; } if (foundActual && foundPredicted) { break; } } for (int i = 0; i < len; i++) { double act = actual[i]; double pred = predicted[i]; if (double.IsFinite(act)) { lastValidActual = act; } else { act = lastValidActual; } if (double.IsFinite(pred)) { lastValidPredicted = pred; } else { pred = lastValidPredicted; } double absActual = Math.Abs(act); double absError = Math.Abs(act - pred); output[i] = absActual > Epsilon ? Math.Atan(absError / absActual) : Math.PI / 2.0; } } }