Files
QuanTAlib/lib/core/avgprice/Avgprice.cs
T
Miha Kralj 1910fdca93 chore: repo cleanup and code quality improvements
- Remove global.json (SDK pinning unnecessary)

- Remove nuget.config, move MyGet source to .csproj RestoreAdditionalProjectSources

- Gitignore ndepend/ entirely, move badges to docs/img/

- Update README.md and docs/ndepend.md badge paths

- Add NDepend project property to QuanTAlib.slnx

- Expand .editorconfig ReSharper/diagnostic suppressions

- Use ArgumentOutOfRangeException instead of ArgumentException

- Use discard _ for unused event sender parameters

- Remove quantalib.code-workspace and sonar-suppressions.json

- Add filter signature SVGs
2026-03-03 09:22:55 -08:00

277 lines
8.1 KiB
C#

using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
namespace QuanTAlib;
/// <summary>
/// AVGPRICE: Average Price
/// Calculates the average of Open, High, Low, and Close prices.
/// Equivalent to TBar.OHLC4 but as a proper streaming indicator with bar correction.
/// </summary>
/// <remarks>
/// <b>Calculation:</b>
/// <list type="number">
/// <item>AvgPrice = (Open + High + Low + Close) / 4</item>
/// </list>
///
/// <b>Key characteristics:</b>
/// <list type="bullet">
/// <item>Stateless bar-by-bar calculation (no lookback period)</item>
/// <item>TA-Lib compatible (AVGPRICE function)</item>
/// <item>Always hot after first bar</item>
/// <item>Useful as a smoothed input for other indicators</item>
/// </list>
/// </remarks>
[SkipLocalsInit]
public sealed class Avgprice : AbstractBase
{
[StructLayout(LayoutKind.Auto)]
private record struct State(
double LastValidOpen,
double LastValidHigh,
double LastValidLow,
double LastValidClose,
double LastResult,
int Count
);
private State _s;
private State _ps;
/// <summary>
/// Initializes a new instance of the Avgprice class.
/// </summary>
public Avgprice()
{
WarmupPeriod = 1;
Name = "Avgprice";
_s = new State(0, 0, 0, 0, 0, 0);
_ps = _s;
}
/// <summary>
/// Initializes a new instance of the Avgprice class with a source.
/// </summary>
/// <param name="source">The data source for chaining.</param>
public Avgprice(ITValuePublisher source) : this()
{
source.Pub += Handle;
}
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 => _s.Count >= WarmupPeriod;
/// <summary>
/// Computes the average price from OHLC values.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static double ComputeAvgPrice(double open, double high, double low, double close)
{
return Math.FusedMultiplyAdd(open + high, 0.25, (low + close) * 0.25);
}
/// <summary>
/// Updates the indicator with a TValue input.
/// For TValue input, treats the value as all four OHLC prices (result = value).
/// Prefer Update(TBar) for standard OHLC data.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override TValue Update(TValue input, bool isNew = true)
{
return UpdateCore(input.Time, input.Value, input.Value, input.Value, input.Value, isNew);
}
/// <summary>
/// Updates the indicator with a new bar (preferred method).
/// </summary>
/// <param name="bar">The input bar.</param>
/// <param name="isNew">Whether this is a new bar or an update.</param>
/// <returns>The calculated Average Price value.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public TValue Update(TBar bar, bool isNew = true)
{
return UpdateCore(bar.Time, bar.Open, bar.High, bar.Low, bar.Close, isNew);
}
/// <summary>
/// Updates the indicator with a bar series.
/// </summary>
/// <param name="source">The source bar series.</param>
/// <returns>A TSeries containing the Average Price values.</returns>
public TSeries Update(TBarSeries source)
{
if (source.Count == 0)
{
return [];
}
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.OpenValues, source.HighValues, source.LowValues, source.CloseValues, vSpan);
for (int i = 0; i < len; i++)
{
tSpan[i] = source[i].Time;
}
// Update internal state
for (int i = 0; i < len; i++)
{
Update(source[i], isNew: true);
}
return new TSeries(t, v);
}
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);
var values = source.Values;
// TValue-only: result = value (identity)
for (int i = 0; i < len; i++)
{
tSpan[i] = source.Times[i];
vSpan[i] = values[i];
}
// Update internal state
for (int i = 0; i < len; i++)
{
Update(new TValue(source.Times[i], values[i]), isNew: true);
}
return new TSeries(t, v);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private TValue UpdateCore(long timeTicks, double open, double high, double low, double close, bool isNew)
{
if (isNew)
{
_ps = _s;
}
else
{
_s = _ps;
}
var s = _s;
// Handle non-finite values — use last valid values
if (!double.IsFinite(open)) { open = s.LastValidOpen; } else { s.LastValidOpen = open; }
if (!double.IsFinite(high)) { high = s.LastValidHigh; } else { s.LastValidHigh = high; }
if (!double.IsFinite(low)) { low = s.LastValidLow; } else { s.LastValidLow = low; }
if (!double.IsFinite(close)) { close = s.LastValidClose; } else { s.LastValidClose = close; }
double result = ComputeAvgPrice(open, high, low, close);
if (!double.IsFinite(result))
{
result = s.LastResult;
}
else
{
s.LastResult = result;
}
if (isNew) { s.Count++; }
_s = s;
Last = new TValue(timeTicks, result);
PubEvent(Last, isNew);
return Last;
}
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);
}
}
public override void Reset()
{
_s = new State(0, 0, 0, 0, 0, 0);
_ps = _s;
Last = default;
}
/// <summary>
/// Calculates Average Price for a bar series (static).
/// </summary>
public static TSeries Batch(TBarSeries source)
{
var indicator = new Avgprice();
return indicator.Update(source);
}
/// <summary>
/// Batch calculation using spans for OHLC data.
/// </summary>
public static void Batch(
ReadOnlySpan<double> open,
ReadOnlySpan<double> high,
ReadOnlySpan<double> low,
ReadOnlySpan<double> close,
Span<double> output)
{
int len = open.Length;
if (high.Length != len || low.Length != len || close.Length != len)
{
throw new ArgumentException("All input spans must have the same length", nameof(high));
}
if (output.Length < len)
{
throw new ArgumentException("Output span must be at least as long as input spans", nameof(output));
}
for (int i = 0; i < len; i++)
{
output[i] = ComputeAvgPrice(open[i], high[i], low[i], close[i]);
}
}
/// <summary>
/// Batch calculation using a TBarSeries (convenience overload).
/// </summary>
public static void Batch(TBarSeries source, Span<double> output)
{
int len = source.Count;
if (output.Length < len)
{
throw new ArgumentException("Output span must be at least as long as source", nameof(output));
}
if (len == 0)
{
return;
}
Batch(source.OpenValues, source.HighValues, source.LowValues, source.CloseValues, output);
}
public static (TSeries Results, Avgprice Indicator) Calculate(TBarSeries source)
{
var indicator = new Avgprice();
TSeries results = indicator.Update(source);
return (results, indicator);
}
}