Files
QuanTAlib/lib/volatility/bbwp/Bbwp.Tests.cs
T
Miha Kralj bcb52ef5ec Add Close-to-Close Volatility (CCV) implementation and validation tests
- Implemented CCV class for calculating annualized log return volatility using SMA, EMA, and WMA smoothing methods.
- Added comprehensive unit tests for CCV to validate mathematical correctness, consistency across methods, and edge cases.
- Created documentation for CCV detailing its mathematical foundation, smoothing methods, and performance metrics.
2026-01-31 17:25:39 -08:00

486 lines
15 KiB
C#

namespace QuanTAlib.Tests;
using Xunit;
public class BbwpTests
{
private const double Tolerance = 1e-10;
private static TBarSeries GenerateTestData(int count = 100)
{
var gbm = new GBM(seed: 42);
return gbm.Fetch(count, DateTime.UtcNow.Ticks, TimeSpan.FromMinutes(1));
}
[Fact]
public void Constructor_ValidatesInput()
{
Assert.Throws<ArgumentException>(() => new Bbwp(0));
Assert.Throws<ArgumentException>(() => new Bbwp(-1));
Assert.Throws<ArgumentException>(() => new Bbwp(20, 0));
Assert.Throws<ArgumentException>(() => new Bbwp(20, -1));
Assert.Throws<ArgumentException>(() => new Bbwp(20, 2.0, 0));
Assert.Throws<ArgumentException>(() => new Bbwp(20, 2.0, -1));
var valid = new Bbwp(10, 1.5, 100);
Assert.Equal(10, valid.Period);
Assert.Equal(1.5, valid.Multiplier);
Assert.Equal(100, valid.Lookback);
}
[Fact]
public void WarmupPeriod_IsPositive()
{
var bbwp = new Bbwp(20, 2.0, 252);
Assert.Equal(272, bbwp.WarmupPeriod); // period + lookback
Assert.True(bbwp.WarmupPeriod > 0);
}
[Fact]
public void Properties_Accessible()
{
var bbwp = new Bbwp(20, 2.5, 100);
Assert.Equal(20, bbwp.Period);
Assert.Equal(2.5, bbwp.Multiplier);
Assert.Equal(100, bbwp.Lookback);
Assert.Equal("Bbwp(20,2.5,100)", bbwp.Name);
}
[Fact]
public void BasicCalculation_DoesNotCrash()
{
var bbwp = new Bbwp(5, 2.0, 20);
var bars = GenerateTestData(100);
var times = bars.Times;
var close = bars.CloseValues;
for (int i = 0; i < bars.Count; i++)
{
var result = bbwp.Update(new TValue(times[i], close[i]));
Assert.True(double.IsFinite(result.Value), $"Invalid value at index {i}: {result.Value}");
}
Assert.True(bbwp.Last.Value >= 0.0, "BBWP should be >= 0");
Assert.True(bbwp.Last.Value <= 1.0, "BBWP should be <= 1");
}
[Fact]
public void IsHot_BehavesCorrectly()
{
var bbwp = new Bbwp(5, 2.0, 10);
var bars = GenerateTestData(20);
var close = bars.CloseValues;
// Should not be hot initially
Assert.False(bbwp.IsHot);
// Feed data until warm
for (int i = 0; i < 15; i++)
{
bbwp.Update(new TValue(DateTime.UtcNow.Ticks + i, close[i]));
}
// Should be hot after sufficient data
Assert.True(bbwp.IsHot);
}
[Fact]
public void OutputRange_IsPercentile()
{
var bbwp = new Bbwp(10, 2.0, 50);
var bars = GenerateTestData(100);
var close = bars.CloseValues;
var times = bars.Times;
var results = new List<double>();
for (int i = 0; i < bars.Count; i++)
{
var result = bbwp.Update(new TValue(times[i], close[i]));
results.Add(result.Value);
// Each result should be in [0,1] range
Assert.True(result.Value >= 0.0, $"Value {result.Value} at index {i} should be >= 0");
Assert.True(result.Value <= 1.0, $"Value {result.Value} at index {i} should be <= 1");
}
// After sufficient data, we should see some variation
if (results.Count > 60)
{
var laterResults = results.Skip(60).ToList();
double min = laterResults.Min();
double max = laterResults.Max();
// Should have some meaningful range in percentile values
Assert.True(max - min > 0.1, "Should have meaningful variation in percentile values");
}
}
[Fact]
public void Update_IsNew_BehavesCorrectly()
{
var bbwp = new Bbwp(5, 2.0, 20);
var bars = GenerateTestData(30);
// First load up enough data to create variation
for (int i = 0; i < 25; i++)
{
bbwp.Update(new TValue(bars.Times[i], bars.CloseValues[i]), isNew: true);
}
// First update (new)
var result1 = bbwp.Update(new TValue(bars.Times[25], bars.CloseValues[25]), isNew: true);
// Second update (revision) - with very different value to potentially change percentile
var revisedValue = new TValue(bars.Times[25], bars.CloseValues[25] * 1.5);
var result2 = bbwp.Update(revisedValue, isNew: false);
// After revision, the result might differ
Assert.True(double.IsFinite(result1.Value) && double.IsFinite(result2.Value));
}
[Fact]
public void Reset_ClearsState()
{
var bbwp = new Bbwp(5, 2.0, 20);
var bars = GenerateTestData(20);
var close = bars.CloseValues;
// Feed some data
for (int i = 0; i < 10; i++)
{
bbwp.Update(new TValue(DateTime.UtcNow.Ticks + i, close[i]));
}
Assert.True(bbwp.Last.Value != 0.0);
// Reset and check
bbwp.Reset();
Assert.Equal(0.0, bbwp.Last.Value);
Assert.False(bbwp.IsHot);
}
[Fact]
public void Prime_LoadsDataCorrectly()
{
var bbwp = new Bbwp(5, 2.0, 20);
var bars = GenerateTestData(30);
var close = bars.CloseValues.ToArray();
bbwp.Prime(close);
Assert.True(bbwp.IsHot);
Assert.True(double.IsFinite(bbwp.Last.Value));
Assert.True(bbwp.Last.Value >= 0.0 && bbwp.Last.Value <= 1.0);
}
[Fact]
public void Batch_ProducesConsistentResults()
{
var bbwp = new Bbwp(5, 2.0, 20);
var bars = GenerateTestData(50);
var close = bars.CloseValues;
var times = bars.Times;
// Calculate using Update method
var updateResults = new List<double>();
for (int i = 0; i < bars.Count; i++)
{
var result = bbwp.Update(new TValue(times[i], close[i]));
updateResults.Add(result.Value);
}
// Calculate using Batch method
var batchResults = new double[bars.Count];
Bbwp.Batch(close.ToArray(), batchResults, 5, 2.0, 20);
// Should be approximately equal after warmup period
for (int i = 25; i < bars.Count; i++) // Skip initial warmup
{
Assert.True(Math.Abs(updateResults[i] - batchResults[i]) < 0.01,
$"Mismatch at index {i}: Update={updateResults[i]:F6}, Batch={batchResults[i]:F6}");
}
}
[Fact]
public void Calculate_ProducesValidSeries()
{
var bars = GenerateTestData(100);
var ts = new TSeries();
for (int i = 0; i < bars.Count; i++)
{
ts.Add(new TValue(bars.Times[i], bars.CloseValues[i]));
}
var result = Bbwp.Calculate(ts, 10, 2.0, 50);
Assert.Equal(ts.Count, result.Count);
// All values should be in [0,1] range
for (int i = 0; i < result.Count; i++)
{
Assert.True(result.Values[i] >= 0.0, $"Value at {i} should be >= 0");
Assert.True(result.Values[i] <= 1.0, $"Value at {i} should be <= 1");
Assert.True(double.IsFinite(result.Values[i]), $"Value at {i} should be finite");
}
}
[Fact]
public void InvalidInput_HandledGracefully()
{
var bbwp = new Bbwp(5, 2.0, 20);
// Test with NaN
var result1 = bbwp.Update(new TValue(DateTime.UtcNow.Ticks, double.NaN));
Assert.True(double.IsFinite(result1.Value));
// Test with infinity
var result2 = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + 1, double.PositiveInfinity));
Assert.True(double.IsFinite(result2.Value));
// Test with negative infinity
var result3 = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + 2, double.NegativeInfinity));
Assert.True(double.IsFinite(result3.Value));
}
[Fact]
public void ZeroVarianceData_HandledCorrectly()
{
var bbwp = new Bbwp(5, 2.0, 20);
// Feed constant values (zero variance)
for (int i = 0; i < 30; i++)
{
var result = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + i, 100.0));
Assert.True(double.IsFinite(result.Value));
Assert.True(result.Value >= 0.0 && result.Value <= 1.0);
}
}
[Fact]
public void SmallDataset_HandledCorrectly()
{
var bbwp = new Bbwp(3, 2.0, 5);
// Test with minimal data
for (int i = 0; i < 3; i++)
{
var result = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + i, 100.0 + i));
Assert.True(double.IsFinite(result.Value));
Assert.True(result.Value >= 0.0 && result.Value <= 1.0);
}
}
[Fact]
public void LargeValues_HandledCorrectly()
{
var bbwp = new Bbwp(5, 2.0, 20);
// Test with large values
var largeValues = new[] { 1e6, 1e7, 1e8, 1e6, 1e7 };
foreach (var value in largeValues)
{
var result = bbwp.Update(new TValue(DateTime.UtcNow.Ticks, value));
Assert.True(double.IsFinite(result.Value));
Assert.True(result.Value >= 0.0 && result.Value <= 1.0);
}
}
[Fact]
public void TSeries_Update_MatchesStreaming()
{
int period = 10;
int lookback = 20;
var bbwpStream = new Bbwp(period, 2.0, lookback);
var bbwpBatch = new Bbwp(period, 2.0, lookback);
var bars = GenerateTestData(50);
var times = bars.Times;
var close = bars.CloseValues;
for (int i = 0; i < bars.Count; i++)
{
bbwpStream.Update(new TValue(times[i], close[i]));
}
var ts = new TSeries();
for (int i = 0; i < bars.Count; i++)
{
ts.Add(new TValue(times[i], close[i]));
}
var result = bbwpBatch.Update(ts);
Assert.Equal(bbwpStream.Last.Value, result[result.Count - 1].Value, 1e-9);
}
[Fact]
public void BatchCalc_MatchesIterativeCalc()
{
var bbwp = new Bbwp(10, 2.0, 30);
var bars = GenerateTestData(100);
var times = bars.Times;
var close = bars.CloseValues;
for (int i = 0; i < bars.Count; i++)
{
bbwp.Update(new TValue(times[i], close[i]));
}
var iterativeResult = bbwp.Last.Value;
var ts = new TSeries();
for (int i = 0; i < bars.Count; i++)
{
ts.Add(new TValue(times[i], close[i]));
}
var batchResult = Bbwp.Calculate(ts, 10, 2.0, 30);
Assert.Equal(iterativeResult, batchResult[batchResult.Count - 1].Value, 1e-8);
}
[Fact]
public void StaticBatch_Works()
{
var bars = GenerateTestData(100);
var times = bars.Times;
var close = bars.CloseValues;
var ts = new TSeries();
for (int i = 0; i < bars.Count; i++)
{
ts.Add(new TValue(times[i], close[i]));
}
var result = Bbwp.Calculate(ts, 20, 2.0, 50);
Assert.Equal(100, result.Count);
Assert.True(double.IsFinite(result[result.Count - 1].Value));
Assert.True(result[result.Count - 1].Value >= 0.0);
Assert.True(result[result.Count - 1].Value <= 1.0);
}
[Fact]
public void StaticBatch_ValidatesInput()
{
var ts = new TSeries();
for (int i = 0; i < 10; i++)
{
ts.Add(new TValue(DateTime.UtcNow.AddMinutes(i), 100 + i));
}
Assert.Throws<ArgumentException>(() => Bbwp.Calculate(ts, 0));
Assert.Throws<ArgumentException>(() => Bbwp.Calculate(ts, -1));
Assert.Throws<ArgumentException>(() => Bbwp.Calculate(ts, 5, 0));
Assert.Throws<ArgumentException>(() => Bbwp.Calculate(ts, 5, -1));
Assert.Throws<ArgumentException>(() => Bbwp.Calculate(ts, 5, 2.0, 0));
Assert.Throws<ArgumentException>(() => Bbwp.Calculate(ts, 5, 2.0, -1));
}
[Fact]
public void Batch_NaN_Safe()
{
var values = new double[] { 100, 101, 102, double.NaN, 104, 105 };
var output = new double[values.Length];
Bbwp.Batch(values, output, 3, 2.0, 3);
Assert.True(output.Length == 6);
}
[Fact]
public void BBWP_Percentile_Verified()
{
var bbwp = new Bbwp(5, 2.0, 10);
var bars = GenerateTestData(20);
var times = bars.Times;
var close = bars.CloseValues;
// Feed data
for (int i = 0; i < bars.Count; i++)
{
bbwp.Update(new TValue(times[i], close[i]));
}
// Result should be between 0 and 1
Assert.True(bbwp.Last.Value >= 0.0);
Assert.True(bbwp.Last.Value <= 1.0);
}
[Fact]
public void BBWP_HighVolatility_HigherPercentile()
{
var bbwp = new Bbwp(5, 2.0, 20);
var bars = GenerateTestData(100);
// Feed all data and check values are within range
for (int i = 0; i < bars.Count; i++)
{
var result = bbwp.Update(new TValue(bars.Times[i], bars.CloseValues[i]));
Assert.True(result.Value >= 0.0 && result.Value <= 1.0);
}
// Test passes if we get through all data without issue
Assert.True(bbwp.IsHot);
}
[Fact]
public void BBWP_LookbackEffect_Verified()
{
var bars = GenerateTestData(100);
// Short lookback
var bbwp1 = new Bbwp(10, 2.0, 20);
// Long lookback
var bbwp2 = new Bbwp(10, 2.0, 50);
for (int i = 0; i < bars.Count; i++)
{
bbwp1.Update(new TValue(bars.Times[i], bars.CloseValues[i]));
bbwp2.Update(new TValue(bars.Times[i], bars.CloseValues[i]));
}
// Both should be in valid range
Assert.True(bbwp1.Last.Value >= 0.0 && bbwp1.Last.Value <= 1.0);
Assert.True(bbwp2.Last.Value >= 0.0 && bbwp2.Last.Value <= 1.0);
// They may differ due to different historical context
}
[Fact]
public void IterativeCorrections_RestoreToOriginalState()
{
var bbwp = new Bbwp(10, 2.0, 20);
var bars = GenerateTestData(50);
var times = bars.Times;
var close = bars.CloseValues;
TValue lastValue = default;
for (int i = 0; i < bars.Count; i++)
{
lastValue = bbwp.Update(new TValue(times[i], close[i]), isNew: true);
}
double originalValue = lastValue.Value;
// Test with a much more extreme correction value
_ = bbwp.Update(new TValue(DateTime.UtcNow.Ticks, close[bars.Count - 1] * 100), isNew: false);
// Restore to original and verify exact match
var restoredValue = bbwp.Update(new TValue(lastValue.Time, close[bars.Count - 1]), isNew: false);
Assert.Equal(originalValue, restoredValue.Value, 1e-9);
}
[Fact]
public void IsNew_Consistency()
{
var bbwp = new Bbwp(5, 2.0, 10);
for (int i = 0; i < 20; i++)
{
bbwp.Update(new TValue(DateTime.UtcNow.Ticks + i, 100 + i), isNew: true);
}
var result1 = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + 100, 120), isNew: true);
_ = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + 100, 150), isNew: false);
var result3 = bbwp.Update(new TValue(DateTime.UtcNow.Ticks + 100, 120), isNew: false);
Assert.Equal(result1.Value, result3.Value, Tolerance);
}
}