using System.Buffers; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; namespace QuanTAlib; /// /// ALMA: Arnaud Legoux Moving Average /// /// /// Gaussian-weighted MA with adjustable offset and sigma for responsiveness control. /// Higher offset (0-1) = more responsive; higher sigma = sharper weights. /// /// Calculation: W_i = exp(-(i - m)² / (2s²)) where m = offset × (period-1). /// /// Detailed documentation [SkipLocalsInit] public sealed class Alma : AbstractBase { private readonly int _period; private readonly double _offset; private readonly double _sigma; private readonly double[] _weights; private readonly double _invWeightSum; private readonly RingBuffer _buffer; private readonly ITValuePublisher? _source; private readonly TValuePublishedHandler? _pubHandler; private bool _isNew = true; private bool _disposed; [StructLayout(LayoutKind.Auto)] private record struct State(double LastValidValue, bool IsInitialized); private State _state; private State _pState; public bool IsNew => _isNew; public override bool IsHot => _buffer.IsFull; /// /// Creates ALMA with specified parameters. /// /// Window size (must be > 0) /// Gaussian offset (0-1, default 0.85). Closer to 1 makes it more responsive. /// Standard deviation (default 6). Higher values make it sharper. public Alma(int period, double offset = 0.85, double sigma = 6.0) { if (period <= 0) { throw new ArgumentException("Period must be greater than 0", nameof(period)); } if (sigma <= 0) { throw new ArgumentException("Sigma must be greater than 0", nameof(sigma)); } if (offset < 0 || offset > 1) { throw new ArgumentOutOfRangeException(nameof(offset), "Offset must be between 0 and 1"); } _period = period; _offset = offset; _sigma = sigma; _buffer = new RingBuffer(period); _weights = new double[period]; Name = $"Alma({period}, {offset:F2}, {sigma:F2})"; WarmupPeriod = period; ComputeWeights(_weights, period, offset, sigma, out _invWeightSum); _state = new State(double.NaN, IsInitialized: false); } public Alma(ITValuePublisher source, int period, double offset = 0.85, double sigma = 6.0) : this(period, offset, sigma) { _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 (!_disposed) { if (disposing && _source != null && _pubHandler != null) { _source.Pub -= _pubHandler; } _disposed = true; } base.Dispose(disposing); } /// /// Computes Gaussian weights for ALMA. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static void ComputeWeights(Span weights, int period, double offset, double sigma, out double invWeightSum) { double m = offset * (period - 1); double s = period / sigma; double s2 = 2 * s * s; double sum = 0; for (int i = 0; i < period; i++) { double v = i - m; double w = Math.Exp(-(v * v) / s2); 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) { _pState = _state; } else { _state = _pState; } if (double.IsFinite(input.Value)) { _state = _state with { LastValidValue = input.Value, 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); Batch(source.Values, vSpan, _period, _offset, _sigma); 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) { if (source.Length == 0) { return; } // Reset state _buffer.Clear(); _state = default; _pState = default; int warmupLength = Math.Min(source.Length, WarmupPeriod); int startIndex = source.Length - warmupLength; // Seed LastValidValue from history before warmup window double lastValid = double.NaN; for (int i = startIndex - 1; i >= 0; i--) { if (double.IsFinite(source[i])) { lastValid = source[i]; break; } } // If not found, search in warmup window if (double.IsNaN(lastValid)) { for (int i = startIndex; i < source.Length; i++) { if (double.IsFinite(source[i])) { lastValid = source[i]; break; } } } // Initialize state with seeded LastValidValue if (double.IsFinite(lastValid)) { _state = new State(lastValid, IsInitialized: true); } // Feed the warmup data for (int i = startIndex; i < source.Length; i++) { Update(new TValue(DateTime.MinValue, source[i]), isNew: true, publish: false); } _pState = _state; } [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; } public static TSeries Batch(TSeries source, int period, double offset = 0.85, double sigma = 6.0) { var alma = new Alma(period, offset, sigma); return alma.Update(source); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Batch(ReadOnlySpan source, Span output, int period, double offset = 0.85, double sigma = 6.0) { if (period <= 0) { throw new ArgumentException("Period must be greater than 0", nameof(period)); } if (sigma <= 0) { throw new ArgumentException("Sigma must be greater than 0", nameof(sigma)); } if (offset < 0 || offset > 1) { throw new ArgumentOutOfRangeException(nameof(offset), "Offset must be between 0 and 1"); } 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, offset, sigma, 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 = 0.0; // Fallback if series starts with NaN } // 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 static (TSeries Results, Alma Indicator) Calculate(TSeries source, int period, double offset = 0.85, double sigma = 6.0) { var indicator = new Alma(period, offset, sigma); TSeries results = indicator.Update(source); return (results, indicator); } public override void Reset() { _buffer.Clear(); _state = new State(double.NaN, IsInitialized: false); _pState = _state; Last = default; } }