fix: public interface (#973)

* add missing public tuple method
* update unit tests
* fix Numerix tests

Author: DaveSkender

src/_common/Results/Result.Utilities.cs

@@ -36,7 +36,7 @@ public static IEnumerable<TResult> Condense<TResult>(
         List<TResult> resultsList = results
             .ToList();
 
-        resultsList
+        _ = resultsList
             .RemoveAll(match:
                 x => x.Value is null or (double and double.NaN));
 
@@ -128,7 +128,7 @@ public static IEnumerable<TResultR> SyncIndex<TResultR, TResultM>(
                 }
             }
 
-            resultsList.RemoveAll(x => toRemove.Contains(x));
+            _ = resultsList.RemoveAll(x => toRemove.Contains(x));
         }
 
         return resultsList.ToSortedList();
@@ -160,9 +160,14 @@ public static IEnumerable<TResultR> SyncIndex<TResultR, TResultM>(
     }
 
     // CONVERT TO TUPLE with nullable value option and no pruning
+    public static Collection<(DateTime Date, double? Value)> ToTupleCollection(
+        this IEnumerable<IReusableResult> reusable, NullTo nullTo)
+        => reusable
+            .ToTuple(nullTo)
+            .ToCollection();
+
     internal static List<(DateTime Date, double? Value)> ToTuple(
-        this IEnumerable<IReusableResult> reusable,
-        NullTo nullTo)
+        this IEnumerable<IReusableResult> reusable, NullTo nullTo)
     {
         List<IReusableResult> reList = reusable.ToList();
         int length = reList.Count;

tests/indicators/_common/Test.Numerics.cs tests/indicators/_common/Test.Numerix.cstests/indicators/_common/Test.Numerics.cs renamed to tests/indicators/_common/Test.Numerix.cs

@@ -4,12 +4,15 @@
 namespace Internal.Tests;
 
 [TestClass]
-public class NumericsTests : TestBase
+public class NumerixTests : TestBase
 {
     private readonly double[] closePrice = longishQuotes
         .Select(x => (double)x.Close)
         .ToArray();
 
+    private readonly double[] x = { 1, 2, 3, 4, 5 };
+    private readonly double[] y = { 0, 0, 0, 0 };
+
     [TestMethod]
     public void StdDev()
     {
@@ -18,6 +21,42 @@ public void StdDev()
         Assert.AreEqual(633.932098287, Math.Round(sd, 9));
     }
 
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentNullException), "Null parameter.")]
+    public void StdDevNull()
+    {
+        double sd = Numerix.StdDev(null);
+    }
+
+    [TestMethod]
+    public void Slope()
+    {
+        double s = Numerix.Slope(x, x);
+
+        Assert.AreEqual(1d, s);
+    }
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentNullException), "Null X parameter.")]
+    public void SlopeXnull()
+    {
+        double s = Numerix.Slope(null, x);
+    }
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentNullException), "Null Y parameter.")]
+    public void SlopeYnull()
+    {
+        double s = Numerix.Slope(x, null);
+    }
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentException), "X and Y different lengths.")]
+    public void SlopeMismatch()
+    {
+        double s = Numerix.Slope(x, y);
+    }
+
     [TestMethod]
     public void RoundDownDate()
     {

tests/indicators/_common/Test.QuoteUtility.cs

@@ -1,3 +1,4 @@
+using System.Collections.ObjectModel;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Skender.Stock.Indicators;
 
@@ -64,14 +65,39 @@ public void QuoteToTuple()
             NullMath.Round(q.ToTuple(CandlePart.OHLC4).value, 10));
 
         // bad argument
-        Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
+        _ = Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
             q.ToTuple((CandlePart)999));
 
         // bad argument
-        Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
+        _ = Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
             q.ToBasicData((CandlePart)999));
     }
 
+    [TestMethod]
+    public void ToTupleCollection()
+    {
+        Collection<(DateTime, double)> collection = quotes
+            .OrderBy(x => x.Date)
+            .ToTupleCollection(CandlePart.Close);
+
+        Assert.IsNotNull(collection);
+        Assert.AreEqual(502, collection.Count);
+        Assert.AreEqual(collection.LastOrDefault().Item2, 245.28d);
+    }
+
+    [TestMethod]
+    public void ToSortedList()
+    {
+        Collection<(DateTime, double)> collection = quotes
+            .OrderBy(x => x.Date)
+            .ToTuple(CandlePart.Close)
+            .ToSortedCollection();
+
+        Assert.IsNotNull(collection);
+        Assert.AreEqual(502, collection.Count);
+        Assert.AreEqual(collection.LastOrDefault().Item2, 245.28d);
+    }
+
     [TestMethod]
     public void QuoteToBasicData()
     {
@@ -130,7 +156,7 @@ public void QuoteToBasicData()
             NullMath.Round(q.ToBasicData(CandlePart.OHLC4).Value, 10));
 
         // bad argument
-        Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
+        _ = Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
             q.ToBasicData((CandlePart)999));
     }
 
@@ -192,7 +218,7 @@ public void QuoteDToTuple()
             NullMath.Round(q.ToTuple(CandlePart.OHLC4).Item2, 10));
 
         // bad argument
-        Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
+        _ = Assert.ThrowsException<ArgumentOutOfRangeException>(() =>
             q.ToTuple((CandlePart)999));
     }
 }

tests/indicators/_common/Test.ResultUtility.cs

@@ -1,3 +1,4 @@
+using System.Collections.ObjectModel;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Skender.Stock.Indicators;
 
@@ -194,5 +195,30 @@ public void ToTuple()
 
         Assert.AreEqual(0, nullableResults.Count(x => x.Value is null));
         Assert.AreEqual(4, nullableResults.Count(x => x.Value is double.NaN));
+
+        // PUBLIC VARIANT
+        // default to NaN with pruning
+        Collection<(DateTime Date, double Value)> cnaNresults = baseline.ToTupleCollection();
+
+        Assert.AreEqual(5, cnaNresults.Count(x => !double.IsNaN(x.Value)));
+        Assert.AreEqual(2, cnaNresults.Count(x => double.IsNaN(x.Value)));
+
+        // with null option
+        Collection<(DateTime Date, double? Value)> cnullResults = baseline.ToTupleCollection(NullTo.Null);
+
+        Assert.AreEqual(3, cnullResults.Count(x => x.Value is null));
+        Assert.AreEqual(1, cnullResults.Count(x => x.Value is double.NaN));
+
+        // with explicit nullable NaN option
+        Collection<(DateTime Date, double? Value)> cnullableResults = baseline.ToTupleCollection(NullTo.NaN);
+
+        Assert.AreEqual(0, cnullableResults.Count(x => x.Value is null));
+        Assert.AreEqual(4, cnullableResults.Count(x => x.Value is double.NaN));
+
+        // PUBLIC VARIANT Sorted Collection
+        Collection<SmaResult> sortResults = baseline
+            .ToSortedCollection();
+
+        Assert.AreEqual(5, sortResults[4].Sma);
     }
 }