From a2a09d021598dfa5037cef802288efccd6c780c7 Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Fri, 29 Apr 2022 23:19:53 +0000 Subject: [PATCH] support lcm function git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1900410 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/ss/formula/atp/AnalysisToolPak.java | 2 +- .../apache/poi/ss/formula/functions/Lcm.java | 91 ++++++++++++++++++ .../poi/ss/formula/functions/TestLcm.java | 92 +++++++++++++++++++ 3 files changed, 184 insertions(+), 1 deletion(-) create mode 100644 poi/src/main/java/org/apache/poi/ss/formula/functions/Lcm.java create mode 100644 poi/src/test/java/org/apache/poi/ss/formula/functions/TestLcm.java 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 f4919e7e39..b4d4078635 100644 --- 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 @@ -141,7 +141,7 @@ public final class AnalysisToolPak implements UDFFinder { r(m, "ISEVEN", ParityFunction.IS_EVEN); r(m, "ISODD", ParityFunction.IS_ODD); r(m, "JIS", null); - r(m, "LCM", null); + r(m, "LCM", Lcm.instance); r(m, "MAXIFS", Maxifs.instance); r(m, "MDURATION", null); r(m, "MINIFS", Minifs.instance); diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/Lcm.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/Lcm.java new file mode 100644 index 0000000000..25d61b2395 --- /dev/null +++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/Lcm.java @@ -0,0 +1,91 @@ +/* ==================================================================== + 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; + + +/** + * Implementation for Excel LCM() function. + *

+ * Syntax:
LCM (number, ...)
+ *

+ *

+ * Returns the least common multiple of integers. The least common multiple is the smallest positive integer that is a multiple of all integer arguments number1, number2, and so on. Use LCM to add fractions with different denominators. + *

+ *

+ * See https://support.microsoft.com/en-us/office/lcm-function-7152b67a-8bb5-4075-ae5c-06ede5563c94 + *

+ */ +public class Lcm implements FreeRefFunction { + + public static final Lcm instance = new Lcm(); + + private static final long MAX_OUTPUT = (long)Math.pow(2, 53); + + @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()); + double d = OperandResolver.coerceValueToDouble(v1); + if (isInvalidInput(d)) { + return ErrorEval.NUM_ERROR; + } + return new NumberEval((long)d); + } catch (EvaluationException ee) { + return ErrorEval.VALUE_INVALID; + } + } else { + try { + ArrayList evals = new ArrayList<>(); + for (int i = 0; i < args.length; i++) { + ValueEval ve = OperandResolver.getSingleValue(args[i], ec.getRowIndex(), ec.getColumnIndex()); + double d = OperandResolver.coerceValueToDouble(ve); + if (isInvalidInput(d)) { + return ErrorEval.NUM_ERROR; + } + evals.add((long)d); + } + long result = evals.get(0); + for (int i = 1; i < evals.size(); i++) { + result = ArithmeticUtils.lcm(result, evals.get(i)); + if (result > MAX_OUTPUT) { + return ErrorEval.NUM_ERROR; + } + } + return new NumberEval(result); + } catch (EvaluationException ee) { + return ErrorEval.VALUE_INVALID; + } + } + } + + private boolean isInvalidInput(double d) { + return d < 0; + } +} diff --git a/poi/src/test/java/org/apache/poi/ss/formula/functions/TestLcm.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestLcm.java new file mode 100644 index 0000000000..cdf4e3834b --- /dev/null +++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestLcm.java @@ -0,0 +1,92 @@ +/* ==================================================================== + 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.ss.formula.OperationEvaluationContext; +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.util.Arrays; +import java.util.List; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * Tests for {@link Lcm} + */ +final class TestLcm { + + private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null); + + //https://support.microsoft.com/en-us/office/lcm-function-7152b67a-8bb5-4075-ae5c-06ede5563c94 + @Test + void testBasic() { + confirmValue(Arrays.asList(5, 2), 10.0); + confirmValue(Arrays.asList(24, 36), 72.0); + confirmValue(Arrays.asList(24, 36, 144), 144.0); + confirmValue(Arrays.asList(24, 36, 144.9), 144.0); + } + + @Test + void testNumError() { + confirmNumError(Arrays.asList(-1)); + confirmNumError(Arrays.asList(10, -1)); + confirmNumError(Arrays.asList(Math.pow(2, 54), 2.0)); + } + + @Test + void testInvalidError() { + confirmInvalid(Arrays.asList()); + confirmInvalid(Arrays.asList("num")); + confirmInvalid(Arrays.asList(3, "num")); + } + + private static ValueEval invokeValue(List numberList) { + ValueEval[] args = new ValueEval[numberList.size()]; + int i = 0; + for (Object obj : numberList) { + if (obj instanceof Number) { + args[i++] = new NumberEval(((Number)obj).doubleValue()); + } else { + args[i++] = new StringEval(obj.toString()); + } + } + return Lcm.instance.evaluate(args, ec); + } + + private static void confirmValue(List numberList, double expected) { + ValueEval result = invokeValue(numberList); + assertEquals(NumberEval.class, result.getClass()); + assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.00000000000001); + } + + private static void confirmNumError(List numberList) { + ValueEval result = invokeValue(numberList); + assertEquals(ErrorEval.class, result.getClass()); + assertEquals(ErrorEval.NUM_ERROR, result); + } + + private static void confirmInvalid(List numberList) { + ValueEval result = invokeValue(numberList); + assertEquals(ErrorEval.class, result.getClass()); + assertEquals(ErrorEval.VALUE_INVALID, result); + } +}