using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
namespace QuanTAlib;
///
/// BBB: Bollinger %B
///
///
///
/// Bollinger %B measures where price sits within Bollinger Bands:
/// %B = (Price - Lower) / (Upper - Lower)
///
///
/// This implementation uses O(1) rolling sums for mean and variance.
///
/// Formula:
/// Basis = SMA(source, period)
/// StdDev = sqrt(E[x^2] - E[x]^2)
/// Upper = Basis + multiplier * StdDev
/// Lower = Basis - multiplier * StdDev
/// BBB = (source - Lower) / (Upper - Lower)
///
/// When band width is zero, returns 0.5 (neutral).
///
/// References:
/// - John Bollinger, "Bollinger on Bollinger Bands"
/// - PineScript reference: bbb.pine
///
[SkipLocalsInit]
public sealed class Bbb : AbstractBase
{
private readonly int _period;
private readonly double _multiplier;
private readonly RingBuffer _buffer;
[StructLayout(LayoutKind.Auto)]
private record struct State(
double Sum,
double SumSq,
double SumComp,
double SumSqComp,
double LastValid);
private State _state;
private State _p_state;
///
/// Creates BBB with specified period and multiplier.
///
/// Lookback period (must be > 0)
/// Standard deviation multiplier (must be > 0)
public Bbb(int period = 20, double multiplier = 2.0)
{
if (period <= 0)
{
throw new ArgumentException("Period must be greater than 0", nameof(period));
}
if (multiplier <= 0)
{
throw new ArgumentException("Multiplier must be greater than 0", nameof(multiplier));
}
_period = period;
_multiplier = multiplier;
_buffer = new RingBuffer(period);
Name = $"Bbb({period},{multiplier:F1})";
WarmupPeriod = period;
}
///
/// Creates BBB with specified source, period, and multiplier.
///
public Bbb(ITValuePublisher source, int period = 20, double multiplier = 2.0) : this(period, multiplier)
{
source.Pub += Handle;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void Handle(object? sender, in TValueEventArgs e) => Update(e.Value, e.IsNew);
///
/// True if the indicator has enough data for valid results.
///
public override bool IsHot => _buffer.IsFull;
///
/// Period of the indicator.
///
public int Period => _period;
///
/// Standard deviation multiplier.
///
public double Multiplier => _multiplier;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override TValue Update(TValue input, bool isNew = true)
{
double value = input.Value;
// Sanitize input
if (!double.IsFinite(value))
{
value = double.IsFinite(_state.LastValid) ? _state.LastValid : 0.0;
}
else
{
_state.LastValid = value;
}
if (isNew)
{
_p_state = _state;
// Kahan compensated sliding window update
if (_buffer.Count == _buffer.Capacity)
{
double oldest = _buffer.Oldest;
double delta = value - oldest;
{
double y = delta - _state.SumComp;
double t = _state.Sum + y;
_state.SumComp = (t - _state.Sum) - y;
_state.Sum = t;
}
{
double deltaSq = (value * value) - (oldest * oldest);
double y = deltaSq - _state.SumSqComp;
double t = _state.SumSq + y;
_state.SumSqComp = (t - _state.SumSq) - y;
_state.SumSq = t;
}
}
else
{
// Warmup: Kahan addition
{
double y = value - _state.SumComp;
double t = _state.Sum + y;
_state.SumComp = (t - _state.Sum) - y;
_state.Sum = t;
}
{
double sq = value * value;
double y = sq - _state.SumSqComp;
double t = _state.SumSq + y;
_state.SumSqComp = (t - _state.SumSq) - y;
_state.SumSq = t;
}
}
_buffer.Add(value);
}
else
{
_state = _p_state;
// Update the newest value in buffer
_buffer.UpdateNewest(value);
RecalculateSums();
}
int count = _buffer.Count;
if (count == 0)
{
Last = new TValue(input.Time, 0.5);
PubEvent(Last, isNew);
return Last;
}
double mean = _state.Sum / count;
double variance = Math.Max(0.0, (_state.SumSq / count) - (mean * mean));
double stddev = Math.Sqrt(variance);
double dev = _multiplier * stddev;
double upper = mean + dev;
double lower = mean - dev;
double width = upper - lower;
double bbb = width > 0.0 ? (value - lower) / width : 0.5;
Last = new TValue(input.Time, bbb);
PubEvent(Last, isNew);
return Last;
}
public override TSeries Update(TSeries source)
{
Reset();
int len = source.Count;
var t = new List(len);
var v = new List(len);
CollectionsMarshal.SetCount(t, len);
CollectionsMarshal.SetCount(v, len);
var tSpan = CollectionsMarshal.AsSpan(t);
var vSpan = CollectionsMarshal.AsSpan(v);
source.Times.CopyTo(tSpan);
for (int i = 0; i < len; i++)
{
vSpan[i] = Update(new TValue(tSpan[i], source.Values[i]), isNew: true).Value;
}
return new TSeries(t, v);
}
///
/// Calculates BBB for entire series.
///
public static TSeries Batch(TSeries source, int period = 20, double multiplier = 2.0)
{
int len = source.Count;
var t = new List(len);
var v = new List(len);
CollectionsMarshal.SetCount(t, len);
CollectionsMarshal.SetCount(v, len);
var tSpan = CollectionsMarshal.AsSpan(t);
var vSpan = CollectionsMarshal.AsSpan(v);
Batch(source.Values, vSpan, period, multiplier);
source.Times.CopyTo(tSpan);
return new TSeries(t, v);
}
///
/// Batch BBB calculation with O(1) rolling variance.
///
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void Batch(ReadOnlySpan source, Span output, int period = 20, double multiplier = 2.0)
{
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));
}
if (multiplier <= 0)
{
throw new ArgumentException("Multiplier must be greater than 0", nameof(multiplier));
}
int len = source.Length;
if (len == 0)
{
return;
}
double sum = 0.0;
double sumSq = 0.0;
double lastValid = 0.0;
double mult = multiplier;
var valueBuffer = new RingBuffer(period);
for (int i = 0; i < len; i++)
{
double val = source[i];
if (!double.IsFinite(val))
{
val = lastValid;
}
else
{
lastValid = val;
}
if (i >= period)
{
double oldest = valueBuffer.Oldest;
sum -= oldest;
sumSq -= oldest * oldest;
}
sum += val;
sumSq += val * val;
valueBuffer.Add(val);
int count = Math.Min(i + 1, period);
double mean = sum / count;
double variance = Math.Max(0.0, (sumSq / count) - (mean * mean));
double stddev = Math.Sqrt(variance);
double dev = mult * stddev;
double upper = mean + dev;
double lower = mean - dev;
double width = upper - lower;
output[i] = width > 0.0 ? (val - lower) / width : 0.5;
}
}
///
/// Calculates BBB and returns both results and the warm indicator.
///
public static (TSeries Results, Bbb Indicator) Calculate(TSeries source, int period = 20, double multiplier = 2.0)
{
var indicator = new Bbb(period, multiplier);
TSeries results = indicator.Update(source);
return (results, indicator);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void RecalculateSums()
{
_state.Sum = 0.0;
_state.SumSq = 0.0;
for (int i = 0; i < _buffer.Count; i++)
{
double v = _buffer[i];
_state.Sum += v;
_state.SumSq += v * v;
}
}
public override void Prime(ReadOnlySpan source, TimeSpan? step = null)
{
for (int i = 0; i < source.Length; i++)
{
Update(new TValue(DateTime.UtcNow, source[i]), isNew: true);
}
}
public override void Reset()
{
_buffer.Clear();
_state = default;
_p_state = default;
Last = default;
}
}