convert to naming for static series

DaveSkender · Oct 14, 2024 · 70c6d60 · 70c6d60
1 parent 5df1ffd
commit 70c6d60
Show file tree

Hide file tree

Showing 193 changed files with 1,115 additions and 1,166 deletions.
diff --git a/src/_common/ObsoleteV3.cs b/src/_common/ObsoleteV3.cs
@@ -42,28 +42,28 @@ public static IEnumerable<EmaResult> GetEma<TQuote>(
     public static IEnumerable<AdlResult> GetAdl<TQuote>(
         this IEnumerable<TQuote> quotes, int smaPeriods)
         where TQuote : IQuote
-        => quotes.ToSortedList().CalcAdl();
+        => quotes.ToSortedList().ToAdl();
 
     [ExcludeFromCodeCoverage]
     [Obsolete("Use a chained `results.GetSma(smaPeriods)` to generate a moving average.", true)] // v3.0.0
     public static IEnumerable<ObvResult> GetObv<TQuote>(
         this IEnumerable<TQuote> quotes, int smaPeriods)
         where TQuote : IQuote
-        => quotes.GetObv();
+        => quotes.ToObv();
 
     [ExcludeFromCodeCoverage]
     [Obsolete("Use a chained `results.GetSma(smaPeriods)` to generate a moving average.", true)] // v3.0.0
     public static IEnumerable<PrsResult> GetPrs<TQuote>(
         this IEnumerable<TQuote> quotesEval, IEnumerable<TQuote> quotesBase, int lookbackPeriods, int smaPeriods)
         where TQuote : IQuote
-        => quotesEval.Use(CandlePart.Close).GetPrs(quotesBase.Use(CandlePart.Close), lookbackPeriods);
+        => quotesEval.Use(CandlePart.Close).ToPrs(quotesBase.Use(CandlePart.Close), lookbackPeriods);
 
     [ExcludeFromCodeCoverage]
     [Obsolete("Use a chained `results.GetSma(smaPeriods)` to generate a moving average.", true)] // v3.0.0
     public static IEnumerable<RocResult> GetRoc<TQuote>(
         this IEnumerable<TQuote> quotes, int lookbackPeriods, int smaPeriods)
         where TQuote : IQuote
-        => quotes.Use(CandlePart.Close).GetRoc(lookbackPeriods);
+        => quotes.Use(CandlePart.Close).ToRoc(lookbackPeriods);
 
     [ExcludeFromCodeCoverage]
     [Obsolete("Use a chained `results.GetSma(smaPeriods)` to generate a moving average.", true)] // v3.0.0

diff --git a/src/a-d/Adl/Adl.Api.cs b/src/a-d/Adl/Adl.Api.cs
@@ -4,25 +4,6 @@ namespace Skender.Stock.Indicators;
 
 public static partial class Adl
 {
-    // SERIES, from TQuote
-    ///<summary>
-    ///Accumulation / Distribution Line(ADL) is a rolling accumulation of Chaikin Money Flow Volume.
-    ///<para>
-    ///See
-    ///<see href="https://dotnet.StockIndicators.dev/indicators/Adl/#content?utm_source=library&amp;utm_medium=inline-help&amp;utm_campaign=embedded"> documentation</see>
-    ///for more information.
-    ///</para>
-    ///</summary>
-    ///<typeparam name = "TQuote" > Configurable Quote type. See Guide for more information.</typeparam>
-    ///<param name="quotes">Historical price quotes.</param>
-    ///<returns>Time series of ADL values.</returns>
-    public static IReadOnlyList<AdlResult> GetAdl<TQuote>(
-        this IEnumerable<TQuote> quotes)
-        where TQuote : IQuote
-        => quotes
-            .ToSortedList()
-            .CalcAdl();
-
     // OBSERVER, from Quote Provider
     public static AdlHub<TIn> ToAdl<TIn>(
         this IQuoteProvider<TIn> quoteProvider)

diff --git a/src/a-d/Adl/Adl.StaticSeries.cs b/src/a-d/Adl/Adl.StaticSeries.cs
@@ -4,10 +4,12 @@ namespace Skender.Stock.Indicators;
 
 public static partial class Adl
 {
-    internal static List<AdlResult> CalcAdl<TQuote>(
-        this List<TQuote> source)
+    public static IReadOnlyList<AdlResult> ToAdl<TQuote>(
+        this IReadOnlyList<TQuote> source)
         where TQuote : IQuote
     {
+        ArgumentNullException.ThrowIfNull(source);
+
         // initialize
         int length = source.Count;
         List<AdlResult> results = new(length);

diff --git a/src/a-d/Adx/Adx.Api.cs b/src/a-d/Adx/Adx.Api.cs
@@ -2,12 +2,12 @@ namespace Skender.Stock.Indicators;
 
 // AVERAGE DIRECTIONAL INDEX (API)
 
-public static partial class Indicator
+public static partial class Adx
 {
     // SERIES, from TQuote
     /// <include file='./info.xml' path='info/type[@name="standard"]/*' />
     ///
-    public static IReadOnlyList<AdxResult> GetAdx<TQuote>(
+    public static IReadOnlyList<AdxResult> ToAdx<TQuote>(
         this IEnumerable<TQuote> quotes,
         int lookbackPeriods = 14)
         where TQuote : IQuote => quotes

diff --git a/src/a-d/Adx/Adx.Common.cs b/src/a-d/Adx/Adx.Common.cs
diff --git a/src/a-d/Adx/Adx.StaticSeries.cs b/src/a-d/Adx/Adx.StaticSeries.cs
@@ -2,7 +2,7 @@ namespace Skender.Stock.Indicators;
 
 // AVERAGE DIRECTIONAL INDEX (SERIES)
 
-public static partial class Indicator
+public static partial class Adx
 {
     private static List<AdxResult> CalcAdx(
         this List<QuoteD> source,

diff --git a/src/a-d/Adx/Adx.Utilities.cs b/src/a-d/Adx/Adx.Utilities.cs
@@ -1,6 +1,6 @@
 namespace Skender.Stock.Indicators;
 
-public static partial class Indicator
+public static partial class Adx
 {
     // remove recommended periods
     /// <inheritdoc cref="Utility.RemoveWarmupPeriods{T}(IReadOnlyList{T})"/>
@@ -13,4 +13,16 @@ public static IReadOnlyList<AdxResult> RemoveWarmupPeriods(
 
         return results.Remove(2 * n + 100);
     }
+
+    // parameter validation
+    internal static void Validate(
+        int lookbackPeriods)
+    {
+        // check parameter arguments
+        if (lookbackPeriods <= 1)
+        {
+            throw new ArgumentOutOfRangeException(nameof(lookbackPeriods), lookbackPeriods,
+                "Lookback periods must be greater than 1 for ADX.");
+        }
+    }
 }
diff --git a/src/a-d/Alligator/Alligator.Api.cs b/src/a-d/Alligator/Alligator.Api.cs
@@ -29,7 +29,7 @@ public static partial class Alligator
     /// <exception cref="ArgumentOutOfRangeException">
     /// Invalid parameter value provided.
     /// </exception>
-    public static IReadOnlyList<AlligatorResult> GetAlligator<T>(
+    public static IReadOnlyList<AlligatorResult> ToAlligator<T>(
         this IEnumerable<T> source,
         int jawPeriods = 13,
         int jawOffset = 8,

diff --git a/src/a-d/Alma/Alma.Api.cs b/src/a-d/Alma/Alma.Api.cs
@@ -4,7 +4,7 @@ namespace Skender.Stock.Indicators;
 public static partial class Indicator
 {
     // SERIES, from CHAIN
-    public static IReadOnlyList<AlmaResult> GetAlma<T>(
+    public static IReadOnlyList<AlmaResult> ToAlma<T>(
         this IReadOnlyList<T> results,
         int lookbackPeriods = 9,
         double offset = 0.85,

diff --git a/src/a-d/Aroon/Aroon.Api.cs b/src/a-d/Aroon/Aroon.Api.cs
@@ -1,12 +1,12 @@
 namespace Skender.Stock.Indicators;
 
 // AROON OSCILLATOR (API)
-public static partial class Indicator
+public static partial class Aroon
 {
     // SERIES, from TQuote
     /// <include file='./info.xml' path='info/*' />
     ///
-    public static IReadOnlyList<AroonResult> GetAroon<TQuote>(
+    public static IReadOnlyList<AroonResult> ToAroon<TQuote>(
         this IEnumerable<TQuote> quotes,
         int lookbackPeriods = 25)
         where TQuote : IQuote => quotes

diff --git a/src/a-d/Aroon/Aroon.Common.cs b/src/a-d/Aroon/Aroon.Common.cs
diff --git a/src/a-d/Aroon/Aroon.StaticSeries.cs b/src/a-d/Aroon/Aroon.StaticSeries.cs
@@ -2,14 +2,14 @@ namespace Skender.Stock.Indicators;
 
 // AROON OSCILLATOR (SERIES)
 
-public static partial class Indicator
+public static partial class Aroon
 {
     private static List<AroonResult> CalcAroon(
         this List<QuoteD> source,
         int lookbackPeriods)
     {
         // check parameter arguments
-        Aroon.Validate(lookbackPeriods);
+        Validate(lookbackPeriods);
 
         // initialize
         int length = source.Count;

diff --git a/src/a-d/Aroon/Aroon.Utilities.cs b/src/a-d/Aroon/Aroon.Utilities.cs
@@ -1,6 +1,6 @@
 namespace Skender.Stock.Indicators;
 
-public static partial class Indicator
+public static partial class Aroon
 {
     // remove recommended periods
     /// <inheritdoc cref="Utility.RemoveWarmupPeriods{T}(IReadOnlyList{T})"/>
@@ -13,4 +13,16 @@ public static IReadOnlyList<AroonResult> RemoveWarmupPeriods(
 
         return results.Remove(removePeriods);
     }
+
+    // parameter validation
+    internal static void Validate(
+        int lookbackPeriods)
+    {
+        // check parameter arguments
+        if (lookbackPeriods <= 0)
+        {
+            throw new ArgumentOutOfRangeException(nameof(lookbackPeriods), lookbackPeriods,
+                "Lookback periods must be greater than 0 for Aroon.");
+        }
+    }
 }
diff --git a/src/a-d/Atr/Atr.Api.cs b/src/a-d/Atr/Atr.Api.cs
@@ -7,7 +7,7 @@ public static partial class Atr
     // SERIES, from TQuote
     /// <include file='./info.xml' path='info/*' />
     ///
-    public static IReadOnlyList<AtrResult> GetAtr<TQuote>(
+    public static IReadOnlyList<AtrResult> ToAtr<TQuote>(
         this IEnumerable<TQuote> quotes,
         int lookbackPeriods = 14)
         where TQuote : IQuote => quotes

diff --git a/src/a-d/AtrStop/AtrStop.Api.cs b/src/a-d/AtrStop/AtrStop.Api.cs
@@ -7,7 +7,7 @@ public static partial class AtrStop
     // SERIES, from TQuote
     /// <include file='./info.xml' path='info/*' />
     ///
-    public static IReadOnlyList<AtrStopResult> GetAtrStop<TQuote>(
+    public static IReadOnlyList<AtrStopResult> ToAtrStop<TQuote>(
         this IEnumerable<TQuote> quotes,
         int lookbackPeriods = 21,
         double multiplier = 3,

diff --git a/src/a-d/Awesome/Awesome.Api.cs b/src/a-d/Awesome/Awesome.Api.cs
@@ -1,10 +1,10 @@
 namespace Skender.Stock.Indicators;
 
 // AWESOME OSCILLATOR (API)
-public static partial class Indicator
+public static partial class Awesome
 {
     // SERIES, from CHAIN
-    public static IReadOnlyList<AwesomeResult> GetAwesome<T>(
+    public static IReadOnlyList<AwesomeResult> ToAwesome<T>(
         this IEnumerable<T> source,
         int fastPeriods = 5,
         int slowPeriods = 34)

diff --git a/src/a-d/Awesome/Awesome.Common.cs b/src/a-d/Awesome/Awesome.Common.cs
diff --git a/src/a-d/Awesome/Awesome.StaticSeries.cs b/src/a-d/Awesome/Awesome.StaticSeries.cs
@@ -2,7 +2,7 @@ namespace Skender.Stock.Indicators;
 
 // AWESOME OSCILLATOR (SERIES)
 
-public static partial class Indicator
+public static partial class Awesome
 {
     private static List<AwesomeResult> CalcAwesome<T>(
         this List<T> source,

diff --git a/src/a-d/Awesome/Awesome.Utilities.cs b/src/a-d/Awesome/Awesome.Utilities.cs
@@ -1,6 +1,6 @@
 namespace Skender.Stock.Indicators;
 
-public static partial class Indicator
+public static partial class Awesome
 {
     // remove recommended periods
     /// <inheritdoc cref="Utility.RemoveWarmupPeriods{T}(IReadOnlyList{T})"/>
@@ -13,4 +13,23 @@ public static IReadOnlyList<AwesomeResult> RemoveWarmupPeriods(
 
         return results.Remove(removePeriods);
     }
+
+    // parameter validation
+    internal static void Validate(
+        int fastPeriods,
+        int slowPeriods)
+    {
+        // check parameter arguments
+        if (fastPeriods <= 0)
+        {
+            throw new ArgumentOutOfRangeException(nameof(slowPeriods), slowPeriods,
+                "Fast periods must be greater than 0 for Awesome Oscillator.");
+        }
+
+        if (slowPeriods <= fastPeriods)
+        {
+            throw new ArgumentOutOfRangeException(nameof(slowPeriods), slowPeriods,
+                "Slow periods must be larger than Fast Periods for Awesome Oscillator.");
+        }
+    }
 }
diff --git a/src/a-d/Beta/Beta.Api.cs b/src/a-d/Beta/Beta.Api.cs
@@ -1,10 +1,10 @@
 namespace Skender.Stock.Indicators;
 
 // BETA COEFFICIENT (API)
-public static partial class Indicator
+public static partial class Beta
 {
     // SERIES, from CHAINS (both inputs reusable)
-    public static IReadOnlyList<BetaResult> GetBeta<T>(
+    public static IReadOnlyList<BetaResult> ToBeta<T>(
         this IEnumerable<T> evalSource,
         IEnumerable<T> mrktSource,
         int lookbackPeriods,

diff --git a/src/a-d/Beta/Beta.Common.cs b/src/a-d/Beta/Beta.Common.cs
diff --git a/src/a-d/Beta/Beta.StaticSeries.cs b/src/a-d/Beta/Beta.StaticSeries.cs
@@ -2,7 +2,7 @@ namespace Skender.Stock.Indicators;
 
 // BETA COEFFICIENT (SERIES)
 
-public static partial class Indicator
+public static partial class Beta
 {
     // NOTE: sequence swapped from API
     private static List<BetaResult> CalcBeta<T>(
@@ -146,7 +146,7 @@ private static List<BetaResult> CalcBeta<T>(
         }
 
         // calculate correlation, covariance, and variance
-        CorrResult c = PeriodCorrelation(
+        CorrResult c = Correlation.PeriodCorrelation(
             default,
             [.. dataA],
             [.. dataB]);