norminv function

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

4 files changed, 192 insertions, 1 deletions

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 5e3e05cb36..341ce5b55f 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
@@ -151,6 +151,7 @@ public final class AnalysisToolPak implements UDFFinder {
         r(m, "NOMINAL", null);
         r(m, "NORM.DIST", NormDist.instance);
         r(m, "NORM.S.DIST", NormSDist.instance);
+        r(m, "NORM.INV", NormInv.instance);
         r(m, "NUMBERVALUE", NumberValueFunction.instance);
         r(m, "OCT2BIN", null);
         r(m, "OCT2DEC", Oct2Dec.instance);
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 493a3fbe05..471b77e02c 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
@@ -274,7 +274,7 @@ public final class FunctionEval {
         // 292: NEGBINOMDIST
         retval[293] = NormDist.instance;
         retval[294] = NormSDist.instance;
-        // 295: NORMINV
+        retval[295] = NormInv.instance;
         // 296: NORMSINV
         // 297: STANDARDIZE
         retval[298] = NumericFunction.ODD;
diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java
new file mode 100644
index 0000000000..0834976cdb
--- /dev/null
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.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.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 NORMINV() and NORM.INV() functions.<p>
+ * <ul>
+ *   <li>https://support.microsoft.com/en-us/office/norminv-function-87981ab8-2de0-4cb0-b1aa-e21d4cb879b8</li>
+ *   <li>https://support.microsoft.com/en-us/office/norm-inv-function-54b30935-fee7-493c-bedb-2278a9db7e13</li>
+ * </ul>
+ */
+public final class NormInv extends Fixed3ArgFunction implements FreeRefFunction {
+
+    public static final NormInv instance = new NormInv();
+
+    static double inverse(double probability, double mean, double stdev) {
+        NormalDistribution normalDistribution = new NormalDistribution(mean, stdev);
+        return normalDistribution.inverseCumulativeProbability(probability);
+    }
+
+    @Override
+    public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2, ValueEval arg3) {
+        try {
+            Double probability = evaluateValue(arg1, srcRowIndex, srcColumnIndex);
+            if (probability == null) {
+                return ErrorEval.VALUE_INVALID;
+            } else if (probability <= 0 || probability >= 1) {
+                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;
+            }
+
+            return new NumberEval(inverse(
+                    probability.doubleValue(), mean.doubleValue(), stdev.doubleValue()));
+        } catch (EvaluationException e) {
+            return e.getErrorEval();
+        }
+    }
+
+    @Override
+    public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
+        if (args.length == 3) {
+            return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0], args[1], args[2]);
+        }
+
+        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/TestNormInv.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java
new file mode 100644
index 0000000000..689b1ae12f
--- /dev/null
+++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java
@@ -0,0 +1,105 @@
+/* ====================================================================
+   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 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 NormInv}
+ */
+final class TestNormInv {
+
+    private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
+
+    @Test
+    void testBasic() {
+        confirmValue("0.908789", "40", "1.5", 42.000002);
+    }
+
+    @Test
+    void testInvalid() {
+        confirmInvalidError("A1","B2","C2");
+    }
+
+    @Test
+    void testNumError() {
+        confirmNumError("0.5","40","0");
+        confirmNumError("0.5","40","-0.1");
+        confirmNumError("-0.5","40","0.1");
+        confirmNumError("0","40","0.1");
+        confirmNumError("1","40","0.1");
+        confirmNumError("1.5","40","0.1");
+    }
+
+    //https://support.microsoft.com/en-us/office/norminv-function-87981ab8-2de0-4cb0-b1aa-e21d4cb879b8
+    //https://support.microsoft.com/en-us/office/norm-inv-function-54b30935-fee7-493c-bedb-2278a9db7e13
+    @Test
+    void testMicrosoftExample1() throws IOException {
+        try (HSSFWorkbook wb = new HSSFWorkbook()) {
+            HSSFSheet sheet = wb.createSheet();
+            addRow(sheet, 0, "Data", "Description");
+            addRow(sheet, 1, 0.908789, "Probability corresponding to the normal 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, "NORMINV(A2,A3,A4)", 42.000002, 0.000001);
+            assertDouble(fe, cell, "NORM.INV(A2,A3,A4)", 42.000002, 0.000001);
+        }
+    }
+
+    private static ValueEval invokeValue(String number1, String number2, String number3) {
+        ValueEval[] args = new ValueEval[] { new StringEval(number1), new StringEval(number2), new StringEval(number3)};
+        return NormInv.instance.evaluate(args, ec);
+    }
+
+    private static void confirmValue(String number1, String number2, String number3, double expected) {
+        ValueEval result = invokeValue(number1, number2, number3);
+        assertEquals(NumberEval.class, result.getClass());
+        assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.0000001);
+    }
+
+    private static void confirmInvalidError(String number1, String number2, String number3) {
+        ValueEval result = invokeValue(number1, number2, number3);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.VALUE_INVALID, result);
+    }
+
+    private static void confirmNumError(String number1, String number2, String number3) {
+        ValueEval result = invokeValue(number1, number2, number3);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.NUM_ERROR, result);
+    }
+
+}