docs: remove C# Implementation Considerations sections, clean up temp scripts, reorganize test files

- Remove 'C# Implementation Considerations' sections from 34 indicator .md files
- Delete 29 temp PowerShell scripts (_fix_mojibake.ps1, _hex_scan.ps1, etc.)
- Move test files into tests/ subdirectories for consistent project structure
- Add trader-focused bullet points to indicator documentation
This commit is contained in:
Miha Kralj
2026-03-12 12:34:16 -07:00
parent 8937b0c0fa
commit 060649192f
1149 changed files with 1780 additions and 3316 deletions
@@ -0,0 +1,65 @@
using TradingPlatform.BusinessLayer;
using QuanTAlib;
namespace QuanTAlib.Tests;
public class AdxrIndicatorTests
{
[Fact]
public void AdxrIndicator_Constructor_SetsDefaults()
{
var indicator = new AdxrIndicator();
Assert.Equal(14, indicator.Period);
Assert.True(indicator.ShowColdValues);
Assert.Equal("ADXR - Average Directional Movement Rating", indicator.Name);
Assert.True(indicator.SeparateWindow);
Assert.True(indicator.OnBackGround);
}
[Fact]
public void AdxrIndicator_MinHistoryDepths_EqualsZero()
{
var indicator = new AdxrIndicator { Period = 20 };
Assert.Equal(0, AdxrIndicator.MinHistoryDepths);
IWatchlistIndicator watchlistIndicator = indicator;
Assert.Equal(0, watchlistIndicator.MinHistoryDepths);
}
[Fact]
public void AdxrIndicator_Initialize_CreatesInternalAdxr()
{
var indicator = new AdxrIndicator { Period = 14 };
// Initialize should not throw
indicator.Initialize();
// After init, line series should exist (ADXR)
Assert.Single(indicator.LinesSeries);
}
[Fact]
public void AdxrIndicator_ProcessUpdate_HistoricalBar_ComputesValue()
{
var indicator = new AdxrIndicator { Period = 5 };
indicator.Initialize();
// Add historical data
var now = DateTime.UtcNow;
// Need enough bars for Period
for (int i = 0; i < 20; i++)
{
indicator.HistoricalData.AddBar(now.AddMinutes(i), 100 + i, 110 + i, 90 + i, 105 + i);
// Process update for each bar to simulate history loading
var args = new UpdateArgs(UpdateReason.HistoricalBar);
indicator.ProcessUpdate(args);
}
// Line series should have a value
double adxr = indicator.LinesSeries[0].GetValue(0);
Assert.True(double.IsFinite(adxr));
}
}
+271
View File
@@ -0,0 +1,271 @@
namespace QuanTAlib;
public class AdxrTests
{
[Fact]
public void BasicCalculation_DoesNotCrash()
{
var adxr = new Adxr(14);
var gbm = new GBM();
var bars = gbm.Fetch(1000, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
foreach (var bar in bars)
{
adxr.Update(bar);
}
Assert.True(double.IsFinite(adxr.Last.Value));
}
[Fact]
public void IsNew_Consistency()
{
var adxr = new Adxr(14);
var gbm = new GBM();
var bars = gbm.Fetch(100, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
// Feed first 99
for (int i = 0; i < 99; i++)
{
adxr.Update(bars[i]);
}
// Update with 100th point (isNew=true)
adxr.Update(bars[99], true);
// Update with modified 100th point (isNew=false)
var modifiedBar = new TBar(bars[99].Time, bars[99].Open, bars[99].High + 1.0, bars[99].Low - 1.0, bars[99].Close, bars[99].Volume);
var val2 = adxr.Update(modifiedBar, false);
// Create new instance and feed up to modified
var adxr2 = new Adxr(14);
for (int i = 0; i < 99; i++)
{
adxr2.Update(bars[i]);
}
var val3 = adxr2.Update(modifiedBar, true);
Assert.Equal(val3.Value, val2.Value, 1e-9);
}
[Fact]
public void Reset_Works()
{
var adxr = new Adxr(14);
var gbm = new GBM();
var bars = gbm.Fetch(100, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
foreach (var bar in bars)
{
adxr.Update(bar);
}
adxr.Reset();
Assert.Equal(0, adxr.Last.Value);
Assert.False(adxr.IsHot);
// Feed again
foreach (var bar in bars)
{
adxr.Update(bar);
}
Assert.True(double.IsFinite(adxr.Last.Value));
}
[Fact]
public void TBarSeries_Update_Matches_Streaming()
{
var adxr = new Adxr(14);
var gbm = new GBM();
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
var streamingResults = new List<double>();
foreach (var bar in bars)
{
streamingResults.Add(adxr.Update(bar).Value);
}
var adxr2 = new Adxr(14);
var seriesResults = adxr2.Update(bars);
Assert.Equal(streamingResults.Count, seriesResults.Count);
for (int i = 0; i < seriesResults.Count; i++)
{
Assert.Equal(streamingResults[i], seriesResults.Values[i], 1e-9);
}
}
[Fact]
public void StaticCalculate_Matches_Streaming()
{
var gbm = new GBM();
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
var adxr = new Adxr(14);
var streamingResults = new List<double>();
foreach (var bar in bars)
{
streamingResults.Add(adxr.Update(bar).Value);
}
var staticResults = Adxr.Batch(bars, 14);
Assert.Equal(streamingResults.Count, staticResults.Count);
for (int i = 0; i < staticResults.Count; i++)
{
Assert.Equal(streamingResults[i], staticResults.Values[i], 1e-9);
}
}
[Fact]
public void Constructor_InvalidParameters_ThrowsArgumentException()
{
Assert.Throws<ArgumentException>(() => new Adxr(0));
Assert.Throws<ArgumentException>(() => new Adxr(-1));
}
[Fact]
public void Chainability_Works()
{
var adxr = new Adxr(14);
var gbm = new GBM();
var bars = gbm.Fetch(10, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
// Test TBarSeries chain
var result = adxr.Update(bars);
Assert.NotNull(result);
Assert.IsType<TSeries>(result);
// Test TBar chain (returns TValue)
var result2 = adxr.Update(bars[0]);
Assert.IsType<TValue>(result2);
}
[Fact]
public void IterativeCorrections_RestoreToOriginalState()
{
var adxr = new Adxr(5);
var gbm = new GBM(startPrice: 100.0, mu: 0.02, sigma: 0.1);
// Feed 20 new values
TBar twentiethInput = default;
for (int i = 0; i < 20; i++)
{
var bar = gbm.Next(isNew: true);
twentiethInput = bar;
adxr.Update(bar, isNew: true);
}
// Remember state after 20 values
double stateAfterTwenty = adxr.Last.Value;
// Generate 9 corrections with isNew=false (different values)
for (int i = 0; i < 9; i++)
{
var bar = gbm.Next(isNew: false);
adxr.Update(bar, isNew: false);
}
// Feed the remembered 20th input again with isNew=false
TValue finalResult = adxr.Update(twentiethInput, isNew: false);
// State should match the original state after 20 values
Assert.Equal(stateAfterTwenty, finalResult.Value, 1e-10);
}
[Fact]
public void IsHot_BecomesTrueWhenBufferFull()
{
var adxr = new Adxr(5);
var gbm = new GBM();
Assert.False(adxr.IsHot);
// ADXR needs more warmup than just period (ADX warmup + period)
// Feed bars until IsHot becomes true
int count = 0;
while (!adxr.IsHot && count < 100)
{
var bar = gbm.Next(isNew: true);
adxr.Update(bar, isNew: true);
count++;
}
Assert.True(adxr.IsHot);
Assert.True(count > 5); // Should take more than period bars
}
[Fact]
public void NaN_Input_UsesLastValidValue()
{
var adxr = new Adxr(5);
var gbm = new GBM();
var bars = gbm.Fetch(30, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
// Feed some valid bars first
for (int i = 0; i < 25; i++)
{
adxr.Update(bars[i]);
}
// Create a bar with NaN values
var nanBar = new TBar(DateTime.UtcNow, double.NaN, double.NaN, double.NaN, double.NaN, double.NaN);
var result = adxr.Update(nanBar);
// Should not crash and should return a finite value
Assert.True(double.IsFinite(result.Value));
}
[Fact]
public void Infinity_Input_UsesLastValidValue()
{
var adxr = new Adxr(5);
var gbm = new GBM();
var bars = gbm.Fetch(30, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
// Feed some valid bars first
for (int i = 0; i < 25; i++)
{
adxr.Update(bars[i]);
}
// Create a bar with Infinity values
var infBar = new TBar(DateTime.UtcNow, double.PositiveInfinity, double.PositiveInfinity, double.NegativeInfinity, double.PositiveInfinity, double.PositiveInfinity);
var result = adxr.Update(infBar);
// Should not crash and should return a finite value
Assert.True(double.IsFinite(result.Value));
}
[Fact]
public void AllModes_ProduceSameResult()
{
// Arrange
const int period = 5;
var gbm = new GBM(startPrice: 100, mu: 0.05, sigma: 0.2, seed: 123);
var bars = gbm.Fetch(100, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
// 1. Batch Mode (static method)
var batchSeries = Adxr.Batch(bars, period);
double expected = batchSeries.Last.Value;
// 2. Streaming Mode (instance, one bar at a time)
var streamingInd = new Adxr(period);
foreach (var bar in bars)
{
streamingInd.Update(bar);
}
double streamingResult = streamingInd.Last.Value;
// 3. Instance Update with TBarSeries
var instanceInd = new Adxr(period);
var instanceResult = instanceInd.Update(bars);
double instanceValue = instanceResult.Last.Value;
// Assert all modes produce identical results
Assert.Equal(expected, streamingResult, precision: 9);
Assert.Equal(expected, instanceValue, precision: 9);
}
}
@@ -0,0 +1,70 @@
using TALib;
using QuanTAlib.Tests;
namespace QuanTAlib;
public sealed class AdxrValidationTests : IDisposable
{
private readonly ValidationTestData _data;
public AdxrValidationTests()
{
_data = new ValidationTestData();
}
public void Dispose()
{
_data.Dispose();
}
[Fact]
public void MatchesTalib()
{
var adxr = new Adxr(14);
var results = new List<double>();
for (int i = 0; i < _data.Bars.Count; i++)
{
var res = adxr.Update(_data.Bars[i]);
results.Add(res.Value);
}
double[] hData = _data.Bars.High.Select(x => x.Value).ToArray();
double[] lData = _data.Bars.Low.Select(x => x.Value).ToArray();
double[] cData = _data.Bars.Close.Select(x => x.Value).ToArray();
double[] outReal = new double[_data.Bars.Count];
var retCode = Functions.Adxr(hData, lData, cData, 0..^0, outReal, out var outRange, 14);
Assert.Equal(TALib.Core.RetCode.Success, retCode);
int lookback = Functions.AdxrLookback(14);
ValidationHelper.VerifyData(results, outReal, outRange, lookback);
}
[Fact]
public void MatchesTulip()
{
var adxr = new Adxr(14);
var results = new List<double>();
for (int i = 0; i < _data.Bars.Count; i++)
{
var res = adxr.Update(_data.Bars[i]);
results.Add(res.Value);
}
double[] hData = _data.Bars.High.Select(x => x.Value).ToArray();
double[] lData = _data.Bars.Low.Select(x => x.Value).ToArray();
double[] cData = _data.Bars.Close.Select(x => x.Value).ToArray();
double[][] inputs = { hData, lData, cData };
double[] options = { 14 };
var adxrInd = Tulip.Indicators.adxr;
double[][] outputs = { new double[hData.Length - adxrInd.Start(options)] };
adxrInd.Run(inputs, options, outputs);
double[] tulipResults = outputs[0];
int lookback = adxrInd.Start(options);
ValidationHelper.VerifyData(results, tulipResults, lookback);
}
}