From a9c8470b3b15a45e7f393dfcbf8e2f5c2fc68d97 Mon Sep 17 00:00:00 2001
From: Mark Baker <mark@lange.demon.co.uk>
Date: Sun, 26 Jul 2020 22:10:53 +0200
Subject: [PATCH] Identify HYPGEOM.DIST() as a separate Excel function, and
 additional unit tests (including unhappy path) (#1595)

---
 .../Calculation/Calculation.php               |  5 +++
 .../Calculation/Statistical.php               | 13 ++++---
 .../Functions/Statistical/HypGeomDistTest.php | 25 +++++++++++++
 .../data/Calculation/Statistical/CHIDIST.php  |  4 +++
 .../Calculation/Statistical/GAMMADIST.php     |  8 +++++
 .../data/Calculation/Statistical/GAMMAINV.php |  4 +++
 .../data/Calculation/Statistical/GAMMALN.php  |  4 +++
 .../data/Calculation/Statistical/GEOMEAN.php  |  7 ++++
 .../data/Calculation/Statistical/HARMEAN.php  | 11 ++++++
 .../Calculation/Statistical/HYPGEOMDIST.php   | 36 +++++++++++++++++++
 10 files changed, 113 insertions(+), 4 deletions(-)
 create mode 100644 tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/HypGeomDistTest.php
 create mode 100644 tests/data/Calculation/Statistical/HYPGEOMDIST.php

diff --git a/src/PhpSpreadsheet/Calculation/Calculation.php b/src/PhpSpreadsheet/Calculation/Calculation.php
index 8cb1c297..99260e3b 100644
--- a/src/PhpSpreadsheet/Calculation/Calculation.php
+++ b/src/PhpSpreadsheet/Calculation/Calculation.php
@@ -1250,6 +1250,11 @@ class Calculation
             'functionCall' => [Statistical::class, 'HYPGEOMDIST'],
             'argumentCount' => '4',
         ],
