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,183 @@
using TradingPlatform.BusinessLayer;
namespace QuanTAlib.Tests;
public class TrimaIndicatorTests
{
[Fact]
public void TrimaIndicator_Constructor_SetsDefaults()
{
var indicator = new TrimaIndicator();
Assert.Equal(10, indicator.Period);
Assert.Equal(SourceType.Close, indicator.Source);
Assert.True(indicator.ShowColdValues);
Assert.Equal("TRIMA - Triangular Moving Average", indicator.Name);
Assert.False(indicator.SeparateWindow);
Assert.True(indicator.OnBackGround);
}
[Fact]
public void TrimaIndicator_MinHistoryDepths_EqualsPeriod()
{
var indicator = new TrimaIndicator { Period = 20 };
Assert.Equal(0, TrimaIndicator.MinHistoryDepths);
Assert.Equal(0, ((IWatchlistIndicator)indicator).MinHistoryDepths);
}
[Fact]
public void TrimaIndicator_ShortName_IncludesPeriodAndSource()
{
var indicator = new TrimaIndicator { Period = 15 };
Assert.Contains("TRIMA", indicator.ShortName, StringComparison.Ordinal);
Assert.Contains("15", indicator.ShortName, StringComparison.Ordinal);
}
[Fact]
public void TrimaIndicator_SourceCodeLink_IsValid()
{
var indicator = new TrimaIndicator();
Assert.Contains("github.com", indicator.SourceCodeLink, StringComparison.Ordinal);
Assert.Contains("Trima.Quantower.cs", indicator.SourceCodeLink, StringComparison.Ordinal);
}
[Fact]
public void TrimaIndicator_Initialize_CreatesInternalTrima()
{
var indicator = new TrimaIndicator { Period = 10 };
// Initialize should not throw
indicator.Initialize();
// After init, line series should exist
Assert.Single(indicator.LinesSeries);
}
[Fact]
public void TrimaIndicator_ProcessUpdate_HistoricalBar_ComputesValue()
{
var indicator = new TrimaIndicator { Period = 3 };
indicator.Initialize();
// Add historical data
var now = DateTime.UtcNow;
for (int i = 0; i < 10; i++)
{
indicator.HistoricalData.AddBar(now.AddMinutes(i), 100, 105, 95, 102);
// Process update
var args = new UpdateArgs(UpdateReason.HistoricalBar);
indicator.ProcessUpdate(args);
}
// Line series should have a value
Assert.True(indicator.LinesSeries[0].Count > 0);
Assert.True(double.IsFinite(indicator.LinesSeries[0].GetValue(0)));
}
[Fact]
public void TrimaIndicator_ProcessUpdate_NewBar_ComputesValue()
{
var indicator = new TrimaIndicator { 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 TrimaIndicator_ProcessUpdate_NewTick_ProcessesWithoutError()
{
var indicator = new TrimaIndicator { 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 TrimaIndicator_MultipleUpdates_ProducesCorrectTrimaSequence()
{
var indicator = new TrimaIndicator { Period = 3 };
indicator.Initialize();
var now = DateTime.UtcNow;
double[] closes = { 100, 102, 104, 103, 105 };
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);
}
// All values should be finite
for (int i = 0; i < closes.Length; i++)
{
Assert.True(double.IsFinite(indicator.LinesSeries[0].GetValue(closes.Length - 1 - i)));
}
// TRIMA is smoothed, so check last value is reasonable
double lastTrima = indicator.LinesSeries[0].GetValue(0);
Assert.True(lastTrima >= 100 && lastTrima <= 106);
}
[Fact]
public void TrimaIndicator_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 TrimaIndicator { 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 TrimaIndicator_Period_CanBeChanged()
{
var indicator = new TrimaIndicator { Period = 5 };
Assert.Equal(5, indicator.Period);
indicator.Period = 20;
Assert.Equal(20, indicator.Period);
Assert.Equal(0, TrimaIndicator.MinHistoryDepths);
}
[Fact]
public void TrimaIndicator_DescriptionIsSet()
{
var indicator = new TrimaIndicator();
Assert.Contains("Triangular", indicator.Description, StringComparison.Ordinal);
}
}
+170
View File
@@ -0,0 +1,170 @@
namespace QuanTAlib;
public class TrimaTests
{
[Fact]
public void BasicCalculation_DoesNotCrash()
{
var trima = new Trima(10);
var gbm = new GBM();
var bars = gbm.Fetch(1000, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
for (int i = 0; i < bars.Count; i++)
{
trima.Update(new TValue(bars[i].Time, bars[i].Close));
}
Assert.True(double.IsFinite(trima.Last.Value));
}
[Fact]
public void IsNew_Consistency()
{
var trima = new Trima(10);
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++)
{
trima.Update(new TValue(bars[i].Time, bars[i].Close));
}
// Update with 100th point (isNew=true)
trima.Update(new TValue(bars[99].Time, bars[99].Close), true);
// Update with modified 100th point (isNew=false)
var val2 = trima.Update(new TValue(bars[99].Time, bars[99].Close + 1.0), false);
// Create new instance and feed up to modified
var trima2 = new Trima(10);
for (int i = 0; i < 99; i++)
{
trima2.Update(new TValue(bars[i].Time, bars[i].Close));
}
var val3 = trima2.Update(new TValue(bars[99].Time, bars[99].Close + 1.0), true);
Assert.Equal(val3.Value, val2.Value, 1e-9);
}
[Fact]
public void Reset_Works()
{
var trima = new Trima(10);
var gbm = new GBM();
var bars = gbm.Fetch(100, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
for (int i = 0; i < bars.Count; i++)
{
trima.Update(new TValue(bars[i].Time, bars[i].Close));
}
trima.Reset();
Assert.Equal(0, trima.Last.Value);
Assert.False(trima.IsHot);
// Feed again
for (int i = 0; i < bars.Count; i++)
{
trima.Update(new TValue(bars[i].Time, bars[i].Close));
}
Assert.True(double.IsFinite(trima.Last.Value));
}
[Fact]
public void TSeries_Update_Matches_Streaming()
{
var trima = new Trima(10);
var gbm = new GBM();
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
var series = bars.Close;
var streamingResults = new List<double>();
for (int i = 0; i < series.Count; i++)
{
streamingResults.Add(trima.Update(series[i]).Value);
}
var trima2 = new Trima(10);
var seriesResults = trima2.Update(series);
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 BatchCalculate_Matches_Streaming()
{
var gbm = new GBM();
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
var series = bars.Close;
var trima = new Trima(10);
var streamingResults = new List<double>();
for (int i = 0; i < series.Count; i++)
{
streamingResults.Add(trima.Update(series[i]).Value);
}
var batchResults = Trima.Batch(series, 10);
Assert.Equal(streamingResults.Count, batchResults.Count);
for (int i = 0; i < batchResults.Count; i++)
{
Assert.Equal(streamingResults[i], batchResults.Values[i], 1e-9);
}
}
[Fact]
public void BatchCalculateSpan_Matches_Streaming()
{
var gbm = new GBM();
var bars = gbm.Fetch(200, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
var series = bars.Close;
var trima = new Trima(10);
var streamingResults = new List<double>();
for (int i = 0; i < series.Count; i++)
{
streamingResults.Add(trima.Update(series[i]).Value);
}
var spanResults = new double[series.Count];
Trima.Batch(series.Values, spanResults, 10);
for (int i = 0; i < spanResults.Length; i++)
{
Assert.Equal(streamingResults[i], spanResults[i], 1e-9);
}
}
[Fact]
public void Chainability_Works()
{
var trima = new Trima(10);
var gbm = new GBM();
var bars = gbm.Fetch(10, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
var series = bars.Close;
// Test TSeries chain
var result = trima.Update(series);
Assert.NotNull(result);
Assert.IsType<TSeries>(result);
// Test TValue chain
var result2 = trima.Update(series[0]);
Assert.IsType<TValue>(result2);
}
[Fact]
public void Constructor_InvalidParameters_ThrowsArgumentException()
{
Assert.Throws<ArgumentException>(() => new Trima(0));
Assert.Throws<ArgumentException>(() => new Trima(-1));
}
}
@@ -0,0 +1,37 @@
using TALib;
namespace QuanTAlib.Tests;
public sealed class TrimaToleranceTests : IDisposable
{
private readonly ValidationTestData _testData;
public TrimaToleranceTests()
{
_testData = new ValidationTestData();
}
public void Dispose()
{
_testData.Dispose();
}
[Fact]
public void Check_Talib_Tolerance()
{
const int period = 20;
var trima = new Trima(period);
var qResult = trima.Update(_testData.Data);
double[] output = new double[_testData.RawData.Length];
var retCode = TALib.Functions.Trima<double>(_testData.RawData.Span, 0..^0, output, out var outRange, period);
Assert.Equal(TALib.Core.RetCode.Success, retCode);
int lookback = TALib.Functions.TrimaLookback(period);
ValidationHelper.VerifyData(qResult, output, outRange, lookback, tolerance: ValidationHelper.OoplesTolerance);
// Add explicit assertion to satisfy SonarQube
Assert.True(qResult.Count > 0);
}
}
@@ -0,0 +1,178 @@
using OoplesFinance.StockIndicators;
using OoplesFinance.StockIndicators.Models;
using Skender.Stock.Indicators;
using TALib;
using Xunit.Abstractions;
namespace QuanTAlib.Tests;
public class TrimaValidationTests
{
private readonly ValidationTestData _testData;
private readonly ITestOutputHelper _output;
public TrimaValidationTests(ITestOutputHelper output)
{
_output = output;
_testData = new ValidationTestData();
}
[Fact]
public void Validate_Skender_Batch()
{
int[] periods = { 5, 10, 20, 50, 100 };
foreach (var period in periods)
{
// Calculate QuanTAlib TRIMA (batch TSeries)
var trima = new global::QuanTAlib.Trima(period);
var qResult = trima.Update(_testData.Data);
// Calculate Skender Composite TRIMA: SMA(SMA(x, p1), p2)
int p1 = period / 2 + 1;
int p2 = (period + 1) / 2;
var sma1Results = _testData.SkenderQuotes.GetSma(p1).ToList();
// Map SMA1 results to Quotes for the second pass
// Note: We use 0 for null values during warmup, which might affect early values
// but should stabilize for the verification window (last 100 records)
var quotes2 = sma1Results.Select(r => new Quote
{
Date = r.Date,
Close = (decimal)(r.Sma ?? 0)
}).ToList();
var sResult = quotes2.GetSma(p2).ToList();
// Compare last 100 records
ValidationHelper.VerifyData(qResult, sResult, x => x.Sma, tolerance: ValidationHelper.SkenderTolerance);
}
_output.WriteLine("TRIMA Batch(TSeries) validated successfully against Skender Composite SMA");
}
[Fact]
public void Validate_Talib_Batch()
{
int[] periods = { 5, 10, 20, 50, 100 };
// Prepare data for TA-Lib (double[])
double[] output = new double[_testData.RawData.Length];
foreach (var period in periods)
{
// Calculate QuanTAlib TRIMA (batch TSeries)
var trima = new global::QuanTAlib.Trima(period);
var qResult = trima.Update(_testData.Data);
// Calculate TA-Lib TRIMA
var retCode = TALib.Functions.Trima<double>(_testData.RawData.Span, 0..^0, output, out var outRange, period);
Assert.Equal(TALib.Core.RetCode.Success, retCode);
int lookback = TALib.Functions.TrimaLookback(period);
// Compare last 100 records
ValidationHelper.VerifyData(qResult, output, outRange, lookback, tolerance: ValidationHelper.TalibTolerance);
}
_output.WriteLine("TRIMA Batch(TSeries) validated successfully against TA-Lib");
}
[Fact]
public void Validate_Tulip_Batch()
{
int[] periods = { 5, 10, 20, 50, 100 };
foreach (var period in periods)
{
// Calculate QuanTAlib TRIMA (batch TSeries)
var trima = new global::QuanTAlib.Trima(period);
var qResult = trima.Update(_testData.Data);
// Calculate Tulip TRIMA
var trimaIndicator = Tulip.Indicators.trima;
double[][] inputs = { _testData.RawData.ToArray() };
double[] options = { period };
// Tulip TRIMA lookback might be different, let's calculate or infer
// Usually it's period-1 for simple averages, but TRIMA is double smoothed.
// We'll rely on the output length to align.
// Tulip.Indicators.trima.Run expects outputs to be sized correctly.
// We can try to run it with a large buffer and see what happens,
// or calculate the expected lookback.
// For TRIMA(n), lookback is roughly n-1.
int lookback = period - 1;
double[][] outputs = { new double[_testData.RawData.Length - lookback] };
trimaIndicator.Run(inputs, options, outputs);
var tResult = outputs[0];
// Compare last 100 records
ValidationHelper.VerifyData(qResult, tResult, lookback, tolerance: ValidationHelper.TulipTolerance);
}
_output.WriteLine("TRIMA Batch(TSeries) validated successfully against Tulip");
}
[Fact]
public void Validate_Talib_Span()
{
int[] periods = { 5, 10, 20, 50, 100 };
// Prepare data
double[] talibOutput = new double[_testData.RawData.Length];
foreach (var period in periods)
{
// Calculate QuanTAlib TRIMA (Span API)
double[] qOutput = new double[_testData.RawData.Length];
global::QuanTAlib.Trima.Batch(_testData.RawData.Span, qOutput.AsSpan(), period);
// Calculate TA-Lib TRIMA
var retCode = TALib.Functions.Trima<double>(_testData.RawData.Span, 0..^0, talibOutput, out var outRange, period);
Assert.Equal(TALib.Core.RetCode.Success, retCode);
int lookback = TALib.Functions.TrimaLookback(period);
// Compare last 100 records
ValidationHelper.VerifyData(qOutput, talibOutput, outRange, lookback, tolerance: ValidationHelper.TalibTolerance);
}
_output.WriteLine("TRIMA Span validated successfully against TA-Lib");
}
// ── Cross-library: OoplesFinance ──────────────────────────────────────────
[Fact]
public void Trima_MatchesOoples_Structural()
{
const int period = 14;
var ooplesData = _testData.SkenderQuotes.Select(static q => new TickerData
{
Date = q.Date,
Open = (double)q.Open,
High = (double)q.High,
Low = (double)q.Low,
Close = (double)q.Close,
Volume = (double)q.Volume
}).ToList();
var stockData = new StockData(ooplesData);
var oResult = stockData.CalculateTriangularMovingAverage(length: period);
var oValues = oResult.OutputValues.Values.First();
var trima = new global::QuanTAlib.Trima(period);
var qValues = new List<double>();
foreach (var item in _testData.Data)
{
qValues.Add(trima.Update(item).Value);
}
Assert.True(oValues.Count > 0, "Ooples Trima must produce output");
int finiteCount = 0;
for (int i = period; i < Math.Min(oValues.Count, qValues.Count); i++)
{
if (double.IsFinite(oValues[i]) && double.IsFinite(qValues[i]))
{
finiteCount++;
}
}
Assert.True(finiteCount > 100, $"Expected >100 finite Trima pairs, got {finiteCount}");
_output.WriteLine($"Trima Ooples structural: {finiteCount} finite pairs verified.");
}
}