Improve quantileSeq typings (#3198)

* Improve quantileSeq typings * Add tests, revert comment changes * Fix type tests
josdejong · May 16, 2024 · ffa3a2e · ffa3a2e
1 parent 599f4ee
commit ffa3a2e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/test/typescript-tests/testTypes.ts b/test/typescript-tests/testTypes.ts
@@ -2454,7 +2454,7 @@ MathNode examples
 }
 
 /*
-min/max return types
+Statistics functions' return types
 */
 {
   const math = create(all, {})
@@ -2526,6 +2526,18 @@ min/max return types
   expectTypeOf(math.median(123, math.bignumber('456'))).toMatchTypeOf<
     number | BigNumber | Fraction | Complex | Unit
   >()
+
+  expectTypeOf(math.quantileSeq([1, 2, 3], 0.75)).toMatchTypeOf<number>()
+  expectTypeOf(math.quantileSeq([[1, 2, 3]], 0.75)).toMatchTypeOf<number>()
+  expectTypeOf(
+    math.quantileSeq([math.bignumber('123')], 0.75)
+  ).toMatchTypeOf<BigNumber>()
+  expectTypeOf(math.quantileSeq(math.matrix([1, 2, 3]), 0.75)).toMatchTypeOf<
+    MathScalarType | MathArray
+  >()
+  expectTypeOf(
+    math.quantileSeq([math.unit('5cm'), math.unit('10cm')], 0.75)
+  ).toMatchTypeOf<Unit>()
 }
 
 /*

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -2805,6 +2805,19 @@ export interface MathJsInstance extends MathJsFactory {
    */
   prod(A: MathCollection): MathScalarType
 
+  /**
+   * @param A A single matrix
+   * @param probOrN prob is the order of the quantile, while N is the
+   * amount of evenly distributed steps of probabilities; only one of
+   * these options can be provided
+   * @param sorted =false is data sorted in ascending order
+   * @returns Quantile(s)
+   */
+  quantileSeq<T extends MathScalarType>(
+    A: T[] | T[][],
+    prob: number | BigNumber | MathArray,
+    sorted?: boolean
+  ): T
   /**
    * Compute the prob order quantile of a matrix or a list with values.
    * The sequence is sorted and the middle value is returned. Supported
@@ -2823,7 +2836,7 @@ export interface MathJsInstance extends MathJsFactory {
     A: MathCollection,
     prob: number | BigNumber | MathArray,
     sorted?: boolean
-  ): number | BigNumber | Unit | MathArray
+  ): MathScalarType | MathArray
 
   /**
    * Compute the standard deviation of a matrix or a list with values. The