Add TRAMA implementation and comprehensive tests

- Implemented the TRAMA (Trend Regularity Adaptive Moving Average) class with adaptive EMA logic.
- Added unit tests for TRAMA functionality, including constructor validation, basic calculations, state management, and robustness checks.
- Created validation tests to ensure consistency across different modes of operation (streaming, batch, and static calculations).
- Enhanced documentation for TRAMA, including performance profiles and quality metrics.
- Updated workspace configuration by removing unnecessary folder references.
This commit is contained in:
Miha Kralj
2026-02-21 20:45:38 -08:00
parent 90d5638008
commit 7253f61299
199 changed files with 29577 additions and 234 deletions
+156
View File
@@ -0,0 +1,156 @@
using TradingPlatform.BusinessLayer;
namespace QuanTAlib.Quantower.Tests;
public class NmaIndicatorTests
{
[Fact]
public void NmaIndicator_Constructor_SetsDefaults()
{
var indicator = new NmaIndicator();
Assert.Equal(40, indicator.Period);
Assert.Equal(SourceType.Close, indicator.Source);
Assert.True(indicator.ShowColdValues);
Assert.Equal("NMA - Natural Moving Average", indicator.Name);
Assert.False(indicator.SeparateWindow);
Assert.True(indicator.OnBackGround);
}
[Fact]
public void NmaIndicator_MinHistoryDepths_IsZero()
{
var indicator = new NmaIndicator { Period = 20 };
Assert.Equal(0, NmaIndicator.MinHistoryDepths);
Assert.Equal(0, ((IWatchlistIndicator)indicator).MinHistoryDepths);
}
[Fact]
public void NmaIndicator_ShortName_IncludesPeriodAndSource()
{
var indicator = new NmaIndicator { Period = 15 };
Assert.Contains("NMA", indicator.ShortName, StringComparison.Ordinal);
Assert.Contains("15", indicator.ShortName, StringComparison.Ordinal);
}
[Fact]
public void NmaIndicator_Initialize_CreatesInternalNma()
{
var indicator = new NmaIndicator { Period = 10 };
indicator.Initialize();
Assert.Single(indicator.LinesSeries);
}
[Fact]
public void NmaIndicator_ProcessUpdate_HistoricalBar_ComputesValue()
{
var indicator = new NmaIndicator { Period = 3 };
indicator.Initialize();
var now = DateTime.UtcNow;
for (int i = 0; i < 10; i++)
{
indicator.HistoricalData.AddBar(now.AddMinutes(i), 100, 105, 95, 102);
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.HistoricalBar));
}
Assert.True(indicator.LinesSeries[0].Count > 0);
Assert.True(double.IsFinite(indicator.LinesSeries[0].GetValue(0)));
}
[Fact]
public void NmaIndicator_ProcessUpdate_NewBar_ComputesValue()
{
var indicator = new NmaIndicator { Period = 3 };
indicator.Initialize();
var now = DateTime.UtcNow;
indicator.HistoricalData.AddBar(now, 100, 105, 95, 102);
indicator.HistoricalData.AddBar(now.AddMinutes(1), 102, 108, 100, 106);
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.HistoricalBar));
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.NewBar));
Assert.Equal(2, indicator.LinesSeries[0].Count);
}
[Fact]
public void NmaIndicator_ProcessUpdate_NewTick_ProcessesWithoutError()
{
var indicator = new NmaIndicator { Period = 3 };
indicator.Initialize();
var now = DateTime.UtcNow;
for (int i = 0; i < 50; i++)
{
indicator.HistoricalData.AddBar(now.AddMinutes(i), 100, 105, 95, 102);
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.HistoricalBar));
}
double firstValue = indicator.LinesSeries[0].GetValue(0);
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.NewTick));
double secondValue = indicator.LinesSeries[0].GetValue(0);
Assert.True(double.IsFinite(firstValue));
Assert.True(double.IsFinite(secondValue));
}
[Fact]
public void NmaIndicator_MultipleUpdates_ProducesCorrectSequence()
{
var indicator = new NmaIndicator { Period = 3 };
indicator.Initialize();
var now = DateTime.UtcNow;
double[] closes = { 100, 102, 104, 103, 105, 107, 106 };
foreach (var close in closes)
{
indicator.HistoricalData.AddBar(now, close, close + 2, close - 2, close);
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.HistoricalBar));
now = now.AddMinutes(1);
}
for (int i = 0; i < closes.Length; i++)
{
Assert.True(double.IsFinite(indicator.LinesSeries[0].GetValue(closes.Length - 1 - i)));
}
double lastNma = indicator.LinesSeries[0].GetValue(0);
Assert.True(lastNma >= 95 && lastNma <= 115);
}
[Fact]
public void NmaIndicator_DifferentSourceTypes_Work()
{
var sources = new[] { SourceType.Open, SourceType.High, SourceType.Low, SourceType.Close, SourceType.HL2, SourceType.HLC3 };
foreach (var source in sources)
{
var indicator = new NmaIndicator { Period = 3, Source = source };
indicator.Initialize();
var now = DateTime.UtcNow;
indicator.HistoricalData.AddBar(now, 100, 110, 90, 105);
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.HistoricalBar));
Assert.True(double.IsFinite(indicator.LinesSeries[0].GetValue(0)),
$"Source {source} should produce finite value");
}
}
[Fact]
public void NmaIndicator_Period_CanBeChanged()
{
var indicator = new NmaIndicator { Period = 5 };
Assert.Equal(5, indicator.Period);
indicator.Period = 20;
Assert.Equal(20, indicator.Period);
}
}
+64
View File
@@ -0,0 +1,64 @@
using System.Drawing;
using System.Runtime.CompilerServices;
using TradingPlatform.BusinessLayer;
namespace QuanTAlib;
[SkipLocalsInit]
public sealed class NmaIndicator : Indicator, IWatchlistIndicator
{
[InputParameter("Period", sortIndex: 1, 1, 1000, 1, 0)]
public int Period { get; set; } = 40;
[IndicatorExtensions.DataSourceInput]
public SourceType Source { get; set; } = SourceType.Close;
[InputParameter("Show cold values", sortIndex: 21)]
public bool ShowColdValues { get; set; } = true;
private Nma _ma = null!;
private readonly LineSeries _series;
private string _sourceName = null!;
private Func<IHistoryItem, double> _priceSelector = null!;
public static int MinHistoryDepths => 0;
int IWatchlistIndicator.MinHistoryDepths => MinHistoryDepths;
public override string ShortName => $"NMA {Period}:{_sourceName}";
public override string SourceCodeLink => "https://github.com/mihakralj/QuanTAlib/blob/main/lib/trends_IIR/nma/Nma.Quantower.cs";
public NmaIndicator()
{
OnBackGround = true;
SeparateWindow = false;
_sourceName = Source.ToString();
Name = "NMA - Natural Moving Average";
Description = "Natural Moving Average (Jim Sloman, Ocean Theory)";
_series = new LineSeries(name: $"NMA {Period}", color: IndicatorExtensions.Averages, width: 2, style: LineStyle.Solid);
AddLineSeries(_series);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected override void OnInit()
{
_ma = new Nma(Period);
_sourceName = Source.ToString();
_priceSelector = Source.GetPriceSelector();
base.OnInit();
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected override void OnUpdate(UpdateArgs args)
{
if (args.Reason != UpdateReason.NewBar && args.Reason != UpdateReason.HistoricalBar && args.Reason != UpdateReason.NewTick)
{
return;
}
var item = HistoricalData[Count - 1, SeekOriginHistory.Begin];
TValue result = _ma.Update(new TValue(item.TimeLeft.Ticks, _priceSelector(item)), args.IsNewBar());
_series.SetValue(result.Value, _ma.IsHot, ShowColdValues);
_series.SetMarker(0, Color.Transparent);
}
}
+499
View File
@@ -0,0 +1,499 @@
using Xunit;
namespace QuanTAlib.Tests;
public class NmaTests
{
private const int DefaultPeriod = 40;
private const double Tolerance = 1e-10;
private const long Seed = 12345;
private static readonly TimeSpan Step = TimeSpan.FromMinutes(1);
private static TSeries GetTestSeries(int count = 500)
{
var gbm = new GBM();
var bars = gbm.Fetch(count, Seed, Step);
return bars.Close;
}
// ── A) Constructor validation ──────────────────────────────────────
[Fact]
public void Constructor_PeriodZero_Throws()
{
var ex = Assert.Throws<ArgumentException>(() => new Nma(0));
Assert.Equal("period", ex.ParamName);
}
[Fact]
public void Constructor_PeriodNegative_Throws()
{
var ex = Assert.Throws<ArgumentException>(() => new Nma(-1));
Assert.Equal("period", ex.ParamName);
}
[Fact]
public void Constructor_PeriodOne_Valid()
{
var nma = new Nma(1);
Assert.Equal("Nma(1)", nma.Name);
}
[Fact]
public void Constructor_ValidPeriod_SetsName()
{
var nma = new Nma(DefaultPeriod);
Assert.Equal($"Nma({DefaultPeriod})", nma.Name);
}
[Fact]
public void Constructor_ValidPeriod_SetsWarmupPeriod()
{
var nma = new Nma(DefaultPeriod);
Assert.Equal(DefaultPeriod, nma.WarmupPeriod);
}
// ── B) Basic calculation ───────────────────────────────────────────
[Fact]
public void Update_FirstBar_ReturnsPrice()
{
var nma = new Nma(DefaultPeriod);
var result = nma.Update(new TValue(DateTime.UtcNow, 100.0));
Assert.Equal(100.0, result.Value);
}
[Fact]
public void Update_ReturnsFiniteValues()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries();
foreach (var tv in series)
{
var result = nma.Update(tv);
Assert.True(double.IsFinite(result.Value), $"Non-finite at {tv.Time}");
}
}
[Fact]
public void Update_Last_MatchesReturnValue()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(100);
foreach (var tv in series)
{
var result = nma.Update(tv);
Assert.Equal(result.Value, nma.Last.Value);
}
}
// ── C) State + bar correction ──────────────────────────────────────
[Fact]
public void Update_IsNewTrue_AdvancesState()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(50);
for (int i = 0; i < series.Count; i++)
{
nma.Update(series[i], isNew: true);
}
Assert.True(nma.IsHot);
}
[Fact]
public void Update_IsNewFalse_CorrectionRestores()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(100);
// Process 98 bars
for (int i = 0; i < 98; i++)
{
nma.Update(series[i]);
}
// Correction path: isNew=true then multiple isNew=false
nma.Update(new TValue(series[98].Time, series[98].Value), true);
nma.Update(new TValue(series[98].Time, series[98].Value + 0.5), false);
nma.Update(new TValue(series[98].Time, series[98].Value + 1.0), false);
var corrected = nma.Update(new TValue(series[98].Time, series[98].Value + 1.5), false);
// Clean path: same data in fresh indicator
var nma2 = new Nma(DefaultPeriod);
for (int i = 0; i < 98; i++)
{
nma2.Update(series[i]);
}
var expected = nma2.Update(new TValue(series[98].Time, series[98].Value + 1.5), true);
Assert.Equal(expected.Value, corrected.Value, 1e-9);
}
[Fact]
public void Update_IterativeCorrections_RestoresExactly()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(80);
for (int i = 0; i < series.Count - 1; i++)
{
nma.Update(series[i]);
}
// Apply new bar then 5 corrections, final correction to target value
nma.Update(series[^1]);
for (int c = 0; c < 5; c++)
{
nma.Update(new TValue(series[^1].Time, series[^1].Value * (1.0 + c * 0.01)), isNew: false);
}
var corrected = nma.Update(new TValue(series[^1].Time, series[^1].Value + 2.0), isNew: false);
// Clean path
var nma2 = new Nma(DefaultPeriod);
for (int i = 0; i < series.Count - 1; i++)
{
nma2.Update(series[i]);
}
var expected = nma2.Update(new TValue(series[^1].Time, series[^1].Value + 2.0), true);
Assert.Equal(expected.Value, corrected.Value, 1e-9);
}
[Fact]
public void Reset_ClearsState()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(100);
foreach (var tv in series)
{
nma.Update(tv);
}
nma.Reset();
Assert.False(nma.IsHot);
Assert.Equal(0, nma.Last.Value);
}
// ── D) Warmup/convergence ──────────────────────────────────────────
[Fact]
public void IsHot_FlipsAtPeriod()
{
var nma = new Nma(DefaultPeriod);
for (int i = 0; i < DefaultPeriod; i++)
{
var hot = nma.IsHot;
nma.Update(new TValue(DateTime.UtcNow.AddMinutes(i), 100.0 + i));
if (i < DefaultPeriod - 1)
{
Assert.False(hot);
}
}
Assert.True(nma.IsHot);
}
// ── E) Robustness ──────────────────────────────────────────────────
[Fact]
public void Update_NaN_UsesLastValid()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(60);
for (int i = 0; i < 50; i++)
{
nma.Update(series[i]);
}
_ = nma.Last.Value;
nma.Update(new TValue(DateTime.UtcNow, double.NaN));
double afterNaN = nma.Last.Value;
Assert.True(double.IsFinite(afterNaN));
}
[Fact]
public void Update_Infinity_UsesLastValid()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(60);
for (int i = 0; i < 50; i++)
{
nma.Update(series[i]);
}
nma.Update(new TValue(DateTime.UtcNow, double.PositiveInfinity));
Assert.True(double.IsFinite(nma.Last.Value));
}
[Fact]
public void Update_BatchNaN_AllFinite()
{
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(100);
for (int i = 0; i < series.Count; i++)
{
// Inject NaN every 10th bar after warmup
if (i > DefaultPeriod && i % 10 == 0)
{
nma.Update(new TValue(series[i].Time, double.NaN));
}
else
{
nma.Update(series[i]);
}
Assert.True(double.IsFinite(nma.Last.Value));
}
}
// ── F) Consistency (4 modes) ───────────────────────────────────────
[Fact]
public void TSeries_MatchesStreaming()
{
var series = GetTestSeries(200);
// Streaming
var streaming = new Nma(DefaultPeriod);
var streamResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
streamResults[i] = streaming.Update(series[i]).Value;
}
// Batch via TSeries
var batchResults = Nma.Batch(series, DefaultPeriod);
for (int i = 0; i < series.Count; i++)
{
Assert.Equal(streamResults[i], batchResults.Values[i], 1e-7);
}
}
[Fact]
public void Batch_Span_MatchesStreaming()
{
var series = GetTestSeries(200);
// Streaming
var streaming = new Nma(DefaultPeriod);
var streamResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
streamResults[i] = streaming.Update(series[i]).Value;
}
// Span batch
var output = new double[series.Count];
Nma.Batch(series.Values, output, DefaultPeriod);
for (int i = 0; i < series.Count; i++)
{
Assert.Equal(streamResults[i], output[i], 1e-7);
}
}
[Fact]
public void EventDriven_MatchesStreaming()
{
var series = GetTestSeries(200);
// Streaming
var streaming = new Nma(DefaultPeriod);
var streamResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
streamResults[i] = streaming.Update(series[i]).Value;
}
// Event-driven
var source = new TSeries();
var eventNma = new Nma(source, DefaultPeriod);
var eventResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
source.Add(series[i]);
eventResults[i] = eventNma.Last.Value;
}
for (int i = 0; i < series.Count; i++)
{
Assert.Equal(streamResults[i], eventResults[i], 1e-10);
}
}
// ── G) Span API tests ──────────────────────────────────────────────
[Fact]
public void Batch_Span_MismatchedLengths_Throws()
{
var src = new double[10];
var output = new double[5];
var ex = Assert.Throws<ArgumentException>(() => Nma.Batch(src, output, DefaultPeriod));
Assert.Equal("output", ex.ParamName);
}
[Fact]
public void Batch_Span_InvalidPeriod_Throws()
{
var src = new double[10];
var output = new double[10];
var ex = Assert.Throws<ArgumentException>(() => Nma.Batch(src, output, 0));
Assert.Equal("period", ex.ParamName);
}
[Fact]
public void Batch_Span_Empty_NoOp()
{
var src = ReadOnlySpan<double>.Empty;
var output = Span<double>.Empty;
Nma.Batch(src, output, DefaultPeriod);
Assert.True(true); // S2699 - verifying no exception is the assertion
}
[Fact]
public void Batch_Span_HandlesNaN()
{
var src = new double[] { 100, 101, double.NaN, 103, 104 };
var output = new double[5];
Nma.Batch(src, output, 3);
for (int i = 0; i < output.Length; i++)
{
Assert.True(double.IsFinite(output[i]));
}
}
// ── H) Chainability ────────────────────────────────────────────────
[Fact]
public void PubSub_FiresEvents()
{
var source = new TSeries();
var nma = new Nma(source, DefaultPeriod);
int eventCount = 0;
nma.Pub += (object? _, in TValueEventArgs e) => eventCount++;
for (int i = 0; i < 10; i++)
{
source.Add(new TValue(DateTime.UtcNow.AddMinutes(i), 100.0 + i));
}
Assert.Equal(10, eventCount);
}
[Fact]
public void Dispose_UnsubscribesFromSource()
{
var source = new TSeries();
var nma = new Nma(source, DefaultPeriod);
nma.Dispose();
// Adding to source should not affect disposed nma
source.Add(new TValue(DateTime.UtcNow, 100.0));
Assert.Equal(0, nma.Last.Value);
}
// ── Additional behavior tests ──────────────────────────────────────
[Fact]
public void ConstantInput_ConvergesToConstant()
{
var nma = new Nma(DefaultPeriod);
double constant = 50.0;
for (int i = 0; i < 200; i++)
{
nma.Update(new TValue(DateTime.UtcNow.AddMinutes(i), constant));
}
Assert.Equal(constant, nma.Last.Value, 1e-6);
}
[Fact]
public void MonotonicInput_TracksTrend()
{
var nma = new Nma(14);
double lastNma = 0;
for (int i = 0; i < 100; i++)
{
double price = 100.0 + i;
lastNma = nma.Update(new TValue(DateTime.UtcNow.AddMinutes(i), price)).Value;
}
// NMA should be between first and last price in a monotonic series
Assert.True(lastNma > 100.0);
Assert.True(lastNma < 200.0);
}
[Fact]
public void Ratio_BoundedZeroOne()
{
// The ratio should conceptually be in [0,1] range
// We verify indirectly: NMA should always be between min and max of input
var nma = new Nma(DefaultPeriod);
var series = GetTestSeries(200);
double minPrice = double.MaxValue;
double maxPrice = double.MinValue;
for (int i = 0; i < series.Count; i++)
{
nma.Update(series[i]);
if (series[i].Value < minPrice)
{
minPrice = series[i].Value;
}
if (series[i].Value > maxPrice)
{
maxPrice = series[i].Value;
}
}
// NMA value should be within the range of input data (with some tolerance)
Assert.True(nma.Last.Value >= minPrice * 0.99);
Assert.True(nma.Last.Value <= maxPrice * 1.01);
}
[Theory]
[InlineData(5)]
[InlineData(14)]
[InlineData(40)]
[InlineData(100)]
public void DifferentPeriods_AllValid(int period)
{
var nma = new Nma(period);
var series = GetTestSeries(200);
foreach (var tv in series)
{
var result = nma.Update(tv);
Assert.True(double.IsFinite(result.Value));
}
}
[Fact]
public void Calculate_ReturnsBothResultsAndIndicator()
{
var series = GetTestSeries(100);
var (results, indicator) = Nma.Calculate(series, DefaultPeriod);
Assert.Equal(series.Count, results.Count);
Assert.True(indicator.IsHot);
}
[Fact]
public void Prime_SetsState()
{
var series = GetTestSeries(100);
var nma = new Nma(DefaultPeriod);
nma.Prime(series.Values);
Assert.True(nma.IsHot);
Assert.True(double.IsFinite(nma.Last.Value));
}
}
+200
View File
@@ -0,0 +1,200 @@
using Xunit;
namespace QuanTAlib.Tests;
/// <summary>
/// Self-consistency validation for NMA. No external library supports NMA,
/// so we validate internal consistency: streaming==batch==span, ratio bounds,
/// regime detection, and determinism.
/// </summary>
public class NmaValidationTests
{
private const long Seed = 12345;
private static readonly TimeSpan Step = TimeSpan.FromMinutes(1);
private static TSeries GetTestSeries(int count = 500)
{
var gbm = new GBM();
var bars = gbm.Fetch(count, Seed, Step);
return bars.Close;
}
[Fact]
public void StreamingEqualsBatch_DefaultPeriod()
{
var series = GetTestSeries(500);
int period = 40;
// Streaming
var streaming = new Nma(period);
var streamResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
streamResults[i] = streaming.Update(series[i]).Value;
}
// Batch (span)
var batchResults = new double[series.Count];
Nma.Batch(series.Values, batchResults, period);
for (int i = 0; i < series.Count; i++)
{
Assert.Equal(streamResults[i], batchResults[i], 1e-7);
}
}
[Fact]
public void StreamingEqualsTSeries()
{
var series = GetTestSeries(500);
int period = 40;
// Streaming
var streaming = new Nma(period);
var streamResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
streamResults[i] = streaming.Update(series[i]).Value;
}
// TSeries batch
var batchSeries = Nma.Batch(series, period);
for (int i = 0; i < series.Count; i++)
{
Assert.Equal(streamResults[i], batchSeries.Values[i], 1e-7);
}
}
[Theory]
[InlineData(5)]
[InlineData(14)]
[InlineData(40)]
[InlineData(80)]
public void ConsistencyAcrossPeriods(int period)
{
var series = GetTestSeries(300);
// Streaming
var streaming = new Nma(period);
var streamResults = new double[series.Count];
for (int i = 0; i < series.Count; i++)
{
streamResults[i] = streaming.Update(series[i]).Value;
}
// Batch
var batchResults = new double[series.Count];
Nma.Batch(series.Values, batchResults, period);
for (int i = 0; i < series.Count; i++)
{
Assert.Equal(streamResults[i], batchResults[i], 1e-7);
}
}
[Fact]
public void ConstantInput_NmaEqualsConstant()
{
double constant = 100.0;
int period = 40;
int count = 200;
var nma = new Nma(period);
for (int i = 0; i < count; i++)
{
nma.Update(new TValue(DateTime.UtcNow.AddMinutes(i), constant));
}
// For constant input, volatility is 0 everywhere → ratio = 0
// But first bar seeds NMA = constant, so it should stay constant
Assert.Equal(constant, nma.Last.Value, 1e-8);
}
[Fact]
public void MonotonicRising_NmaFollowsGradually()
{
int period = 14;
var nma = new Nma(period);
double lastNma = 0;
for (int i = 0; i < 100; i++)
{
double price = 100.0 + i * 0.5;
lastNma = nma.Update(new TValue(DateTime.UtcNow.AddMinutes(i), price)).Value;
}
// NMA should lag behind the linearly rising price
Assert.True(lastNma > 100.0, "NMA should rise");
Assert.True(lastNma < 150.0, "NMA should lag behind final price");
}
[Fact]
public void DeterministicOutput()
{
var series = GetTestSeries(200);
int period = 40;
var nma1 = new Nma(period);
var nma2 = new Nma(period);
for (int i = 0; i < series.Count; i++)
{
var r1 = nma1.Update(series[i]);
var r2 = nma2.Update(series[i]);
Assert.Equal(r1.Value, r2.Value, 1e-15);
}
}
[Fact]
public void OutputBounded_WithinInputRange()
{
var series = GetTestSeries(500);
int period = 40;
var nma = new Nma(period);
double minInput = double.MaxValue;
double maxInput = double.MinValue;
for (int i = 0; i < series.Count; i++)
{
nma.Update(series[i]);
if (series[i].Value < minInput)
{
minInput = series[i].Value;
}
if (series[i].Value > maxInput)
{
maxInput = series[i].Value;
}
}
// NMA should stay within input range (with small tolerance for FP)
Assert.True(nma.Last.Value >= minInput * 0.99);
Assert.True(nma.Last.Value <= maxInput * 1.01);
}
[Fact]
public void SmallPeriod_MoreResponsive()
{
var series = GetTestSeries(200);
var nmaFast = new Nma(5);
var nmaSlow = new Nma(80);
double sumAbsDiffFast = 0;
double sumAbsDiffSlow = 0;
for (int i = 0; i < series.Count; i++)
{
var fast = nmaFast.Update(series[i]).Value;
var slow = nmaSlow.Update(series[i]).Value;
sumAbsDiffFast += Math.Abs(fast - series[i].Value);
sumAbsDiffSlow += Math.Abs(slow - series[i].Value);
}
// Faster NMA (smaller period) should track price more closely
Assert.True(sumAbsDiffFast < sumAbsDiffSlow,
$"Fast NMA avg deviation ({sumAbsDiffFast / series.Count:F4}) should be less than slow ({sumAbsDiffSlow / series.Count:F4})");
}
}
+389
View File
@@ -0,0 +1,389 @@
using System.Buffers;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
namespace QuanTAlib;
/// <summary>
/// NMA: Natural Moving Average (Jim Sloman, Ocean Theory)
/// </summary>
/// <remarks>
/// Adaptive IIR filter where smoothing ratio derives from volatility-weighted
/// sqrt-kernel analysis of log-price movements over a lookback window.
///
/// Calculation: <c>ratio = Σ(oi × (√(i+1) - √i)) / Σ(oi); NMA = NMA[1] + ratio × (src - NMA[1])</c>.
/// </remarks>
/// <seealso href="Nma.md">Detailed documentation</seealso>
/// <seealso href="nma.pine">Reference Pine Script implementation</seealso>
[SkipLocalsInit]
public sealed class Nma : AbstractBase
{
private readonly int _period;
private readonly RingBuffer _lnBuf;
private readonly RingBuffer _p_lnBuf;
private readonly double[] _sqrtWeights;
private readonly ITValuePublisher? _source;
private readonly TValuePublishedHandler? _pubHandler;
private bool _isNew = true;
private bool _disposed;
[StructLayout(LayoutKind.Auto)]
private record struct State(
double LastNma, double CurrentNma,
bool IsInitialized, int BarCount
);
private State _state;
private State _p_state;
public Nma(int period)
{
if (period < 1)
{
throw new ArgumentException("Period must be greater than 0", nameof(period));
}
_period = period;
_lnBuf = new RingBuffer(period + 1);
_p_lnBuf = new RingBuffer(period + 1);
Name = $"Nma({period})";
WarmupPeriod = period;
// Precompute sqrt-kernel weights: phi[i] = sqrt(i+1) - sqrt(i)
_sqrtWeights = new double[period];
for (int i = 0; i < period; i++)
{
_sqrtWeights[i] = Math.Sqrt(i + 1) - Math.Sqrt(i);
}
InitState();
}
public Nma(ITValuePublisher source, int period) : this(period)
{
_source = source;
_pubHandler = Handle;
source.Pub += _pubHandler;
}
protected override void Dispose(bool disposing)
{
if (!_disposed)
{
if (disposing && _source != null && _pubHandler != null)
{
_source.Pub -= _pubHandler;
}
_disposed = true;
}
base.Dispose(disposing);
}
private void Handle(object? sender, in TValueEventArgs e) => Update(e.Value, e.IsNew);
public bool IsNew => _isNew;
public override bool IsHot => _state.BarCount >= _period;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override TValue Update(TValue input, bool isNew = true)
{
_isNew = isNew;
// CopyFrom pattern: ComputeRatio() reads all buffer positions,
// so Snapshot/Restore (single-value) is insufficient — full copy required
if (isNew)
{
_p_state = _state;
_p_lnBuf.CopyFrom(_lnBuf);
}
else
{
_state = _p_state;
_lnBuf.CopyFrom(_p_lnBuf);
}
_state.BarCount++;
if (_state.IsInitialized)
{
_state.LastNma = _state.CurrentNma;
}
double price = input.Value;
if (!double.IsFinite(price))
{
if (!_state.IsInitialized)
{
return input;
}
price = Math.Exp(_lnBuf.Newest / 1000.0);
}
// Store scaled natural log — always Add() since CopyFrom restores pre-Add state
double lnVal = price > 0 ? Math.Log(price) * 1000.0 : 0.0;
_ = _lnBuf.Add(lnVal);
if (_state.BarCount <= 1)
{
_state.LastNma = price;
_state.CurrentNma = price;
_state.IsInitialized = true;
Last = new TValue(input.Time, price);
PubEvent(Last);
return Last;
}
// Compute volatility-weighted sqrt ratio
double ratio = ComputeRatio();
// Adaptive EMA: NMA = prev + ratio * (price - prev) = FMA(prev, 1-ratio, ratio*price)
double decay = 1.0 - ratio;
_state.CurrentNma = Math.FusedMultiplyAdd(_state.LastNma, decay, ratio * price);
Last = new TValue(input.Time, _state.CurrentNma);
PubEvent(Last);
return Last;
}
public override TSeries Update(TSeries source)
{
if (source.Count == 0)
{
return [];
}
int len = source.Count;
var t = new List<long>(len);
var v = new List<double>(len);
CollectionsMarshal.SetCount(t, len);
CollectionsMarshal.SetCount(v, len);
var tSpan = CollectionsMarshal.AsSpan(t);
var vSpan = CollectionsMarshal.AsSpan(v);
Batch(source.Values, vSpan, _period);
source.Times.CopyTo(tSpan);
// Replay last _period bars to restore internal state
Reset();
int start = 0;
if (len > 2 * _period)
{
start = len - _period;
}
for (int i = start; i < len; i++)
{
Update(new TValue(source.Times[i], source.Values[i]));
}
return new TSeries(t, v);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private double ComputeRatio()
{
int bars = Math.Min(_state.BarCount, _period);
double num = 0;
double denom = 0;
// Walk backward through the log-price buffer
// i=0 is most recent pair, i=bars-1 is oldest pair
int bufCount = _lnBuf.Count;
for (int i = 0; i < bars; i++)
{
// Current and previous log-price values
int idx0 = bufCount - 1 - i;
int idx1 = bufCount - 2 - i;
if (idx1 < 0)
{
break;
}
double oi = Math.Abs(_lnBuf[idx0] - _lnBuf[idx1]);
num += oi * _sqrtWeights[i];
denom += oi;
}
return denom > 0 ? num / denom : 0;
}
public override void Prime(ReadOnlySpan<double> source, TimeSpan? step = null)
{
if (source.Length == 0)
{
return;
}
Reset();
for (int i = 0; i < source.Length; i++)
{
double price = source[i];
if (!double.IsFinite(price) && _state.IsInitialized)
{
price = Math.Exp(_lnBuf.Newest / 1000.0);
}
double lnVal = price > 0 ? Math.Log(price) * 1000.0 : 0.0;
_lnBuf.Add(lnVal);
_state.BarCount++;
if (_state.BarCount <= 1)
{
_state.LastNma = price;
_state.CurrentNma = price;
_state.IsInitialized = true;
continue;
}
// Compute ratio inline for Prime
int bars = Math.Min(_state.BarCount, _period);
double num = 0;
double denom = 0;
int bufCount = _lnBuf.Count;
for (int j = 0; j < bars; j++)
{
int idx0 = bufCount - 1 - j;
int idx1 = bufCount - 2 - j;
if (idx1 < 0)
{
break;
}
double oi = Math.Abs(_lnBuf[idx0] - _lnBuf[idx1]);
num += oi * _sqrtWeights[j];
denom += oi;
}
double ratio = denom > 0 ? num / denom : 0;
double decay = 1.0 - ratio;
double nma = Math.FusedMultiplyAdd(_state.LastNma, decay, ratio * price);
_state.LastNma = nma;
_state.CurrentNma = nma;
}
Last = new TValue(DateTime.MinValue, _state.CurrentNma);
_p_state = _state;
}
public override void Reset()
{
_lnBuf.Clear();
_p_lnBuf.Clear();
InitState();
_p_state = _state;
Last = default;
}
private void InitState()
{
_state = new State(
LastNma: double.NaN,
CurrentNma: double.NaN,
IsInitialized: false,
BarCount: 0
);
}
public static TSeries Batch(TSeries source, int period)
{
var nma = new Nma(period);
return nma.Update(source);
}
public static void Batch(ReadOnlySpan<double> source, Span<double> output, int period)
{
if (period < 1)
{
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));
}
if (source.Length == 0)
{
return;
}
// Precompute sqrt weights
double[] sqrtW = ArrayPool<double>.Shared.Rent(period);
for (int i = 0; i < period; i++)
{
sqrtW[i] = Math.Sqrt(i + 1) - Math.Sqrt(i);
}
// Circular buffer for log-prices (size period+1)
int bufSize = period + 1;
double[] lnBuf = ArrayPool<double>.Shared.Rent(bufSize);
Array.Clear(lnBuf, 0, bufSize);
try
{
int head = 0;
int count = 0;
double lastNma = source[0];
// Seed first value
double lnVal = source[0] > 0 ? Math.Log(source[0]) * 1000.0 : 0.0;
lnBuf[head] = lnVal;
head = (head + 1) % bufSize;
count = 1;
output[0] = source[0];
for (int i = 1; i < source.Length; i++)
{
double price = source[i];
if (!double.IsFinite(price))
{
price = source[i - 1];
}
lnVal = price > 0 ? Math.Log(price) * 1000.0 : 0.0;
lnBuf[head] = lnVal;
head = (head + 1) % bufSize;
if (count < bufSize)
{
count++;
}
// Compute volatility-weighted sqrt ratio
int bars = Math.Min(i + 1, period);
if (bars > count - 1)
{
bars = count - 1;
}
double num = 0;
double denom = 0;
for (int j = 0; j < bars; j++)
{
int idx0 = ((head - 1 - j) % bufSize + bufSize) % bufSize;
int idx1 = ((head - 2 - j) % bufSize + bufSize) % bufSize;
double oi = Math.Abs(lnBuf[idx0] - lnBuf[idx1]);
num += oi * sqrtW[j];
denom += oi;
}
double ratio = denom > 0 ? num / denom : 0;
// Adaptive EMA
double decay = 1.0 - ratio;
double nma = Math.FusedMultiplyAdd(lastNma, decay, ratio * price);
output[i] = nma;
lastNma = nma;
}
}
finally
{
ArrayPool<double>.Shared.Return(sqrtW);
ArrayPool<double>.Shared.Return(lnBuf);
}
}
public static (TSeries Results, Nma Indicator) Calculate(TSeries source, int period)
{
var indicator = new Nma(period);
TSeries results = indicator.Update(source);
return (results, indicator);
}
}
+84
View File
@@ -101,6 +101,90 @@ ratio = denom != 0 ? num/denom : 0
result = result + ratio * (src - result)
```
## Performance Profile
### Operation Count (Streaming Mode)
| Operation | Count per Update | Notes |
|-----------|-----------------|-------|
| Log | 1 | `Math.Log(price)` |
| Abs | $N$ | `|lnBuf[i] - lnBuf[i+1]|` per lookback step |
| Multiply | $N$ | $o_i \times \phi_i$ |
| Add | $2N + 1$ | Numerator sum + denominator sum + EMA step |
| Divide | 1 | `num / denom` |
| FMA | 1 | `FusedMultiplyAdd(prev, decay, ratio * price)` |
| **Total** | $\approx 4N + 4$ | $N = \text{period}$ |
For `period = 40`: approximately 164 FLOPs per streaming update.
### Batch Mode (SIMD Analysis)
The inner `ComputeRatio()` loop walks backward through the ring buffer with data-dependent indexing, which resists SIMD vectorization. The batch `Calculate(Span)` method uses the same scalar loop per bar.
SIMD opportunity exists for the sqrt-weight precomputation (done once in the constructor), but not for the per-bar ratio computation due to the sequential buffer access pattern.
| Metric | Score |
|--------|-------|
| Streaming latency | 8/10 (O(N) per bar, but small constant) |
| Batch throughput | 5/10 (O(N*M) total, no SIMD in hot loop) |
| Memory efficiency | 9/10 (single RingBuffer + precomputed weights) |
| Warmup speed | 9/10 (hot after N bars) |
| Numerical stability | 7/10 (log-scale amplifies FP drift in corrections; mitigated by CopyFrom pattern) |
### Memory Layout
| Field | Type | Size | Purpose |
|-------|------|------|---------|
| `_lnBuf` | RingBuffer | ~40B + (N+1)x8B | Circular log-price buffer |
| `_p_lnBuf` | RingBuffer | ~40B + (N+1)x8B | Backup buffer for bar correction |
| `_sqrtWeights` | double[] | Nx8B | Precomputed $\sqrt{i+1} - \sqrt{i}$ |
| `_state` | State | 32B | Current NMA, last NMA, bar count, flags |
| `_p_state` | State | 32B | Previous state for rollback |
| **Total** | | ~144B + 3Nx8B | |
For `period = 40`: approximately 144 + 984 = **1128 bytes** per instance.
### Bar Correction Pattern
NMA requires full buffer copy (`CopyFrom`) for bar correction rather than the lighter `Snapshot`/`Restore` used by simpler indicators. The reason: `ComputeRatio()` reads all buffer positions during backward traversal, so a single-value restore is insufficient.
```csharp
if (isNew) { _p_state = _state; _p_lnBuf.CopyFrom(_lnBuf); }
else { _state = _p_state; _lnBuf.CopyFrom(_p_lnBuf); }
_ = _lnBuf.Add(lnVal); // always Add() since CopyFrom restores pre-Add state
```
## Validation
| Library | Batch | Streaming | Span | Notes |
|---------|-------|-----------|------|-------|
| Skender | N/A | N/A | N/A | Not available |
| TA-Lib | N/A | N/A | N/A | Not available |
| Tulip | N/A | N/A | N/A | Not available |
| Ooples | N/A | N/A | N/A | Not available |
NMA is a proprietary indicator from Sloman's *Ocean Theory*. No reference implementations exist in standard TA libraries. Validation relies on:
- Internal consistency: batch == streaming == span == eventing (4-mode consistency test)
- Mathematical verification: ratio bounds $[1/\sqrt{N}, 1]$ confirmed
- Edge cases: NaN/Infinity handling, bar correction precision
## Common Pitfalls
1. **Log of non-positive prices**: If `price <= 0`, `Math.Log` returns `-Infinity` or `NaN`. The implementation guards with `price > 0 ? Math.Log(price) * 1000 : 0.0`.
2. **Bar correction drift with Snapshot/Restore**: RingBuffer's `Snapshot()`/`Restore()` only saves one buffer position. NMA's `ComputeRatio()` reads ALL positions, so `CopyFrom()` is mandatory. Using Snapshot/Restore produces ~1% drift after corrections.
3. **Zero denominator in ratio**: When all adjacent log-prices are identical ($o_i = 0$ for all $i$), the denominator is zero. The implementation returns `ratio = 0`, causing NMA to hold its previous value.
4. **Period = 1 degeneracy**: With a single-bar lookback, `ComputeRatio()` has zero iterations and returns 0. NMA becomes a constant after initialization. Use `period >= 2` for meaningful adaptation.
5. **Log-scale amplification**: The $\times 1000$ scaling factor amplifies differences between log-prices. While this improves numerical resolution for the ratio computation, it also amplifies floating-point errors during buffer operations.
6. **Memory cost of CopyFrom**: Each bar correction copies the entire buffer array ($N+1$ doubles = 328 bytes for period 40). This is ~8x more expensive than Snapshot/Restore but necessary for correctness.
7. **No external validation available**: Unlike SMA, EMA, or KAMA, there are no reference implementations to validate against. All correctness assurance comes from internal consistency tests and mathematical bound verification.
## Resources
- Sloman, J. *Ocean Theory*. Pages 63-70. (Original NMA description.)