// Hamma.cs - Hamming Moving Average // Finite Impulse Response (FIR) filter using Hamming window weighting. using System.Buffers; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; namespace QuanTAlib; /// /// HAMMA: Hamming Moving Average /// A weighted moving average using Hamming window coefficients, providing good /// spectral characteristics with reduced side lobes compared to simple windowing. /// /// /// Key characteristics /// /// Hamming window: w[i] = 0.54 - 0.46 × cos(2πi/(period-1)) /// Raised-cosine window with specific coefficients for optimal side-lobe suppression /// First side lobe is approximately -43 dB down from main lobe /// Widely used in digital signal processing and spectral analysis /// /// /// Calculation /// /// w[i] = 0.54 - 0.46 × cos(2π × i / (period - 1)) /// HAMMA = Σ(price[i] × w[i]) / Σ(w[i]) /// /// /// Sources /// Richard W. Hamming - "Digital Filters" (1977) /// Oppenheim, Schafer - "Discrete-Time Signal Processing" /// [SkipLocalsInit] public sealed class Hamma : AbstractBase { private readonly int _period; private readonly double[] _weights; private readonly double _invWeightSum; private readonly RingBuffer _buffer; private readonly ITValuePublisher? _source; private readonly TValuePublishedHandler? _pubHandler; private bool _isNew = true; [StructLayout(LayoutKind.Auto)] private struct State { public double LastValidValue; public bool IsInitialized; } private State _state; private State _p_state; public bool IsNew => _isNew; public override bool IsHot => _buffer.IsFull; /// /// Creates HAMMA with specified parameters. /// /// Window size (must be > 0) [MethodImpl(MethodImplOptions.AggressiveInlining)] public Hamma(int period = 10) { if (period <= 0) throw new ArgumentException("Period must be greater than 0", nameof(period)); _period = period; _buffer = new RingBuffer(period); _weights = new double[period]; Name = $"Hamma({period})"; WarmupPeriod = period; ComputeWeights(_weights, period, out _invWeightSum); _state = default; _state.LastValidValue = double.NaN; } /// Data source for event-based updates /// Lookback period for the Hamming window (default: 10) [MethodImpl(MethodImplOptions.AggressiveInlining)] public Hamma(ITValuePublisher source, int period = 10) : this(period) { _source = source; _pubHandler = Handle; _source.Pub += _pubHandler; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private void Handle(object? sender, in TValueEventArgs e) => Update(e.Value, e.IsNew); protected override void Dispose(bool disposing) { if (disposing && _source != null && _pubHandler != null) { _source.Pub -= _pubHandler; } base.Dispose(disposing); } /// /// Computes Hamming window weights. /// w[i] = 0.54 - 0.46 * cos(2πi/(period-1)) /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ComputeWeights(Span weights, int period, out double invWeightSum) { double sum = 0; if (period == 1) { weights[0] = 1.0; sum = 1.0; } else { double twoPiOverPm1 = 2.0 * Math.PI / (period - 1); for (int i = 0; i < period; i++) { double w = 0.54 - 0.46 * Math.Cos(twoPiOverPm1 * i); weights[i] = w; sum += w; } } invWeightSum = 1.0 / sum; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private double GetValidValue(double input) { if (double.IsFinite(input)) { return input; } return _state.IsInitialized ? _state.LastValidValue : double.NaN; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public override TValue Update(TValue input, bool isNew = true) { _isNew = isNew; return Update(input, isNew, publish: true); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private TValue Update(TValue input, bool isNew, bool publish) { if (isNew) { _p_state = _state; } else { _state = _p_state; } if (double.IsFinite(input.Value)) { _state.LastValidValue = input.Value; _state.IsInitialized = true; } // Retrieve valid value (handles NaN propagation prevention) double val = GetValidValue(input.Value); _buffer.Add(val, isNew); double result = 0; if (_buffer.Count > 0) { result = CalculateWeightedSum(); } Last = new TValue(input.Time, result); if (publish) { PubEvent(Last, isNew); } return Last; } public override TSeries Update(TSeries source) { if (source.Count == 0) return new TSeries([], []); int len = source.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); Calculate(source.Values, vSpan, _period); source.Times.CopyTo(tSpan); // Restore state _buffer.Clear(); _state = default; // Replay last part to restore buffer state int startIndex = Math.Max(0, len - _period); for (int i = startIndex; i < len; i++) { Update(source[i], isNew: true, publish: false); } return new TSeries(t, v); } public override void Prime(ReadOnlySpan source, TimeSpan? step = null) { foreach (var value in source) { Update(new TValue(DateTime.MinValue, value)); } } [MethodImpl(MethodImplOptions.AggressiveInlining)] private double CalculateWeightedSum() { int count = _buffer.Count; if (count == 0) return 0; if (count < _period) { // Partial buffer: align newest with newest // Buffer[0] (oldest) -> Weights[period - count] ReadOnlySpan bufferSpan = _buffer.GetSpan(); int weightOffset = _period - count; // Use DotProduct for partial sum double sum = bufferSpan.DotProduct(_weights.AsSpan(weightOffset, count)); // Calculate weightSum for this subset double wSum = 0; for (int i = 0; i < count; i++) { wSum += _weights[weightOffset + i]; } return wSum > 0 ? sum / wSum : 0; } // Full buffer: use precomputed _weightSum and SIMD DotProduct // We use InternalBuffer and StartIndex to avoid allocation and handle wrapping ReadOnlySpan internalBuf = _buffer.InternalBuffer; int head = _buffer.StartIndex; // Part 1: Oldest to End of Buffer -> InternalBuffer[Head ... Cap-1] // Matches Weights[0 ... Cap-Head-1] int part1Len = _period - head; double sum1 = internalBuf.Slice(head, part1Len).DotProduct(_weights.AsSpan(0, part1Len)); // Part 2: Start of Buffer to Newest -> InternalBuffer[0 ... Head-1] // Matches Weights[Cap-Head ... Cap-1] double sum2 = internalBuf[..head].DotProduct(_weights.AsSpan(part1Len)); return (sum1 + sum2) * _invWeightSum; } /// /// Calculates HAMMA from a TSeries using streaming updates. /// public static TSeries Batch(TSeries source, int period = 10) { var hamma = new Hamma(period); return hamma.Update(source); } /// /// Calculates HAMMA over a span of values (SIMD-optimized for batch processing). /// /// Input values /// Output buffer (must be same length as source) /// Lookback period for the Hamming window (default: 10) /// Thrown when output length doesn't match source length. [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Calculate(ReadOnlySpan source, Span output, int period = 10) { if (period <= 0) throw new ArgumentException("Period must be greater than 0", nameof(period)); if (source.Length != output.Length) throw new ArgumentException("Source and output must have the same length", nameof(output)); // Allocation Strategy: Stack for small periods, Pool for large double[]? weightsArray = period > 256 ? ArrayPool.Shared.Rent(period) : null; Span weights = period <= 256 ? stackalloc double[period] : weightsArray!.AsSpan(0, period); double[]? bufferArray = period > 256 ? ArrayPool.Shared.Rent(period) : null; Span buffer = period <= 256 ? stackalloc double[period] : bufferArray!.AsSpan(0, period); // Precompute weights using shared helper ComputeWeights(weights, period, out double invWeightSum); int bufferIdx = 0; int count = 0; double lastValid = double.NaN; // Start with NaN to detect first valid value double currentWeightSum = 0; try { for (int i = 0; i < source.Length; i++) { double val = source[i]; // Strict NaN handling: maintain NaN until first valid value if (double.IsFinite(val)) { lastValid = val; } else if (double.IsFinite(lastValid)) { val = lastValid; } else { val = double.NaN; // Preserve NaN until first valid value seen } // Add to circular buffer buffer[bufferIdx] = val; bufferIdx = (bufferIdx + 1) % period; if (count < period) { count++; // Incremental weight sum update for warmup currentWeightSum += weights[period - count]; } double sum = 0; if (count == period) { // Buffer is full. bufferIdx points to the oldest element (next write position) // Split the dot product to handle circular buffer wrap-around int part1Len = period - bufferIdx; // Part 1: Oldest data (at bufferIdx..End) * Start of Weights sum += buffer.Slice(bufferIdx, part1Len).DotProduct(weights.Slice(0, part1Len)); // Part 2: Newest data (at 0..bufferIdx) * End of Weights sum += buffer.Slice(0, bufferIdx).DotProduct(weights.Slice(part1Len)); output[i] = sum * invWeightSum; } else { // Partial buffer int startIdx = (bufferIdx - count + period) % period; int weightOffset = period - count; if (startIdx + count <= period) { // Contiguous in buffer sum = buffer.Slice(startIdx, count).DotProduct(weights.Slice(weightOffset, count)); } else { // Wrapped in buffer int part1Len = period - startIdx; int part2Len = count - part1Len; sum = buffer.Slice(startIdx, part1Len).DotProduct(weights.Slice(weightOffset, part1Len)); sum += buffer.Slice(0, part2Len).DotProduct(weights.Slice(weightOffset + part1Len, part2Len)); } output[i] = currentWeightSum > 0 ? sum / currentWeightSum : 0; } } } finally { if (weightsArray != null) ArrayPool.Shared.Return(weightsArray); if (bufferArray != null) ArrayPool.Shared.Return(bufferArray); } } public override void Reset() { _buffer.Clear(); _state = default; _state.LastValidValue = double.NaN; _p_state = _state; Last = default; } }