support gcd function

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1900406 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
index 6c0c6ea4d040e01710463a6d1d39fca65d1f395a..f4919e7e39654fc404f463ca3d2b9a9afda9b5a1 100644 (file)
--- a/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
+++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
@@ -112,7 +112,7 @@ public final class AnalysisToolPak implements UDFFinder {
         r(m, "ERFC", null);
         r(m, "FACTDOUBLE", FactDouble.instance);
         r(m, "FVSCHEDULE", null);
-        r(m, "GCD", null);
+        r(m, "GCD", Gcd.instance);
         r(m, "GESTEP", null);
         r(m, "HEX2BIN", null);
         r(m, "HEX2DEC", Hex2Dec.instance);

diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java
new file mode 100644 (file)
index 0000000..6da25ed
--- /dev/null
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java
@@ -0,0 +1,69 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+package org.apache.poi.ss.formula.functions;
+
+import org.apache.commons.math3.util.ArithmeticUtils;
+import org.apache.poi.ss.formula.OperationEvaluationContext;
+import org.apache.poi.ss.formula.eval.ErrorEval;
+import org.apache.poi.ss.formula.eval.EvaluationException;
+import org.apache.poi.ss.formula.eval.NumberEval;
+import org.apache.poi.ss.formula.eval.OperandResolver;
+import org.apache.poi.ss.formula.eval.ValueEval;
+
+import java.util.ArrayList;
+
+public class Gcd implements FreeRefFunction {
+
+    public static final Gcd instance = new Gcd();
+
+    @Override
+    public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
+        if (args.length < 1) {
+            return ErrorEval.VALUE_INVALID;
+        } else if (args.length == 1) {
+            try {
+                ValueEval v1 = OperandResolver.getSingleValue(args[0], ec.getRowIndex(), ec.getColumnIndex());
+                long l = (long)OperandResolver.coerceValueToDouble(v1);
+                if (l < 0) {
+                    return ErrorEval.NUM_ERROR;
+                }
+                return new NumberEval(l);
+            } catch (EvaluationException ee) {
+                return ErrorEval.VALUE_INVALID;
+            }
+        } else {
+            try {
+                ArrayList<Long> evals = new ArrayList<>();
+                for (int i = 0; i < args.length; i++) {
+                    ValueEval ve = OperandResolver.getSingleValue(args[i], ec.getRowIndex(), ec.getColumnIndex());
+                    long l = (long)OperandResolver.coerceValueToDouble(ve);
+                    if (l < 0) {
+                        return ErrorEval.NUM_ERROR;
+                    }
+                    evals.add(l);
+                }
+                long result = evals.get(0);
+                for (int i = 1; i < evals.size(); i++) {
+                    result = ArithmeticUtils.gcd(result, evals.get(i));
+                }
+                return new NumberEval(result);
+            } catch (EvaluationException ee) {
+                return ErrorEval.VALUE_INVALID;
+            }
+        }
+    }
+}

diff --git a/poi/src/test/java/org/apache/poi/ss/formula/functions/TestGcd.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestGcd.java
new file mode 100644 (file)
index 0000000..3918557
--- /dev/null
+++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestGcd.java
@@ -0,0 +1,85 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.ss.formula.functions;
+
+import org.apache.poi.hssf.usermodel.HSSFCell;
+import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
+import org.apache.poi.hssf.usermodel.HSSFSheet;
+import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.ss.formula.OperationEvaluationContext;
+import org.apache.poi.ss.formula.eval.BoolEval;
+import org.apache.poi.ss.formula.eval.ErrorEval;
+import org.apache.poi.ss.formula.eval.NumberEval;
+import org.apache.poi.ss.formula.eval.StringEval;
+import org.apache.poi.ss.formula.eval.ValueEval;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+import static org.apache.poi.ss.util.Utils.addRow;
+import static org.apache.poi.ss.util.Utils.assertDouble;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Tests for {@link Gcd}
+ */
+final class TestGcd {
+
+    private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
+
+    //https://support.microsoft.com/en-us/office/gcd-function-d5107a51-69e3-461f-8e4c-ddfc21b5073a
+    @Test
+    void testBasic() {
+        confirmValue(Arrays.asList(5, 2), 1.0);
+        confirmValue(Arrays.asList(24, 36), 12.0);
+        confirmValue(Arrays.asList(7, 1), 1.0);
+        confirmValue(Arrays.asList(5, 0), 5.0);
+        confirmValue(Arrays.asList(10, 5, 0), 5.0);
+        confirmValue(Arrays.asList(10.9, 5, 0), 5.0);
+    }
+
+    @Test
+    void testNumError() {
+        confirmNumError(Arrays.asList(-1));
+        confirmNumError(Arrays.asList(10, -1));
+    }
+
+    private static ValueEval invokeValue(List<Number> numberList) {
+        ValueEval[] args = new ValueEval[numberList.size()];
+        int i = 0;
+        for (Number num : numberList) {
+            args[i++] = new NumberEval(num.doubleValue());
+        }
+        return Gcd.instance.evaluate(args, ec);
+    }
+
+    private static void confirmValue(List<Number> numberList, double expected) {
+        ValueEval result = invokeValue(numberList);
+        assertEquals(NumberEval.class, result.getClass());
+        assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.00000000000001);
+    }
+
+    private static void confirmNumError(List<Number> numberList) {
+        ValueEval result = invokeValue(numberList);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.NUM_ERROR, result);
+    }
+}