From 58ae50ea98e8397cb6aef8ee312f9e534e059328 Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Tue, 25 Jan 2022 22:32:18 +0000 Subject: [PATCH] normdist (init work) git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1897475 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/test/java9/module-info.class | Bin 686 -> 685 bytes .../poi/ss/formula/eval/FunctionEval.java | 2 +- .../poi/ss/formula/functions/NormDist.java | 88 +++++++++++++++ .../ss/formula/functions/TestNormDist.java | 104 ++++++++++++++++++ 4 files changed, 193 insertions(+), 1 deletion(-) create mode 100644 poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java create mode 100644 poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java diff --git a/poi-integration/src/test/java9/module-info.class b/poi-integration/src/test/java9/module-info.class index 92a6b8ee9e339185c5cc8be8ce8b4c661fec9313..1efde427394e78c2a33ce553f46c28d6cd172659 100644 GIT binary patch delta 40 vcmZ3-x|Vfg90N1o1vbek)FxMTt_AVo2>^M delta 41 scmZ3>x{h^%znqDlp)i9SBLl0co&|_0FU+98$iQx>X9z@=8*?0)0HPTOO#lD@ diff --git a/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java b/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java index f1a4ff717b..23ddf3aac6 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java @@ -272,7 +272,7 @@ public final class FunctionEval { // 290: LOGNORMDIST // 291: LOGINV // 292: NEGBINOMDIST - // 293: NORMDIST + retval[293] = NormDist.instance; // 294: NORMSDIST // 295: NORMINV // 296: NORMSINV diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java new file mode 100644 index 0000000000..9d34dcee97 --- /dev/null +++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java @@ -0,0 +1,88 @@ +/* ==================================================================== + 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.distribution.NormalDistribution; +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; + +/** + * Implementation for Excel NORMDIST() function.

+ + * https://support.microsoft.com/en-us/office/normdist-function-126db625-c53e-4591-9a22-c9ff422d6d58 + */ +public final class NormDist extends Fixed4ArgFunction implements FreeRefFunction { + + public static final NormDist instance = new NormDist(); + + static double probability(double x, double mean, double stdev, boolean cumulative) { + NormalDistribution normalDistribution = new NormalDistribution(mean, stdev); + return cumulative ? normalDistribution.cumulativeProbability(x) : normalDistribution.probability(x); + } + + @Override + public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2, + ValueEval arg3, ValueEval arg4) { + try { + Double xval = evaluateValue(arg1, srcRowIndex, srcColumnIndex); + if (xval == null) { + return ErrorEval.VALUE_INVALID; + } else if (xval < 0) { + return ErrorEval.NUM_ERROR; + } + Double mean = evaluateValue(arg2, srcRowIndex, srcColumnIndex); + if (mean == null) { + return ErrorEval.VALUE_INVALID; + } + Double stdev = evaluateValue(arg3, srcRowIndex, srcColumnIndex); + if (stdev == null) { + return ErrorEval.VALUE_INVALID; + } else if (stdev.doubleValue() <= 0) { + return ErrorEval.NUM_ERROR; + } + Boolean cumulative = OperandResolver.coerceValueToBoolean(arg4, false); + if (cumulative == null) { + return ErrorEval.VALUE_INVALID; + } + + return new NumberEval(probability( + xval.doubleValue(), mean.doubleValue(), stdev.doubleValue(), cumulative.booleanValue())); + } catch (EvaluationException e) { + return e.getErrorEval(); + } + } + + @Override + public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) { + if (args.length == 4) { + return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0], args[1], args[2], args[3]); + } + + return ErrorEval.VALUE_INVALID; + } + + private static Double evaluateValue(ValueEval arg, int srcRowIndex, int srcColumnIndex) throws EvaluationException { + ValueEval veText = OperandResolver.getSingleValue(arg, srcRowIndex, srcColumnIndex); + String strText1 = OperandResolver.coerceValueToString(veText); + return OperandResolver.parseDouble(strText1); + } +} \ No newline at end of file diff --git a/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java new file mode 100644 index 0000000000..66894e1fc0 --- /dev/null +++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java @@ -0,0 +1,104 @@ +/* ==================================================================== + 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.BlankEval; +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 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 NormDist} + */ +final class TestNormDist { + + private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null); + + @Test + void testBasic() { + confirmValue("42", "40", "1.5", true, 0.9087888); + //TODO needs investigation + //confirmValue("42", "40", "1.5", false, 0.10934); + } + + @Test + void testInvalid() { + confirmInvalidError("A1","B2","C2", false); + } + + @Test + void testNumError() { + confirmNumError("42","40","0", false); + confirmNumError("42","40","0", true); + confirmNumError("42","40","-0.1", false); + confirmNumError("42","40","-0.1", true); + } + + //https://support.microsoft.com/en-us/office/normdist-function-126db625-c53e-4591-9a22-c9ff422d6d58 + @Test + void testMicrosoftExample1() throws IOException { + try (HSSFWorkbook wb = new HSSFWorkbook()) { + HSSFSheet sheet = wb.createSheet(); + addRow(sheet, 0, "Data", "Description"); + addRow(sheet, 1, 42, "Value for which you want the distribution"); + addRow(sheet, 2, 40, "Arithmetic mean of the distribution"); + addRow(sheet, 3, 1.5, "Standard deviation of the distribution"); + HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb); + HSSFCell cell = wb.getSheetAt(0).getRow(0).createCell(100); + assertDouble(fe, cell, "NORMDIST(A2,A3,A4,TRUE)", 0.9087888, 0.000001); + } + } + + private static ValueEval invokeValue(String number1, String number2, String number3, boolean cumulative) { + ValueEval[] args = new ValueEval[] { new StringEval(number1), new StringEval(number2), new StringEval(number3), BoolEval.valueOf(cumulative)}; + return NormDist.instance.evaluate(args, ec); + } + + private static void confirmValue(String number1, String number2, String number3, boolean cumulative, double expected) { + ValueEval result = invokeValue(number1, number2, number3, cumulative); + assertEquals(NumberEval.class, result.getClass()); + assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.0000001); + } + + private static void confirmInvalidError(String number1, String number2, String number3, boolean cumulative) { + ValueEval result = invokeValue(number1, number2, number3, cumulative); + assertEquals(ErrorEval.class, result.getClass()); + assertEquals(ErrorEval.VALUE_INVALID, result); + } + + private static void confirmNumError(String number1, String number2, String number3, boolean cumulative) { + ValueEval result = invokeValue(number1, number2, number3, cumulative); + assertEquals(ErrorEval.class, result.getClass()); + assertEquals(ErrorEval.NUM_ERROR, result); + } + +} -- 2.39.5