using System.Numerics; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using System.Runtime.Intrinsics; using System.Runtime.Intrinsics.X86; namespace QuanTAlib; /// /// RMSE: Root Mean Squared Error /// /// /// RMSE is the square root of MSE, bringing the error metric back to the /// original units of the data while retaining the outlier sensitivity /// of squared errors. /// /// Formula: /// RMSE = √((1/n) * Σ(actual - predicted)²) = √MSE /// /// Uses a RingBuffer for O(1) streaming updates with running sum. /// /// Key properties: /// - Always non-negative (RMSE ≥ 0) /// - Same units as the original data /// - Heavily penalizes outliers due to squaring before averaging /// - RMSE = 0 indicates perfect prediction /// [SkipLocalsInit] public sealed class Rmse : AbstractBase { private readonly RingBuffer _buffer; [StructLayout(LayoutKind.Auto)] private record struct State(double Sum, double LastValidActual, double LastValidPredicted, int TickCount); private State _state; private State _p_state; private const int ResyncInterval = 1000; /// /// Creates RMSE with specified period. /// /// Number of values to average (must be > 0) public Rmse(int period) { if (period <= 0) throw new ArgumentException("Period must be greater than 0", nameof(period)); _buffer = new RingBuffer(period); Name = $"Rmse({period})"; WarmupPeriod = period; } public override bool IsHot => _buffer.IsFull; [MethodImpl(MethodImplOptions.AggressiveInlining)] public TValue Update(TValue actual, TValue predicted, bool isNew = true) { double actualVal = actual.Value; double predictedVal = predicted.Value; if (!double.IsFinite(actualVal)) actualVal = double.IsFinite(_state.LastValidActual) ? _state.LastValidActual : 0.0; else _state.LastValidActual = actualVal; if (!double.IsFinite(predictedVal)) predictedVal = double.IsFinite(_state.LastValidPredicted) ? _state.LastValidPredicted : 0.0; else _state.LastValidPredicted = predictedVal; double diff = actualVal - predictedVal; double squaredError = diff * diff; if (isNew) { _p_state = _state; double removedValue = _buffer.Count == _buffer.Capacity ? _buffer.Oldest : 0.0; _state.Sum = _state.Sum - removedValue + squaredError; _buffer.Add(squaredError); _state.TickCount++; if (_buffer.IsFull && _state.TickCount >= ResyncInterval) { _state.TickCount = 0; _state.Sum = _buffer.RecalculateSum(); } } else { _state = _p_state; double removedValue = _buffer.Count == _buffer.Capacity ? _buffer.Oldest : 0.0; _state.Sum = _state.Sum - removedValue + squaredError; _buffer.UpdateNewest(squaredError); _state.Sum = _buffer.RecalculateSum(); } double mse = _buffer.Count > 0 ? _state.Sum / _buffer.Count : squaredError; double result = Math.Sqrt(mse); Last = new TValue(actual.Time, result); PubEvent(Last, isNew); return Last; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public TValue Update(double actual, double predicted, bool isNew = true) { return Update(new TValue(DateTime.UtcNow, actual), new TValue(DateTime.UtcNow, predicted), isNew); } public override TValue Update(TValue input, bool isNew = true) { throw new NotSupportedException("RMSE requires two inputs. Use Update(actual, predicted)."); } public override TSeries Update(TSeries source) { throw new NotSupportedException("RMSE requires two inputs. Use Calculate(actualSeries, predictedSeries, period)."); } public override void Prime(ReadOnlySpan source, TimeSpan? step = null) { throw new NotSupportedException("RMSE requires two inputs."); } public override void Reset() { _buffer.Clear(); _state = default; _p_state = default; Last = default; } public static TSeries Calculate(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); } [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; CalculateScalarCore(actual, predicted, output, period); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void CalculateScalarCore(ReadOnlySpan actual, ReadOnlySpan predicted, Span output, int period) { int len = actual.Length; const int StackAllocThreshold = 256; Span buffer = period <= StackAllocThreshold ? stackalloc double[period] : new double[period]; // Pre-compute squared errors using SIMD if available and data is clean Span sqErrors = len <= StackAllocThreshold ? stackalloc double[len] : new double[len]; ComputeSquaredErrors(actual, predicted, sqErrors); // Apply rolling window average with O(1) per element, then sqrt double sum = 0; int bufferIndex = 0; int warmupEnd = Math.Min(period, len); for (int i = 0; i < warmupEnd; i++) { sum += sqErrors[i]; buffer[i] = sqErrors[i]; output[i] = Math.Sqrt(sum / (i + 1)); } int tickCount = 0; for (int i = warmupEnd; i < len; i++) { double sqError = sqErrors[i]; sum = sum - buffer[bufferIndex] + sqError; buffer[bufferIndex] = sqError; bufferIndex++; if (bufferIndex >= period) bufferIndex = 0; output[i] = Math.Sqrt(sum / period); tickCount++; if (tickCount >= ResyncInterval) { tickCount = 0; double recalcSum = 0; for (int k = 0; k < period; k++) recalcSum += buffer[k]; sum = recalcSum; } } } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ComputeSquaredErrors( ReadOnlySpan actual, ReadOnlySpan predicted, Span sqErrors) { int len = actual.Length; double lastValidActual = 0; double lastValidPredicted = 0; // Find first valid values for (int k = 0; k < len; k++) { if (double.IsFinite(actual[k])) { lastValidActual = actual[k]; break; } } for (int k = 0; k < len; k++) { if (double.IsFinite(predicted[k])) { lastValidPredicted = predicted[k]; break; } } // Try SIMD path for clean data (no NaN/Inf) if (Avx2.IsSupported && len >= Vector256.Count) { // Check if data is clean (no NaN/Inf) - sample check bool dataClean = true; int checkStep = Math.Max(1, len / 32); for (int i = 0; i < len && dataClean; i += checkStep) { dataClean = double.IsFinite(actual[i]) && double.IsFinite(predicted[i]); } if (dataClean) { ComputeSquaredErrorsSimd(actual, predicted, sqErrors); return; } } // Scalar fallback with NaN handling ComputeSquaredErrorsScalar(actual, predicted, sqErrors, lastValidActual, lastValidPredicted); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ComputeSquaredErrorsSimd( ReadOnlySpan actual, ReadOnlySpan predicted, Span sqErrors) { int len = actual.Length; int vectorSize = Vector256.Count; int vectorEnd = len - (len % vectorSize); int i = 0; for (; i < vectorEnd; i += vectorSize) { Vector256 actVec = Vector256.LoadUnsafe(ref MemoryMarshal.GetReference(actual.Slice(i))); Vector256 predVec = Vector256.LoadUnsafe(ref MemoryMarshal.GetReference(predicted.Slice(i))); // error = actual - predicted Vector256 errorVec = Avx.Subtract(actVec, predVec); // sqError = error * error Vector256 sqErrorVec = Avx.Multiply(errorVec, errorVec); sqErrorVec.StoreUnsafe(ref MemoryMarshal.GetReference(sqErrors.Slice(i))); } // Handle remainder with scalar for (; i < len; i++) { double diff = actual[i] - predicted[i]; sqErrors[i] = diff * diff; } } [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ComputeSquaredErrorsScalar( ReadOnlySpan actual, ReadOnlySpan predicted, Span sqErrors, double lastValidActual, double lastValidPredicted) { int len = actual.Length; 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 diff = act - pred; sqErrors[i] = diff * diff; } } }