From 42e8680fc032f8c6f17085c238b2885205688767 Mon Sep 17 00:00:00 2001
From: Mark Baker <mark@lange.demon.co.uk>
Date: Tue, 2 Mar 2021 18:01:39 +0100
Subject: [PATCH] Statistics more unit tests (#1889)

* Additional unit tests
---
 .../Calculation/Statistical.php               | 14 +++++---
 .../Functions/LookupRef/ColumnTest.php        | 31 +++++++++++++++++
 .../Functions/LookupRef/RowTest.php           | 31 +++++++++++++++++
 .../Functions/Statistical/SkewTest.php        | 31 +++++++++++++++++
 .../Functions/Statistical/TrimMeanTest.php    | 32 +++++++++++++++++
 tests/data/Calculation/LookupRef/COLUMN.php   | 12 +++++++
 tests/data/Calculation/LookupRef/ROW.php      | 12 +++++++
 tests/data/Calculation/Statistical/COVAR.php  | 10 ++++++
 .../data/Calculation/Statistical/FORECAST.php | 18 ++++++++++
 .../Calculation/Statistical/INTERCEPT.php     | 10 ++++++
 tests/data/Calculation/Statistical/RSQ.php    | 10 ++++++
 tests/data/Calculation/Statistical/SKEW.php   | 20 +++++++++++
 tests/data/Calculation/Statistical/SLOPE.php  | 10 ++++++
 .../data/Calculation/Statistical/TRIMMEAN.php | 34 +++++++++++++++++++
 14 files changed, 271 insertions(+), 4 deletions(-)
 create mode 100644 tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/ColumnTest.php
 create mode 100644 tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/RowTest.php
 create mode 100644 tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/SkewTest.php
 create mode 100644 tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/TrimMeanTest.php
 create mode 100644 tests/data/Calculation/LookupRef/COLUMN.php
 create mode 100644 tests/data/Calculation/LookupRef/ROW.php
 create mode 100644 tests/data/Calculation/Statistical/SKEW.php
 create mode 100644 tests/data/Calculation/Statistical/TRIMMEAN.php

diff --git a/src/PhpSpreadsheet/Calculation/Statistical.php b/src/PhpSpreadsheet/Calculation/Statistical.php
index dc9c5b4489..0e15ecf4d0 100644
--- a/src/PhpSpreadsheet/Calculation/Statistical.php
+++ b/src/PhpSpreadsheet/Calculation/Statistical.php
@@ -2753,13 +2753,16 @@ public static function SKEW(...$args)
         $mean = Averages::AVERAGE($aArgs);
         $stdDev = StandardDeviations::STDEV($aArgs);
 
+        if ($stdDev === 0.0 || is_string($stdDev)) {
+            return Functions::DIV0();
+        }
+
         $count = $summer = 0;
         // Loop through arguments
         foreach ($aArgs as $k => $arg) {
-            if (
-                (is_bool($arg)) &&
-                (!Functions::isMatrixValue($k))
-            ) {
+            if ((is_bool($arg)) && (!Functions::isMatrixValue($k))) {
+            } elseif (!is_numeric($arg)) {
+                return Functions::VALUE();
             } else {
                 // Is it a numeric value?
                 if ((is_numeric($arg)) && (!is_string($arg))) {
@@ -3173,6 +3176,7 @@ public static function TRIMMEAN(...$args)
             if (($percent < 0) || ($percent > 1)) {
                 return Functions::NAN();
             }
+
             $mArgs = [];
             foreach ($aArgs as $arg) {
                 // Is it a numeric value?
@@ -3180,8 +3184,10 @@ public static function TRIMMEAN(...$args)
                     $mArgs[] = $arg;
                 }
             }
+
             $discard = floor(Counts::COUNT($mArgs) * $percent / 2);
             sort($mArgs);
+
             for ($i = 0; $i < $discard; ++$i) {
                 array_pop($mArgs);
                 array_shift($mArgs);
diff --git a/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/ColumnTest.php b/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/ColumnTest.php
new file mode 100644
index 0000000000..203ee47987
--- /dev/null
+++ b/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/ColumnTest.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\LookupRef;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\LookupRef;
+use PHPUnit\Framework\TestCase;
+
+class ColumnTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        Functions::setCompatibilityMode(Functions::COMPATIBILITY_EXCEL);
+    }
+
+    /**
+     * @dataProvider providerCOLUMN
+     *
+     * @param mixed $expectedResult
+     */
+    public function testCOLUMN($expectedResult, string $cellReference): void
+    {
+        $result = LookupRef::COLUMN($cellReference);
+        self::assertSame($expectedResult, $result);
+    }
+
+    public function providerCOLUMN()
+    {
+        return require 'tests/data/Calculation/LookupRef/COLUMN.php';
+    }
+}
diff --git a/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/RowTest.php b/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/RowTest.php
new file mode 100644
index 0000000000..9471e64750
--- /dev/null
+++ b/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/RowTest.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\LookupRef;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\LookupRef;
+use PHPUnit\Framework\TestCase;
+
+class RowTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        Functions::setCompatibilityMode(Functions::COMPATIBILITY_EXCEL);
+    }
+
+    /**
+     * @dataProvider providerROW
+     *
+     * @param mixed $expectedResult
+     */
+    public function testROW($expectedResult, string $cellReference): void
+    {
+        $result = LookupRef::ROW($cellReference);
+        self::assertSame($expectedResult, $result);
+    }
+
+    public function providerROW()
+    {
+        return require 'tests/data/Calculation/LookupRef/ROW.php';
+    }
+}
diff --git a/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/SkewTest.php b/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/SkewTest.php
new file mode 100644
index 0000000000..79714d3f67
--- /dev/null
+++ b/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/SkewTest.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\Statistical;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\Statistical;
+use PHPUnit\Framework\TestCase;
+
+class SkewTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        Functions::setCompatibilityMode(Functions::COMPATIBILITY_EXCEL);
+    }
+
+    /**
+     * @dataProvider providerSKEW
+     *
+     * @param mixed $expectedResult
+     */
+    public function testSKEW($expectedResult, array $args): void
+    {
+        $result = Statistical::SKEW($args);
+        self::assertEqualsWithDelta($expectedResult, $result, 1E-12);
+    }
+
+    public function providerSKEW()
+    {
+        return require 'tests/data/Calculation/Statistical/SKEW.php';
+    }
+}
diff --git a/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/TrimMeanTest.php b/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/TrimMeanTest.php
new file mode 100644
index 0000000000..cfcb16097f
--- /dev/null
+++ b/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/TrimMeanTest.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\Statistical;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\Statistical;
+use PHPUnit\Framework\TestCase;
+
+class TrimMeanTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        Functions::setCompatibilityMode(Functions::COMPATIBILITY_EXCEL);
+    }
+
+    /**
+     * @dataProvider providerTRIMMEAN
+     *
+     * @param mixed $expectedResult
+     * @param mixed $percentage
+     */
+    public function testTRIMMEAN($expectedResult, array $args, $percentage): void
+    {
+        $result = Statistical::TRIMMEAN($args, $percentage);
+        self::assertEqualsWithDelta($expectedResult, $result, 1E-12);
+    }
+
+    public function providerTRIMMEAN()
+    {
+        return require 'tests/data/Calculation/Statistical/TRIMMEAN.php';
+    }
+}
diff --git a/tests/data/Calculation/LookupRef/COLUMN.php b/tests/data/Calculation/LookupRef/COLUMN.php
new file mode 100644
index 0000000000..14fd28a753
--- /dev/null
+++ b/tests/data/Calculation/LookupRef/COLUMN.php
@@ -0,0 +1,12 @@
+<?php
+
+return [
+    [
+        2,
+        'B13',
+    ],
+    [
+        [2, 3, 4],
+        'B2:D2',
+    ],
+];
diff --git a/tests/data/Calculation/LookupRef/ROW.php b/tests/data/Calculation/LookupRef/ROW.php
new file mode 100644
index 0000000000..0777687603
--- /dev/null
+++ b/tests/data/Calculation/LookupRef/ROW.php
@@ -0,0 +1,12 @@
+<?php
+
+return [
+    [
+        10,
+        'C10',
+    ],
+    [
+        [[10], [11], [12]],
+        'C10:C12',
+    ],
+];
diff --git a/tests/data/Calculation/Statistical/COVAR.php b/tests/data/Calculation/Statistical/COVAR.php
index d361a352e4..b1cd29086c 100644
--- a/tests/data/Calculation/Statistical/COVAR.php
+++ b/tests/data/Calculation/Statistical/COVAR.php
@@ -16,4 +16,14 @@
         [2, 7, 8, 3, 4, 1, 6, 5],
         [22.9, 33.49, 34.5, 27.61, 19.5, 10.11, 37.9, 31.08],
     ],
