Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

support lcm function 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1900410 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2022-04-29 23:19:53 +00:00
parent e24321454c
commit a2a09d0215
3 changed files with 184 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
View File

@ -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);

91
poi/src/main/java/org/apache/poi/ss/formula/functions/Lcm.java Normal file
View File

@ -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.
* <p>
* <b>Syntax</b>:<br> <b>LCM </b>(<b>number</b>, ...)<br>
* </p>
* <p>
* 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.
* </p>
* <p>
* See https://support.microsoft.com/en-us/office/lcm-function-7152b67a-8bb5-4075-ae5c-06ede5563c94
* </p>
*/
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<Long> 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;
}
}

92
poi/src/test/java/org/apache/poi/ss/formula/functions/TestLcm.java Normal file
View File

@ -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<Object> 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<Object> numberList, double expected) {
ValueEval result = invokeValue(numberList);
assertEquals(NumberEval.class, result.getClass());
assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.00000000000001);
}
private static void confirmNumError(List<Object> numberList) {
ValueEval result = invokeValue(numberList);
assertEquals(ErrorEval.class, result.getClass());
assertEquals(ErrorEval.NUM_ERROR, result);
}
private static void confirmInvalid(List<Object> numberList) {
ValueEval result = invokeValue(numberList);
assertEquals(ErrorEval.class, result.getClass());
assertEquals(ErrorEval.VALUE_INVALID, result);
}
}