--- /dev/null
+/* ====================================================================
+ 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.<p>
+
+ * 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
--- /dev/null
+/* ====================================================================
+ 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);
+ }
+
+}
projects / poi.git / commitdiff