+    [
+        '#N/A',
+        [1, 2, 3],
+        [4, 5],
+    ],
+    [
+        '#DIV/0!',
+        [1, 2, 3],
+        [4, null, null],
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/FORECAST.php b/tests/data/Calculation/Statistical/FORECAST.php
index 77d2ab8fc4..d14ea0a063 100644
--- a/tests/data/Calculation/Statistical/FORECAST.php
+++ b/tests/data/Calculation/Statistical/FORECAST.php
@@ -43,4 +43,22 @@
         [3, 7, 15, 20, 22, 27],
         [1, 2, 3, 4, 5, 6],
     ],
+    [
+        '#VALUE!',
+        'NaN',
+        [1, 2, 3],
+        [4, 5],
+    ],
+    [
+        '#N/A',
+        2,
+        [1, 2, 3],
+        [4, 5],
+    ],
+    [
+        '#DIV/0!',
+        2,
+        [1, 2, 3],
+        [4, null, null],
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/INTERCEPT.php b/tests/data/Calculation/Statistical/INTERCEPT.php
index f68fdd9819..f4f25a28da 100644
--- a/tests/data/Calculation/Statistical/INTERCEPT.php
+++ b/tests/data/Calculation/Statistical/INTERCEPT.php
@@ -26,4 +26,14 @@
         [6, 9, 17, 20, 20, 27],
         [1, 2, 3, 4, 5, 6],
     ],