+        'HYPGEOM.DIST' => [
+            'category' => Category::CATEGORY_STATISTICAL,
+            'functionCall' => [Functions::class, 'DUMMY'],
+            'argumentCount' => '5',
+        ],
         'IF' => [
             'category' => Category::CATEGORY_LOGICAL,
             'functionCall' => [Logical::class, 'statementIf'],
diff --git a/src/PhpSpreadsheet/Calculation/Statistical.php b/src/PhpSpreadsheet/Calculation/Statistical.php
index 524438ea..4b113726 100644
--- a/src/PhpSpreadsheet/Calculation/Statistical.php
+++ b/src/PhpSpreadsheet/Calculation/Statistical.php
@@ -1901,12 +1901,17 @@ class Statistical
      */
     public static function HYPGEOMDIST($sampleSuccesses, $sampleNumber, $populationSuccesses, $populationNumber)
     {
-        $sampleSuccesses = floor(Functions::flattenSingleValue($sampleSuccesses));
-        $sampleNumber = floor(Functions::flattenSingleValue($sampleNumber));
-        $populationSuccesses = floor(Functions::flattenSingleValue($populationSuccesses));
-        $populationNumber = floor(Functions::flattenSingleValue($populationNumber));
+        $sampleSuccesses = Functions::flattenSingleValue($sampleSuccesses);
+        $sampleNumber = Functions::flattenSingleValue($sampleNumber);
+        $populationSuccesses = Functions::flattenSingleValue($populationSuccesses);
+        $populationNumber = Functions::flattenSingleValue($populationNumber);
 
         if ((is_numeric($sampleSuccesses)) && (is_numeric($sampleNumber)) && (is_numeric($populationSuccesses)) && (is_numeric($populationNumber))) {
+            $sampleSuccesses = floor($sampleSuccesses);
+            $sampleNumber = floor($sampleNumber);
+            $populationSuccesses = floor($populationSuccesses);
+            $populationNumber = floor($populationNumber);
+
             if (($sampleSuccesses < 0) || ($sampleSuccesses > $sampleNumber) || ($sampleSuccesses > $populationSuccesses)) {
                 return Functions::NAN();
             }
diff --git a/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/HypGeomDistTest.php b/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/HypGeomDistTest.php
new file mode 100644
index 00000000..d05b60b5
--- /dev/null
+++ b/tests/PhpSpreadsheetTests/Calculation/Functions/Statistical/HypGeomDistTest.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\Statistical;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Statistical;
+use PHPUnit\Framework\TestCase;
+
+class HypGeomDistTest extends TestCase
+{
+    /**
+     * @dataProvider providerHYPGEOMDIST
+     *
+     * @param mixed $expectedResult
+     */
+    public function testHYPGEOMDIST($expectedResult, ...$args): void
+    {
+        $result = Statistical::HYPGEOMDIST(...$args);
+        self::assertEqualsWithDelta($expectedResult, $result, 1E-12);
+    }
+
+    public function providerHYPGEOMDIST()
+    {
+        return require 'tests/data/Calculation/Statistical/HYPGEOMDIST.php';
+    }
+}
diff --git a/tests/data/Calculation/Statistical/CHIDIST.php b/tests/data/Calculation/Statistical/CHIDIST.php
index 023d2a7c..5cfdc664 100644
--- a/tests/data/Calculation/Statistical/CHIDIST.php
+++ b/tests/data/Calculation/Statistical/CHIDIST.php
@@ -37,6 +37,10 @@ return [
         '#VALUE!',
         'NAN', 3,
     ],
+    [
+        '#NUM!',
+        8, 0,
+    ],
     [
         '#NUM!',
         -8, 3,
diff --git a/tests/data/Calculation/Statistical/GAMMADIST.php b/tests/data/Calculation/Statistical/GAMMADIST.php
index dfc93c63..e79b3869 100644
--- a/tests/data/Calculation/Statistical/GAMMADIST.php
+++ b/tests/data/Calculation/Statistical/GAMMADIST.php
@@ -1,6 +1,14 @@
 <?php
 
 return [
+    [
+        0.03263913041829,
+        10.00001131, 9, 2, false,
+    ],
+    [
+        0.06809400387,
+        10.00001131, 9, 2, true,
+    ],
     [
         0.112020903828,
         6, 3, 2, false,
diff --git a/tests/data/Calculation/Statistical/GAMMAINV.php b/tests/data/Calculation/Statistical/GAMMAINV.php
index 64869092..3b3604b4 100644
--- a/tests/data/Calculation/Statistical/GAMMAINV.php
+++ b/tests/data/Calculation/Statistical/GAMMAINV.php
@@ -1,6 +1,10 @@
 <?php
 
 return [
+    [
+        10.0000111914377,
+        0.068094, 9, 2,
+    ],
     [
         5.348120627447,
         0.5, 3, 2,
diff --git a/tests/data/Calculation/Statistical/GAMMALN.php b/tests/data/Calculation/Statistical/GAMMALN.php
index 783f0afd..a415f559 100644
--- a/tests/data/Calculation/Statistical/GAMMALN.php
+++ b/tests/data/Calculation/Statistical/GAMMALN.php
@@ -5,6 +5,10 @@ return [
         2.453736570842,
         4.5,
     ],
+    [
+        1.791759469228,
+        4,
+    ],
     [
         '#VALUE!',
         'NAN',
diff --git a/tests/data/Calculation/Statistical/GEOMEAN.php b/tests/data/Calculation/Statistical/GEOMEAN.php
index 4e064b0c..f7627f40 100644
--- a/tests/data/Calculation/Statistical/GEOMEAN.php
+++ b/tests/data/Calculation/Statistical/GEOMEAN.php
@@ -1,8 +1,15 @@
 <?php
 
 return [
+    [
+        5.47698696965696,
+        4, 5, 8, 7, 11, 4, 3,
+    ],
     [
         1.6226711115996,
         2.5, 3, 0.5, 1, 3,
     ],
+    [
+        '#NUM!',
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/HARMEAN.php b/tests/data/Calculation/Statistical/HARMEAN.php
index c884b4ce..504d1b5e 100644
--- a/tests/data/Calculation/Statistical/HARMEAN.php
+++ b/tests/data/Calculation/Statistical/HARMEAN.php
@@ -1,8 +1,19 @@
 <?php
 
 return [
+    [
+        5.028375962062,
+        4, 5, 8, 7, 11, 4, 3,
+    ],
     [
         1.2295081967213,
         2.5, 3, 0.5, 1, 3,
     ],
+    [
+        '#NUM!',
+        2.5, -3, 0.5, 1, 3,
+    ],
+    [
+        '#N/A',
+    ],
 ];
diff --git a/tests/data/Calculation/Statistical/HYPGEOMDIST.php b/tests/data/Calculation/Statistical/HYPGEOMDIST.php
new file mode 100644
index 00000000..faec26c3
--- /dev/null
+++ b/tests/data/Calculation/Statistical/HYPGEOMDIST.php
@@ -0,0 +1,36 @@
+<?php
+
+return [
+    [
+        0.3632610939112,
+        1, 4, 8, 20,
+    ],
+    [
+        0.4525252525252,
+        1, 4, 4, 12,
+    ],
+    [
+        0.3393939393939,
+        2, 4, 4, 12,
+    ],
+    [
+        0.0646464646465,
+        3, 4, 4, 12,
+    ],
+    [
+        0.0020202020202,
+        4, 4, 4, 12,
+    ],
+    [
+        '#VALUE!',
+        'NAN', 4, 4, 12,
+    ],
+    [
+        '#NUM!',
+        5, 4, 4, 12,
+    ],
+    [
+        '#NUM!',
+        4, 4, 4, 3,
+    ],
+];