From: PJ Fanning <fanningpj@apache.org>
Date: Tue, 25 Jan 2022 23:42:27 +0000 (+0000)
Subject: normsinv function
X-Git-Tag: REL_5_2_1~147
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=59fd293fadc4d6603f4493d24473d916c90f65d2;p=poi.git

normsinv function

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

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 341ce5b55f..cff8acc520 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
@@ -152,6 +152,7 @@ public final class AnalysisToolPak implements UDFFinder {
         r(m, "NORM.DIST", NormDist.instance);
         r(m, "NORM.S.DIST", NormSDist.instance);
         r(m, "NORM.INV", NormInv.instance);
+        r(m, "NORM.S.INV", NormSInv.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 471b77e02c..60899ae9ed 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
@@ -275,7 +275,7 @@ public final class FunctionEval {
         retval[293] = NormDist.instance;
         retval[294] = NormSDist.instance;
         retval[295] = NormInv.instance;
-        // 296: NORMSINV
+        retval[296] = NormSInv.instance;
         // 297: STANDARDIZE
         retval[298] = NumericFunction.ODD;
         // 299: PERMUT
diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSDist.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSDist.java
index 3be6721604..1df2763472 100644
--- a/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSDist.java
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSDist.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.formula.eval.OperandResolver;
 import org.apache.poi.ss.formula.eval.ValueEval;
 
 /**
- * Implementation for Excel NORMSDIST() function.<p>
+ * Implementation for Excel NORMSDIST() and NORM.S.DIST functions.<p>
  * <ul>
  *   <li>https://support.microsoft.com/en-us/office/normsdist-function-463369ea-0345-445d-802a-4ff0d6ce7cac</li>
  *   <li>https://support.microsoft.com/en-us/office/norm-s-dist-function-1e787282-3832-4520-a9ae-bd2a8d99ba88</li>
diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSInv.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSInv.java
new file mode 100644
index 0000000000..22f9631abb
--- /dev/null
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/NormSInv.java
@@ -0,0 +1,68 @@
+/* ====================================================================
+   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.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 NORMSINV() and NORM.S.INV() functions.<p>
+ * <ul>
+ *   <li>https://support.microsoft.com/en-us/office/normsinv-function-8d1bce66-8e4d-4f3b-967c-30eed61f019d</li>
+ *   <li>https://support.microsoft.com/en-us/office/norm-s-inv-function-d6d556b4-ab7f-49cd-b526-5a20918452b1</li>
+ * </ul>
+ */
+public final class NormSInv extends Fixed1ArgFunction implements FreeRefFunction {
+
+    public static final NormSInv instance = new NormSInv();
+
+    @Override
+    public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1) {
+        try {
+            Double probability = evaluateValue(arg1, srcRowIndex, srcColumnIndex);
+            if (probability == null) {
+                return ErrorEval.VALUE_INVALID;
+            } else if (probability <= 0 || probability >= 1) {
+                return ErrorEval.NUM_ERROR;
+            }
+
+            return new NumberEval(NormInv.inverse(probability.doubleValue(), 0, 1));
+        } catch (EvaluationException e) {
+            return e.getErrorEval();
+        }
+    }
+
+    @Override
+    public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
+        if (args.length == 1) {
+            return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0]);
+        }
+
+        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/TestNormSInv.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormSInv.java
new file mode 100644
index 0000000000..4006afda8d
--- /dev/null
+++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormSInv.java
@@ -0,0 +1,99 @@
+/* ====================================================================
+   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.HSSFRow;
+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.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.assertDouble;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Tests for {@link NormSInv}
+ */
+final class TestNormSInv {
+
+    private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
+
+    @Test
+    void testBasic() {
+        confirmValue("0.9088", 1.3334);
+    }
+
+    @Test
+    void testInvalid() {
+        confirmInvalidError("A1");
+    }
+
+    @Test
+    void testNumError() {
+        confirmNumError("0");
+        confirmNumError("-0.5");
+        confirmNumError("1");
+        confirmNumError("1.5");
+    }
+
+    //https://support.microsoft.com/en-us/office/normsinv-function-8d1bce66-8e4d-4f3b-967c-30eed61f019d</li>
+    //https://support.microsoft.com/en-us/office/norm-s-inv-function-d6d556b4-ab7f-49cd-b526-5a20918452b1</li>
+    @Test
+    void testMicrosoftExample1() throws IOException {
+        try (HSSFWorkbook wb = new HSSFWorkbook()) {
+            HSSFSheet sheet = wb.createSheet();
+            HSSFRow row = sheet.createRow(0);
+            HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
+            HSSFCell cell = row.createCell(0);
+            assertDouble(fe, cell, "NORMSINV(0.9088)", 1.3334, 0.00001);
+            assertDouble(fe, cell, "NORM.S.INV(0.9088)", 1.3334, 0.00001);
+        }
+    }
+
+    private static ValueEval invokeValue(String number1) {
+        ValueEval[] args = new ValueEval[] { new StringEval(number1)};
+        return NormSInv.instance.evaluate(args, ec);
+    }
+
+    private static void confirmValue(String number1, double expected) {
+        ValueEval result = invokeValue(number1);
+        assertEquals(NumberEval.class, result.getClass());
+        assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.00001);
+    }
+
+    private static void confirmInvalidError(String number1) {
+        ValueEval result = invokeValue(number1);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.VALUE_INVALID, result);
+    }
+
+    private static void confirmNumError(String number1) {
+        ValueEval result = invokeValue(number1);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.NUM_ERROR, result);
+    }
+
+}