+    [
+        '#N/A',
+        [1, 2, 3],
+        [4, 5],
+    ],
+    [
+        '#DIV/0!',
+        [1, 2, 3],
+        [4, null, null],
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/RSQ.php b/tests/data/Calculation/Statistical/RSQ.php
index 740a2f4b6a..f414ef555b 100644
--- a/tests/data/Calculation/Statistical/RSQ.php
+++ b/tests/data/Calculation/Statistical/RSQ.php
@@ -11,4 +11,14 @@
         [2, 7, 8, 3, 4, 1, 6, 5],
         [22.9, 33.49, 34.5, 27.61, 19.5, 10.11, 37.90, 31.08],
     ],
+    [
+        '#N/A',
+        [1, 2, 3],
+        [4, 5],
+    ],
+    [
+        '#DIV/0!',
+        [1, 2, 3],
+        [4, null, null],
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/SKEW.php b/tests/data/Calculation/Statistical/SKEW.php
new file mode 100644
index 0000000000..2648f59f24
--- /dev/null
+++ b/tests/data/Calculation/Statistical/SKEW.php
@@ -0,0 +1,20 @@
+<?php
+
+return [
+    [
+        0.359543071407,
+        [3, 4, 5, 2, 3, 4, 5, 6, 4, 7],
+    ],
+    [
+        0.863378312234,
+        [1, 1, 2, 2, 2, 2, 3, 3, 3, 4, 4, 5, 6, 7, 8],
+    ],
+    [
+        '#VALUE!',
+        [1, 1, 2, 2, 2, 2, 3, 'NaN', 3, 4, 4, 5, 6, 7, 8],
+    ],
+    [
+        '#DIV/0!',
+        [1, 1],
+    ],
+];
diff --git a/tests/data/Calculation/Statistical/SLOPE.php b/tests/data/Calculation/Statistical/SLOPE.php
index a635c0d076..a7730b9cd8 100644
--- a/tests/data/Calculation/Statistical/SLOPE.php
+++ b/tests/data/Calculation/Statistical/SLOPE.php
@@ -65,4 +65,14 @@
             4,
         ],
     ],
+    [
+        '#N/A',
+        [1, 2, 3],
+        [4, 5],
+    ],
+    [
+        '#DIV/0!',
+        [1, 2, 3],
+        [4, null, null],
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/TRIMMEAN.php b/tests/data/Calculation/Statistical/TRIMMEAN.php
new file mode 100644
index 0000000000..5ec07a04f2
--- /dev/null
+++ b/tests/data/Calculation/Statistical/TRIMMEAN.php
@@ -0,0 +1,34 @@
+<?php
+
+return [
+    [
+        3.777777777778,
+        [4, 5, 6, 7, 2, 3, 4, 5, 1, 2, 3],
+        0.2,
+    ],
+    [
+        9.45,
+        [0.5, 6, 7, 7, 8, 8, 9, 9, 16, 24],
+        0.15,
+    ],
+    [
+        8.75,
+        [0.5, 6, 7, 7, 8, 8, 9, 9, 16, 24],
+        0.2,
+    ],
+    [
+        8.0,
+        [0.5, 6, 7, 7, 8, 8, 9, 9, 16, 24],
+        0.4,
+    ],
+    [
+        '#NUM!',
+        [0.5, 6, 7, 7, 8, 8, 9, 9, 16, 24],
+        15,
+    ],
+    [
+        '#VALUE!',
+        [0.5, 6, 7, 7, 8, 8, 9, 9, 16, 24],
+        'NaN',
+    ],
+];