Finishing off the last of the Math/Trig functions, beginning with RANDBETWEEN()

Author: MarkBaker

src/PhpSpreadsheet/Calculation/MathTrig.php

@@ -597,7 +597,7 @@ public static function QUOTIENT($numerator, $denominator)
      * @param int $min Minimal value
      * @param int $max Maximal value
      *
-     * @return float|int|string Random number
+     * @return array|float|int|string Random number
      */
     public static function RAND($min = 0, $max = 0)
     {

src/PhpSpreadsheet/Calculation/MathTrig/Random.php

@@ -2,11 +2,14 @@
 
 namespace PhpOffice\PhpSpreadsheet\Calculation\MathTrig;
 
+use PhpOffice\PhpSpreadsheet\Calculation\ArrayEnabled;
 use PhpOffice\PhpSpreadsheet\Calculation\Exception;
 use PhpOffice\PhpSpreadsheet\Calculation\Functions;
 
 class Random
 {
+    use ArrayEnabled;
+
     /**
      * RAND.
      *
@@ -21,12 +24,20 @@ public static function rand()
      * RANDBETWEEN.
      *
      * @param mixed $min Minimal value
+     *                      Or can be an array of values
      * @param mixed $max Maximal value
+     *                      Or can be an array of values
      *
-     * @return float|int|string Random number
+     * @return array|float|int|string Random number
+     *         If an array of numbers is passed as an argument, then the returned result will also be an array
+     *            with the same dimensions
      */
     public static function randBetween($min, $max)
     {
+        if (is_array($min) || is_array($max)) {
+            return self::evaluateArrayArguments([self::class, __FUNCTION__], $min, $max);
+        }
+
         try {
             $min = (int) Helpers::validateNumericNullBool($min);
             $max = (int) Helpers::validateNumericNullBool($max);

tests/PhpSpreadsheetTests/Calculation/Functions/MathTrig/RandBetweenTest.php

@@ -2,6 +2,8 @@
 
 namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\MathTrig;
 
+use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
+
 class RandBetweenTest extends AllSetupTeardown
 {
     /**
@@ -43,4 +45,30 @@ public function providerRANDBETWEEN(): array
     {
         return require 'tests/data/Calculation/MathTrig/RANDBETWEEN.php';
     }
+
+    /**
+     * @dataProvider providerRandBetweenArray
+     */
+    public function testRandBetweenArray(
+        int $expectedRows,
+        int $expectedColumns,
+        string $argument1,
+        string $argument2
+    ): void {
+        $calculation = Calculation::getInstance();
+
+        $formula = "=RandBetween({$argument1}, {$argument2})";
+        $result = $calculation->_calculateFormulaValue($formula);
+        self::assertIsArray($result);
+        self::assertCount($expectedRows, $result);
+        self::assertIsArray($result[0]);
+        self::assertCount($expectedColumns, $result[0]);
+    }
+
+    public function providerRandBetweenArray(): array
+    {
+        return [
+            'row/column vectors' => [2, 2, '{1, 10}', '{10; 100}'],
+        ];
+    }
 }