init

lib/PhpSpreadsheet/Calculation/MathTrig/Gcd.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Calculation\MathTrig;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Exception;
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
+
+class Gcd
+{
+    /**
+     * Recursively determine GCD.
+     *
+     * Returns the greatest common divisor of a series of numbers.
+     * The greatest common divisor is the largest integer that divides both
+     *        number1 and number2 without a remainder.
+     *
+     * Excel Function:
+     *        GCD(number1[,number2[, ...]])
+     */
+    private static function evaluateGCD(float|int $a, float|int $b): float|int
+    {
+        return $b ? self::evaluateGCD($b, $a % $b) : $a;
+    }
+
+    /**
+     * GCD.
+     *
+     * Returns the greatest common divisor of a series of numbers.
+     * The greatest common divisor is the largest integer that divides both
+     *        number1 and number2 without a remainder.
+     *
+     * Excel Function:
+     *        GCD(number1[,number2[, ...]])
+     *
+     * @param mixed ...$args Data values
+     *
+     * @return float|int|string Greatest Common Divisor, or a string containing an error
+     */
+    public static function evaluate(mixed ...$args)
+    {
+        try {
+            $arrayArgs = [];
+            foreach (Functions::flattenArray($args) as $value1) {
+                if ($value1 !== null) {
+                    $value = Helpers::validateNumericNullSubstitution($value1, 1);
+                    Helpers::validateNotNegative($value);
+                    $arrayArgs[] = (int) $value;
+                }
+            }
+        } catch (Exception $e) {
+            return $e->getMessage();
+        }
+
+        if (count($arrayArgs) <= 0) {
+            return ExcelError::VALUE();
+        }
+        $gcd = (int) array_pop($arrayArgs);
+        do {
+            $gcd = self::evaluateGCD($gcd, (int) array_pop($arrayArgs));
+        } while (!empty($arrayArgs));
+
+        return $gcd;
+    }
+}