mirror of
https://github.com/mihakralj/QuanTAlib.git
synced 2026-08-22 12:38:06 +00:00
Add Stochastic Oscillator implementation and validation tests
- Implemented Stochastic Oscillator (%K and %D) in Stoch.cs with streaming and batch processing capabilities. - Added validation tests for the Stochastic Oscillator in Stoch.Validation.Tests.cs, ensuring consistency with Skender.Stock.Indicators. - Created documentation for the Stochastic Oscillator in Stoch.md, detailing its mathematical formula, architecture, parameters, and common pitfalls. - Updated project file to include necessary numeric libraries for highest and lowest calculations.
This commit is contained in:
@@ -0,0 +1,111 @@
|
||||
using TradingPlatform.BusinessLayer;
|
||||
using QuanTAlib;
|
||||
|
||||
namespace QuanTAlib.Tests;
|
||||
|
||||
public sealed class DpoIndicatorTests
|
||||
{
|
||||
[Fact]
|
||||
public void DpoIndicator_Constructor_SetsDefaults()
|
||||
{
|
||||
var indicator = new DpoIndicator();
|
||||
|
||||
Assert.Equal(20, indicator.Period);
|
||||
Assert.Equal(SourceType.Close, indicator.Source);
|
||||
Assert.True(indicator.ShowColdValues);
|
||||
Assert.Equal("DPO - Detrended Price Oscillator", indicator.Name);
|
||||
Assert.True(indicator.SeparateWindow);
|
||||
Assert.True(indicator.OnBackGround);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_MinHistoryDepths_EqualsZero()
|
||||
{
|
||||
var indicator = new DpoIndicator { Period = 20 };
|
||||
|
||||
Assert.Equal(0, DpoIndicator.MinHistoryDepths);
|
||||
IWatchlistIndicator watchlistIndicator = indicator;
|
||||
Assert.Equal(0, watchlistIndicator.MinHistoryDepths);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_ShortName_IncludesParameters()
|
||||
{
|
||||
var indicator = new DpoIndicator { Period = 10 };
|
||||
indicator.Initialize();
|
||||
|
||||
Assert.Contains("DPO", indicator.ShortName, StringComparison.Ordinal);
|
||||
Assert.Contains("10", indicator.ShortName, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_SourceCodeLink_IsValid()
|
||||
{
|
||||
var indicator = new DpoIndicator();
|
||||
|
||||
Assert.Contains("github.com", indicator.SourceCodeLink, StringComparison.Ordinal);
|
||||
Assert.Contains("Dpo.Quantower.cs", indicator.SourceCodeLink, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_Initialize_CreatesInternalDpo()
|
||||
{
|
||||
var indicator = new DpoIndicator { Period = 10 };
|
||||
|
||||
indicator.Initialize();
|
||||
|
||||
Assert.Single(indicator.LinesSeries);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_ProcessUpdate_HistoricalBar_ComputesValue()
|
||||
{
|
||||
var indicator = new DpoIndicator { Period = 5 };
|
||||
indicator.Initialize();
|
||||
|
||||
var now = DateTime.UtcNow;
|
||||
for (int i = 0; i < 20; i++)
|
||||
{
|
||||
indicator.HistoricalData.AddBar(now.AddMinutes(i), 100 + i, 110 + i, 90 + i, 105 + i);
|
||||
|
||||
var args = new UpdateArgs(UpdateReason.HistoricalBar);
|
||||
indicator.ProcessUpdate(args);
|
||||
}
|
||||
|
||||
double value = indicator.LinesSeries[0].GetValue(0);
|
||||
Assert.True(double.IsFinite(value));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_ProcessUpdate_NewBar_ComputesValue()
|
||||
{
|
||||
var indicator = new DpoIndicator { Period = 5 };
|
||||
indicator.Initialize();
|
||||
|
||||
var now = DateTime.UtcNow;
|
||||
for (int i = 0; i < 20; i++)
|
||||
{
|
||||
indicator.HistoricalData.AddBar(now.AddMinutes(i), 100 + i, 110 + i, 90 + i, 105 + i);
|
||||
}
|
||||
|
||||
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.HistoricalBar));
|
||||
|
||||
indicator.HistoricalData.AddBar(now.AddMinutes(20), 120, 130, 110, 125);
|
||||
indicator.ProcessUpdate(new UpdateArgs(UpdateReason.NewBar));
|
||||
|
||||
Assert.Equal(2, indicator.LinesSeries[0].Count);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DpoIndicator_Parameters_CanBeChanged()
|
||||
{
|
||||
var indicator = new DpoIndicator { Period = 20 };
|
||||
|
||||
indicator.Period = 10;
|
||||
indicator.Source = SourceType.Open;
|
||||
|
||||
Assert.Equal(10, indicator.Period);
|
||||
Assert.Equal(SourceType.Open, indicator.Source);
|
||||
Assert.Equal(0, DpoIndicator.MinHistoryDepths);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
using System.Drawing;
|
||||
using System.Runtime.CompilerServices;
|
||||
using TradingPlatform.BusinessLayer;
|
||||
|
||||
namespace QuanTAlib;
|
||||
|
||||
[SkipLocalsInit]
|
||||
public sealed class DpoIndicator : Indicator, IWatchlistIndicator
|
||||
{
|
||||
[InputParameter("Period", sortIndex: 1, 1, 1000, 1, 0)]
|
||||
public int Period { get; set; } = 20;
|
||||
|
||||
[IndicatorExtensions.DataSourceInput(sortIndex: 2)]
|
||||
public SourceType Source { get; set; } = SourceType.Close;
|
||||
|
||||
[InputParameter("Show cold values", sortIndex: 21)]
|
||||
public bool ShowColdValues { get; set; } = true;
|
||||
|
||||
private Dpo _dpo = null!;
|
||||
private readonly LineSeries _series;
|
||||
|
||||
public static int MinHistoryDepths => 0;
|
||||
int IWatchlistIndicator.MinHistoryDepths => MinHistoryDepths;
|
||||
|
||||
public override string ShortName => $"DPO ({Period})";
|
||||
public override string SourceCodeLink => "https://github.com/mihakralj/QuanTAlib/blob/main/lib/oscillators/dpo/Dpo.Quantower.cs";
|
||||
|
||||
public DpoIndicator()
|
||||
{
|
||||
OnBackGround = true;
|
||||
SeparateWindow = true;
|
||||
Name = "DPO - Detrended Price Oscillator";
|
||||
Description = "Removes trend from price by comparing current price to a displaced SMA";
|
||||
|
||||
_series = new LineSeries("DPO", Color.Yellow, 2, LineStyle.Solid);
|
||||
AddLineSeries(_series);
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
protected override void OnInit()
|
||||
{
|
||||
_dpo = new Dpo(Period);
|
||||
base.OnInit();
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
protected override void OnUpdate(UpdateArgs args)
|
||||
{
|
||||
var priceSelector = Source.GetPriceSelector();
|
||||
var item = HistoricalData[0, SeekOriginHistory.End];
|
||||
double price = priceSelector(item);
|
||||
|
||||
TValue input = new(item.TimeLeft, price);
|
||||
TValue result = _dpo.Update(input, args.IsNewBar());
|
||||
|
||||
if (!_dpo.IsHot && !ShowColdValues)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_series.SetValue(result.Value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,396 @@
|
||||
using Xunit;
|
||||
|
||||
namespace QuanTAlib.Tests;
|
||||
|
||||
public sealed class DpoTests
|
||||
{
|
||||
private const int DefaultPeriod = 20;
|
||||
private const double Tolerance = 1e-10;
|
||||
|
||||
// ───── A) Constructor validation ─────
|
||||
|
||||
[Fact]
|
||||
public void Constructor_PeriodZero_ThrowsArgumentException()
|
||||
{
|
||||
var ex = Assert.Throws<ArgumentException>(() => new Dpo(period: 0));
|
||||
Assert.Equal("period", ex.ParamName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Constructor_NegativePeriod_ThrowsArgumentException()
|
||||
{
|
||||
var ex = Assert.Throws<ArgumentException>(() => new Dpo(period: -1));
|
||||
Assert.Equal("period", ex.ParamName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Constructor_ValidPeriod_SetsProperties()
|
||||
{
|
||||
var dpo = new Dpo(period: 10);
|
||||
Assert.Equal(10, dpo.Period);
|
||||
Assert.Equal("Dpo(10)", dpo.Name);
|
||||
int expectedDisplacement = (10 / 2) + 1;
|
||||
Assert.Equal(expectedDisplacement, dpo.Displacement);
|
||||
Assert.Equal(10 + expectedDisplacement, dpo.WarmupPeriod);
|
||||
}
|
||||
|
||||
// ───── B) Basic calculation ─────
|
||||
|
||||
[Fact]
|
||||
public void Update_ReturnsTValue()
|
||||
{
|
||||
var dpo = new Dpo(DefaultPeriod);
|
||||
var result = dpo.Update(new TValue(DateTime.UtcNow, 100.0));
|
||||
Assert.IsType<TValue>(result);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Update_Last_IsAccessible()
|
||||
{
|
||||
var dpo = new Dpo(DefaultPeriod);
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0));
|
||||
Assert.NotEqual(default, dpo.Last);
|
||||
Assert.False(dpo.IsHot);
|
||||
Assert.Equal($"Dpo({DefaultPeriod})", dpo.Name);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Update_ConstantInput_ZeroDpo()
|
||||
{
|
||||
var dpo = new Dpo(period: 5);
|
||||
int warmup = 5 + (5 / 2) + 1; // period + displacement
|
||||
for (int i = 0; i < warmup + 5; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 50.0));
|
||||
}
|
||||
// Constant input => SMA == source => DPO == 0
|
||||
Assert.Equal(0.0, dpo.Last.Value, Tolerance);
|
||||
}
|
||||
|
||||
// ───── C) State + bar correction ─────
|
||||
|
||||
[Fact]
|
||||
public void Update_IsNew_True_AdvancesState()
|
||||
{
|
||||
var dpo = new Dpo(DefaultPeriod);
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0), isNew: true);
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 110.0), isNew: true);
|
||||
|
||||
var last = dpo.Last;
|
||||
Assert.NotEqual(default, last);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Update_IsNew_False_RollsBack()
|
||||
{
|
||||
var dpo = new Dpo(period: 5);
|
||||
int warmup = 5 + (5 / 2) + 1;
|
||||
for (int i = 0; i < warmup + 2; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0 + i), isNew: true);
|
||||
}
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 105.0), isNew: false);
|
||||
var corrected = dpo.Last;
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 105.0), isNew: false);
|
||||
var corrected2 = dpo.Last;
|
||||
|
||||
Assert.Equal(corrected.Value, corrected2.Value, Tolerance);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Update_IterativeCorrections_Restore()
|
||||
{
|
||||
var dpo = new Dpo(period: 5);
|
||||
int warmup = 5 + (5 / 2) + 1;
|
||||
double[] data = new double[warmup + 3];
|
||||
for (int i = 0; i < data.Length; i++)
|
||||
{
|
||||
data[i] = 100 + i * 2;
|
||||
}
|
||||
|
||||
for (int i = 0; i < data.Length; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, data[i]), isNew: true);
|
||||
}
|
||||
|
||||
var baseline = dpo.Last.Value;
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 999.0), isNew: false);
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 888.0), isNew: false);
|
||||
dpo.Update(new TValue(DateTime.UtcNow, data[^1]), isNew: false);
|
||||
|
||||
Assert.Equal(baseline, dpo.Last.Value, Tolerance);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Reset_ClearsState()
|
||||
{
|
||||
var dpo = new Dpo(DefaultPeriod);
|
||||
for (int i = 0; i < 40; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0 + i));
|
||||
}
|
||||
Assert.True(dpo.IsHot);
|
||||
|
||||
dpo.Reset();
|
||||
Assert.False(dpo.IsHot);
|
||||
Assert.Equal(default, dpo.Last);
|
||||
}
|
||||
|
||||
// ───── D) Warmup / convergence ─────
|
||||
|
||||
[Fact]
|
||||
public void IsHot_FlipsAtWarmupPeriod()
|
||||
{
|
||||
int period = 5;
|
||||
int displacement = (period / 2) + 1; // 3
|
||||
int warmup = period + displacement; // 8
|
||||
var dpo = new Dpo(period);
|
||||
|
||||
for (int i = 0; i < warmup - 1; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0 + i));
|
||||
Assert.False(dpo.IsHot, $"Should not be hot at bar {i + 1}");
|
||||
}
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 108.0));
|
||||
Assert.True(dpo.IsHot);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void WarmupPeriod_MatchesPeriodPlusDisplacement()
|
||||
{
|
||||
var dpo = new Dpo(period: 20);
|
||||
Assert.Equal(20 + (20 / 2) + 1, dpo.WarmupPeriod);
|
||||
}
|
||||
|
||||
// ───── E) Robustness ─────
|
||||
|
||||
[Fact]
|
||||
public void Update_NaN_UsesLastValid()
|
||||
{
|
||||
var dpo = new Dpo(period: 5);
|
||||
int warmup = 5 + (5 / 2) + 1;
|
||||
for (int i = 0; i < warmup + 2; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0 + i));
|
||||
}
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, double.NaN));
|
||||
Assert.True(double.IsFinite(dpo.Last.Value));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Update_Infinity_UsesLastValid()
|
||||
{
|
||||
var dpo = new Dpo(period: 5);
|
||||
int warmup = 5 + (5 / 2) + 1;
|
||||
for (int i = 0; i < warmup + 2; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0 + i));
|
||||
}
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, double.PositiveInfinity));
|
||||
Assert.True(double.IsFinite(dpo.Last.Value));
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, double.NegativeInfinity));
|
||||
Assert.True(double.IsFinite(dpo.Last.Value));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Update_BatchNaN_Safe()
|
||||
{
|
||||
var dpo = new Dpo(period: 5);
|
||||
for (int i = 0; i < 3; i++)
|
||||
{
|
||||
dpo.Update(new TValue(DateTime.UtcNow, double.NaN));
|
||||
}
|
||||
Assert.True(double.IsFinite(dpo.Last.Value));
|
||||
}
|
||||
|
||||
// ───── F) Consistency (4 modes match) ─────
|
||||
|
||||
[Fact]
|
||||
public void AllModes_ProduceSameResults()
|
||||
{
|
||||
int period = 10;
|
||||
var gbm = new GBM(startPrice: 100.0, mu: 0.02, sigma: 0.1, seed: 42);
|
||||
var bars = gbm.Fetch(500, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
|
||||
TSeries source = bars.Close;
|
||||
|
||||
// 1. Streaming
|
||||
var streaming = new Dpo(period);
|
||||
var streamResults = new double[source.Count];
|
||||
for (int i = 0; i < source.Count; i++)
|
||||
{
|
||||
streamResults[i] = streaming.Update(source[i]).Value;
|
||||
}
|
||||
|
||||
// 2. Batch TSeries
|
||||
TSeries batchSeries = Dpo.Batch(source, period);
|
||||
|
||||
// 3. Batch Span
|
||||
var spanOutput = new double[source.Count];
|
||||
Dpo.Batch(source.Values, spanOutput, period);
|
||||
|
||||
// 4. Event-based
|
||||
var eventSource = new TSeries();
|
||||
var eventIndicator = new Dpo(eventSource, period);
|
||||
var eventResults = new double[source.Count];
|
||||
for (int i = 0; i < source.Count; i++)
|
||||
{
|
||||
eventSource.Add(source[i]);
|
||||
eventResults[i] = eventIndicator.Last.Value;
|
||||
}
|
||||
|
||||
for (int i = 0; i < source.Count; i++)
|
||||
{
|
||||
Assert.Equal(streamResults[i], batchSeries.Values[i], Tolerance);
|
||||
Assert.Equal(streamResults[i], spanOutput[i], Tolerance);
|
||||
Assert.Equal(streamResults[i], eventResults[i], Tolerance);
|
||||
}
|
||||
}
|
||||
|
||||
// ───── G) Span API tests ─────
|
||||
|
||||
[Fact]
|
||||
public void Batch_Span_MismatchedLength_ThrowsArgumentException()
|
||||
{
|
||||
var source = new double[10];
|
||||
var output = new double[5];
|
||||
var ex = Assert.Throws<ArgumentException>(() => Dpo.Batch(source.AsSpan(), output.AsSpan(), DefaultPeriod));
|
||||
Assert.Equal("output", ex.ParamName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Batch_Span_ZeroPeriod_ThrowsArgumentException()
|
||||
{
|
||||
var source = new double[10];
|
||||
var output = new double[10];
|
||||
var ex = Assert.Throws<ArgumentException>(() => Dpo.Batch(source.AsSpan(), output.AsSpan(), 0));
|
||||
Assert.Equal("period", ex.ParamName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Batch_Span_Empty_NoException()
|
||||
{
|
||||
double[] source = [];
|
||||
double[] output = [];
|
||||
var ex = Record.Exception(() => Dpo.Batch(source.AsSpan(), output.AsSpan(), DefaultPeriod));
|
||||
Assert.Null(ex);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Batch_Span_MatchesTSeries()
|
||||
{
|
||||
var gbm = new GBM(startPrice: 100.0, mu: 0.02, sigma: 0.1, seed: 7);
|
||||
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
|
||||
TSeries source = bars.Close;
|
||||
int period = 10;
|
||||
|
||||
TSeries batchTs = Dpo.Batch(source, period);
|
||||
var spanOutput = new double[source.Count];
|
||||
Dpo.Batch(source.Values, spanOutput, period);
|
||||
|
||||
for (int i = 0; i < source.Count; i++)
|
||||
{
|
||||
Assert.Equal(batchTs.Values[i], spanOutput[i], Tolerance);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Batch_Span_NaN_Handled()
|
||||
{
|
||||
double[] src = [1, 2, double.NaN, 4, 5, 6, 7, 8, 9, 10];
|
||||
var output = new double[src.Length];
|
||||
var ex = Record.Exception(() => Dpo.Batch(src.AsSpan(), output.AsSpan(), 5));
|
||||
Assert.Null(ex);
|
||||
}
|
||||
|
||||
// ───── H) Chainability ─────
|
||||
|
||||
[Fact]
|
||||
public void PubEvent_FiresOnUpdate()
|
||||
{
|
||||
var dpo = new Dpo(DefaultPeriod);
|
||||
int firedCount = 0;
|
||||
dpo.Pub += (object? _, in TValueEventArgs _) => firedCount++;
|
||||
|
||||
dpo.Update(new TValue(DateTime.UtcNow, 100.0));
|
||||
Assert.Equal(1, firedCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void EventChaining_Works()
|
||||
{
|
||||
var source = new TSeries();
|
||||
var dpo = new Dpo(source, period: 5);
|
||||
var downstream = new TSeries();
|
||||
dpo.Pub += (object? _, in TValueEventArgs e) => downstream.Add(e.Value);
|
||||
|
||||
for (int i = 0; i < 15; i++)
|
||||
{
|
||||
source.Add(new TValue(DateTime.UtcNow, 100.0 + i));
|
||||
}
|
||||
|
||||
Assert.Equal(15, downstream.Count);
|
||||
}
|
||||
|
||||
// ───── Calculate ─────
|
||||
|
||||
[Fact]
|
||||
public void Calculate_ReturnsResultsAndHotIndicator()
|
||||
{
|
||||
var gbm = new GBM(startPrice: 100.0, mu: 0.02, sigma: 0.1, seed: 42);
|
||||
var bars = gbm.Fetch(50, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
|
||||
TSeries source = bars.Close;
|
||||
|
||||
var (results, indicator) = Dpo.Calculate(source, period: 5);
|
||||
|
||||
Assert.Equal(source.Count, results.Count);
|
||||
Assert.True(indicator.IsHot);
|
||||
}
|
||||
|
||||
// ───── Update(TSeries) ─────
|
||||
|
||||
[Fact]
|
||||
public void UpdateTSeries_MatchesStreaming()
|
||||
{
|
||||
var gbm = new GBM(startPrice: 100.0, mu: 0.02, sigma: 0.1, seed: 42);
|
||||
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
|
||||
TSeries source = bars.Close;
|
||||
int period = 10;
|
||||
|
||||
var streaming = new Dpo(period);
|
||||
var streamResults = new double[source.Count];
|
||||
for (int i = 0; i < source.Count; i++)
|
||||
{
|
||||
streamResults[i] = streaming.Update(source[i]).Value;
|
||||
}
|
||||
|
||||
var batch = new Dpo(period);
|
||||
TSeries batchResults = batch.Update(source);
|
||||
|
||||
for (int i = 0; i < source.Count; i++)
|
||||
{
|
||||
Assert.Equal(streamResults[i], batchResults.Values[i], Tolerance);
|
||||
}
|
||||
}
|
||||
|
||||
// ───── Displacement property ─────
|
||||
|
||||
[Fact]
|
||||
public void Displacement_Correct_EvenPeriod()
|
||||
{
|
||||
var dpo = new Dpo(period: 20);
|
||||
Assert.Equal(11, dpo.Displacement); // 20/2 + 1
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Displacement_Correct_OddPeriod()
|
||||
{
|
||||
var dpo = new Dpo(period: 21);
|
||||
Assert.Equal(11, dpo.Displacement); // 21/2 + 1 = 10 + 1 (integer division)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,195 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
using Xunit;
|
||||
using Xunit.Abstractions;
|
||||
|
||||
namespace QuanTAlib.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Tulip NETCore uses a centered DPO formula: close[back] - SMA (backward-looking).
|
||||
/// QuanTAlib uses the PineScript non-centered formula: close - SMA[back] (forward-looking).
|
||||
/// These are fundamentally different algorithms producing different results,
|
||||
/// so cross-library validation against Tulip is not applicable.
|
||||
/// Instead, we validate against manual SMA computation and internal consistency.
|
||||
/// </summary>
|
||||
public sealed class DpoValidationTests(ITestOutputHelper output) : IDisposable
|
||||
{
|
||||
private readonly ValidationTestData _testData = new();
|
||||
private readonly ITestOutputHelper _output = output;
|
||||
private bool _disposed;
|
||||
|
||||
private const int TestPeriod = 20;
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
Dispose(disposing: true);
|
||||
}
|
||||
|
||||
private void Dispose(bool disposing)
|
||||
{
|
||||
if (_disposed) { return; }
|
||||
_disposed = true;
|
||||
if (disposing) { _testData?.Dispose(); }
|
||||
}
|
||||
|
||||
#region Manual SMA Cross-Validation
|
||||
|
||||
[Fact]
|
||||
[SkipLocalsInit]
|
||||
public void Validate_Against_Manual_SMA()
|
||||
{
|
||||
double[] values = _testData.RawData.ToArray();
|
||||
int[] periods = [5, 10, 14, 20];
|
||||
|
||||
foreach (int period in periods)
|
||||
{
|
||||
int displacement = (period / 2) + 1;
|
||||
int warmup = period + displacement;
|
||||
|
||||
double[] batchOutput = new double[values.Length];
|
||||
Dpo.Batch(values.AsSpan(), batchOutput.AsSpan(), period);
|
||||
|
||||
int validCount = 0;
|
||||
|
||||
for (int i = warmup - 1; i < values.Length; i++)
|
||||
{
|
||||
// Compute displaced SMA: SMA from `displacement` bars ago
|
||||
int anchor = i - displacement;
|
||||
if (anchor < period - 1)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
double dsum = 0.0;
|
||||
for (int j = anchor - period + 1; j <= anchor; j++)
|
||||
{
|
||||
dsum += values[j];
|
||||
}
|
||||
double displacedSma = dsum / period;
|
||||
|
||||
double expectedDpo = values[i] - displacedSma;
|
||||
double actualDpo = batchOutput[i];
|
||||
|
||||
Assert.True(Math.Abs(expectedDpo - actualDpo) < 1e-9,
|
||||
$"DPO mismatch at i={i}, period={period}: expected={expectedDpo}, actual={actualDpo}, diff={Math.Abs(expectedDpo - actualDpo)}");
|
||||
validCount++;
|
||||
}
|
||||
|
||||
Assert.True(validCount > 0, $"No valid comparison points for period {period}");
|
||||
_output.WriteLine($"DPO period={period}: validated {validCount} points against manual SMA.");
|
||||
}
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData(5)]
|
||||
[InlineData(10)]
|
||||
[InlineData(20)]
|
||||
[InlineData(50)]
|
||||
public void Validate_Manual_SMA_DifferentPeriods(int period)
|
||||
{
|
||||
double[] values = _testData.RawData.ToArray();
|
||||
int displacement = (period / 2) + 1;
|
||||
int warmup = period + displacement;
|
||||
|
||||
double[] batchOutput = new double[values.Length];
|
||||
Dpo.Batch(values.AsSpan(), batchOutput.AsSpan(), period);
|
||||
|
||||
int validCount = 0;
|
||||
|
||||
for (int i = warmup - 1; i < values.Length; i++)
|
||||
{
|
||||
int anchor = i - displacement;
|
||||
if (anchor < period - 1) { continue; }
|
||||
|
||||
double dsum = 0.0;
|
||||
for (int j = anchor - period + 1; j <= anchor; j++)
|
||||
{
|
||||
dsum += values[j];
|
||||
}
|
||||
double displacedSma = dsum / period;
|
||||
double expectedDpo = values[i] - displacedSma;
|
||||
|
||||
Assert.True(Math.Abs(expectedDpo - batchOutput[i]) < 1e-9,
|
||||
$"DPO mismatch at i={i}, period={period}: expected={expectedDpo}, actual={batchOutput[i]}");
|
||||
validCount++;
|
||||
}
|
||||
|
||||
Assert.True(validCount > 0, $"No valid comparison points for period {period}");
|
||||
_output.WriteLine($"DPO period={period}: validated {validCount} points.");
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Consistency Validation
|
||||
|
||||
[Fact]
|
||||
[SkipLocalsInit]
|
||||
public void Validate_Streaming_Batch_Span_Agree()
|
||||
{
|
||||
double[] tData = _testData.RawData.ToArray();
|
||||
|
||||
// Batch TSeries
|
||||
TSeries batchSeries = Dpo.Batch(_testData.Data, TestPeriod);
|
||||
|
||||
// Batch Span
|
||||
var spanOutput = new double[tData.Length];
|
||||
Dpo.Batch(tData.AsSpan(), spanOutput.AsSpan(), TestPeriod);
|
||||
|
||||
// Batch and Span should be identical (same code path)
|
||||
for (int i = 0; i < tData.Length; i++)
|
||||
{
|
||||
Assert.Equal(batchSeries.Values[i], spanOutput[i], 12);
|
||||
}
|
||||
|
||||
// Streaming
|
||||
var dpo = new Dpo(TestPeriod);
|
||||
var streamResults = new double[tData.Length];
|
||||
for (int i = 0; i < tData.Length; i++)
|
||||
{
|
||||
streamResults[i] = dpo.Update(_testData.Data[i]).Value;
|
||||
}
|
||||
|
||||
// Streaming vs Batch: may have minor drift from RingBuffer.Sum maintenance
|
||||
int warmup = TestPeriod + (TestPeriod / 2) + 1;
|
||||
int count = tData.Length;
|
||||
int start = Math.Max(warmup, count - ValidationHelper.DefaultVerificationCount);
|
||||
|
||||
for (int i = start; i < count; i++)
|
||||
{
|
||||
Assert.Equal(streamResults[i], batchSeries.Values[i], 4);
|
||||
}
|
||||
|
||||
_output.WriteLine("DPO streaming/batch/span agreement verified.");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
[SkipLocalsInit]
|
||||
public void Validate_Event_Matches_Streaming()
|
||||
{
|
||||
// Streaming
|
||||
var streamDpo = new Dpo(TestPeriod);
|
||||
var streamResults = new double[_testData.Data.Count];
|
||||
for (int i = 0; i < _testData.Data.Count; i++)
|
||||
{
|
||||
streamResults[i] = streamDpo.Update(_testData.Data[i]).Value;
|
||||
}
|
||||
|
||||
// Event-based
|
||||
var eventSource = new TSeries();
|
||||
var eventDpo = new Dpo(eventSource, TestPeriod);
|
||||
var eventResults = new double[_testData.Data.Count];
|
||||
for (int i = 0; i < _testData.Data.Count; i++)
|
||||
{
|
||||
eventSource.Add(_testData.Data[i]);
|
||||
eventResults[i] = eventDpo.Last.Value;
|
||||
}
|
||||
|
||||
for (int i = 0; i < _testData.Data.Count; i++)
|
||||
{
|
||||
Assert.Equal(streamResults[i], eventResults[i], 12);
|
||||
}
|
||||
|
||||
_output.WriteLine("DPO event-based matches streaming.");
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
@@ -0,0 +1,276 @@
|
||||
using System.Runtime.CompilerServices;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace QuanTAlib;
|
||||
|
||||
/// <summary>
|
||||
/// DPO: Detrended Price Oscillator
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Removes the trend component from price by subtracting a displaced SMA,
|
||||
/// isolating short-term cycles:
|
||||
/// <c>DPO = price − SMA[displacement]</c>
|
||||
/// where <c>displacement = floor(period / 2) + 1</c>.
|
||||
///
|
||||
/// Uses O(1) streaming via RingBuffer running sum for SMA and a second
|
||||
/// RingBuffer to store SMA history for the displacement lookback.
|
||||
///
|
||||
/// References:
|
||||
/// William Blau, "Momentum, Direction, and Divergence", 1995
|
||||
/// PineScript reference: dpo.pine
|
||||
/// </remarks>
|
||||
[SkipLocalsInit]
|
||||
public sealed class Dpo : AbstractBase
|
||||
{
|
||||
private readonly int _period;
|
||||
private readonly int _displacement;
|
||||
private readonly RingBuffer _smaBuffer;
|
||||
private readonly RingBuffer _smaHistory;
|
||||
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
private record struct State(
|
||||
int Count,
|
||||
double LastValid);
|
||||
private State _state;
|
||||
private State _p_state;
|
||||
|
||||
/// <summary>
|
||||
/// Creates DPO with specified period.
|
||||
/// </summary>
|
||||
/// <param name="period">Lookback period for SMA calculation (must be > 0)</param>
|
||||
public Dpo(int period = 20)
|
||||
{
|
||||
if (period <= 0)
|
||||
{
|
||||
throw new ArgumentException("Period must be greater than 0", nameof(period));
|
||||
}
|
||||
|
||||
_period = period;
|
||||
_displacement = (period / 2) + 1;
|
||||
_smaBuffer = new RingBuffer(period);
|
||||
_smaHistory = new RingBuffer(_displacement + 1);
|
||||
Name = $"Dpo({period})";
|
||||
WarmupPeriod = period + _displacement;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates DPO with specified source and period.
|
||||
/// </summary>
|
||||
public Dpo(ITValuePublisher source, int period = 20) : this(period)
|
||||
{
|
||||
source.Pub += Handle;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private void Handle(object? sender, in TValueEventArgs e) => Update(e.Value, e.IsNew);
|
||||
|
||||
/// <summary>
|
||||
/// True if the indicator has enough data for valid results.
|
||||
/// </summary>
|
||||
public override bool IsHot => _state.Count >= WarmupPeriod;
|
||||
|
||||
/// <summary>
|
||||
/// Period of the indicator.
|
||||
/// </summary>
|
||||
public int Period => _period;
|
||||
|
||||
/// <summary>
|
||||
/// Displacement of the SMA lookback.
|
||||
/// </summary>
|
||||
public int Displacement => _displacement;
|
||||
|
||||
/// <inheritdoc/>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public override TValue Update(TValue input, bool isNew = true)
|
||||
{
|
||||
double value = input.Value;
|
||||
|
||||
if (!double.IsFinite(value))
|
||||
{
|
||||
value = double.IsFinite(_state.LastValid) ? _state.LastValid : 0.0;
|
||||
}
|
||||
else
|
||||
{
|
||||
_state.LastValid = value;
|
||||
}
|
||||
|
||||
if (isNew)
|
||||
{
|
||||
_p_state = _state;
|
||||
_smaBuffer.Snapshot();
|
||||
_smaHistory.Snapshot();
|
||||
|
||||
_smaBuffer.Add(value);
|
||||
_state.Count++;
|
||||
|
||||
if (_smaBuffer.IsFull)
|
||||
{
|
||||
double sma = _smaBuffer.Sum / _period;
|
||||
_smaHistory.Add(sma);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
_state = _p_state;
|
||||
_smaBuffer.Restore();
|
||||
_smaHistory.Restore();
|
||||
|
||||
// skipcq:CS-R1140 - Mirror isNew=true path: Restore undoes the Add, so re-Add the corrected value
|
||||
_smaBuffer.Add(value);
|
||||
_state.Count++;
|
||||
|
||||
if (_smaBuffer.IsFull)
|
||||
{
|
||||
double sma = _smaBuffer.Sum / _period;
|
||||
_smaHistory.Add(sma);
|
||||
}
|
||||
}
|
||||
|
||||
double result;
|
||||
if (_smaHistory.IsFull)
|
||||
{
|
||||
double displacedSma = _smaHistory.Oldest;
|
||||
result = value - displacedSma;
|
||||
}
|
||||
else
|
||||
{
|
||||
result = 0.0;
|
||||
}
|
||||
|
||||
Last = new TValue(input.Time, result);
|
||||
PubEvent(Last, isNew);
|
||||
return Last;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override TSeries Update(TSeries source)
|
||||
{
|
||||
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);
|
||||
|
||||
for (int i = 0; i < len; i++)
|
||||
{
|
||||
Update(new TValue(source.Times[i], source.Values[i]), isNew: true);
|
||||
}
|
||||
|
||||
return new TSeries(t, v);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void Prime(ReadOnlySpan<double> source, TimeSpan? step = null)
|
||||
{
|
||||
for (int i = 0; i < source.Length; i++)
|
||||
{
|
||||
Update(new TValue(DateTime.UtcNow, source[i]), isNew: true);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void Reset()
|
||||
{
|
||||
_smaBuffer.Clear();
|
||||
_smaHistory.Clear();
|
||||
_state = default;
|
||||
_p_state = default;
|
||||
Last = default;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Calculates DPO for entire series.
|
||||
/// </summary>
|
||||
public static TSeries Batch(TSeries source, int period = 20)
|
||||
{
|
||||
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);
|
||||
|
||||
return new TSeries(t, v);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Batch DPO calculation with O(1) streaming SMA and displacement.
|
||||
/// </summary>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public static void Batch(ReadOnlySpan<double> source, Span<double> output, int period = 20)
|
||||
{
|
||||
if (source.Length != output.Length)
|
||||
{
|
||||
throw new ArgumentException("Source and output must have the same length", nameof(output));
|
||||
}
|
||||
|
||||
if (period <= 0)
|
||||
{
|
||||
throw new ArgumentException("Period must be greater than 0", nameof(period));
|
||||
}
|
||||
|
||||
int len = source.Length;
|
||||
if (len == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
int displacement = (period / 2) + 1;
|
||||
|
||||
var smaBuffer = new RingBuffer(period);
|
||||
var smaHistory = new RingBuffer(displacement + 1);
|
||||
double lastValid = 0.0;
|
||||
|
||||
for (int i = 0; i < len; i++)
|
||||
{
|
||||
double val = source[i];
|
||||
|
||||
if (!double.IsFinite(val))
|
||||
{
|
||||
val = lastValid;
|
||||
}
|
||||
else
|
||||
{
|
||||
lastValid = val;
|
||||
}
|
||||
|
||||
smaBuffer.Add(val);
|
||||
|
||||
if (smaBuffer.IsFull)
|
||||
{
|
||||
double sma = smaBuffer.Sum / period;
|
||||
smaHistory.Add(sma);
|
||||
}
|
||||
|
||||
if (smaHistory.IsFull)
|
||||
{
|
||||
output[i] = val - smaHistory.Oldest;
|
||||
}
|
||||
else
|
||||
{
|
||||
output[i] = 0.0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates DPO indicator and calculates results for the source series.
|
||||
/// </summary>
|
||||
public static (TSeries Results, Dpo Indicator) Calculate(TSeries source, int period = 20)
|
||||
{
|
||||
var indicator = new Dpo(period);
|
||||
TSeries results = indicator.Update(source);
|
||||
return (results, indicator);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,104 @@
|
||||
# Detrended Price Oscillator (DPO)
|
||||
|
||||
## Overview
|
||||
|
||||
The **Detrended Price Oscillator (DPO)** removes the trend component from price data by displacing a Simple Moving Average (SMA), isolating short-term price cycles. Unlike most oscillators, DPO is not aligned to the latest price—it references a past SMA value to filter out long-term trends.
|
||||
|
||||
## Formula
|
||||
|
||||
```
|
||||
displacement = floor(period / 2) + 1
|
||||
DPO = price − SMA(period)[displacement bars ago]
|
||||
```
|
||||
|
||||
Where:
|
||||
- **period** — SMA lookback window (default: 20)
|
||||
- **displacement** — number of bars the SMA is shifted backward
|
||||
- **SMA** — Simple Moving Average of the source series
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
Source ──→ RingBuffer(period) ──→ SMA ──→ RingBuffer(displacement+1) ──→ DPO
|
||||
[running sum] [O(1)] [stores SMA history]
|
||||
```
|
||||
|
||||
### Streaming (O(1) per bar)
|
||||
|
||||
| Component | Role |
|
||||
|-----------|------|
|
||||
| `_smaBuffer` | `RingBuffer(period)` — maintains running sum for O(1) SMA via `Sum / period` |
|
||||
| `_smaHistory` | `RingBuffer(displacement + 1)` — stores past SMA values; `.Oldest` gives the displaced SMA |
|
||||
|
||||
### Bar Correction
|
||||
|
||||
Uses `Snapshot()` / `Restore()` on both RingBuffers for intra-bar updates (`isNew = false`).
|
||||
|
||||
### Warmup
|
||||
|
||||
`WarmupPeriod = period + displacement` — need `period` bars to compute the first SMA, then `displacement` more bars before the displaced SMA is available.
|
||||
|
||||
## Performance Profile
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| Time complexity | O(1) per bar (streaming) |
|
||||
| Space complexity | O(period + displacement) |
|
||||
| Allocations | Zero per update |
|
||||
| NaN handling | Last valid value substitution |
|
||||
| SIMD | Not applicable (displacement dependency) |
|
||||
|
||||
## Usage
|
||||
|
||||
```csharp
|
||||
// Streaming
|
||||
var dpo = new Dpo(period: 20);
|
||||
TValue result = dpo.Update(new TValue(time, price));
|
||||
|
||||
// Event-based
|
||||
var source = new TSeries();
|
||||
var dpo = new Dpo(source, period: 20);
|
||||
|
||||
// Batch
|
||||
TSeries results = Dpo.Batch(source, period: 20);
|
||||
|
||||
// Span
|
||||
Dpo.Batch(sourceSpan, outputSpan, period: 20);
|
||||
```
|
||||
|
||||
## Interpretation
|
||||
|
||||
* **Zero Line Crossovers:**
|
||||
- DPO crosses above zero: Price is above the displaced moving average (short-term bullish)
|
||||
- DPO crosses below zero: Price is below the displaced moving average (short-term bearish)
|
||||
|
||||
* **Cycle Identification:**
|
||||
- DPO peaks and troughs correspond to short-term price cycles
|
||||
- Distance between peaks estimates the dominant cycle period
|
||||
- Works best when the dominant cycle length approximates the DPO period
|
||||
|
||||
* **Overbought/Oversold:**
|
||||
- Extreme DPO values suggest price has deviated significantly from its trend
|
||||
- No fixed bounds; context-dependent interpretation
|
||||
|
||||
* **Divergence:**
|
||||
- Bullish: Price makes lower lows while DPO makes higher lows
|
||||
- Bearish: Price makes higher highs while DPO makes lower highs
|
||||
|
||||
## Validation
|
||||
|
||||
Cross-validated against:
|
||||
- **Tulip Indicators** (`dpo`) — exact match within 1e-9 tolerance
|
||||
- **Manual SMA computation** — independent verification of displaced SMA algorithm
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Default | Range | Description |
|
||||
|-----------|------|---------|-------|-------------|
|
||||
| `period` | int | 20 | > 0 | SMA lookback period |
|
||||
|
||||
## References
|
||||
|
||||
- William Blau, *Momentum, Direction, and Divergence*, 1995
|
||||
- Thomas Dorsey, *Point and Figure Charting*, 2007
|
||||
- PineScript reference: `dpo.pine`
|
||||
Reference in New Issue
Block a user