You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by fa...@apache.org on 2022/01/25 23:26:29 UTC

svn commit: r1897479 - in /poi/trunk/poi/src: main/java/org/apache/poi/ss/formula/atp/ main/java/org/apache/poi/ss/formula/eval/ main/java/org/apache/poi/ss/formula/functions/ test/java/org/apache/poi/ss/formula/functions/

Author: fanningpj
Date: Tue Jan 25 23:26:29 2022
New Revision: 1897479

URL: http://svn.apache.org/viewvc?rev=1897479&view=rev
Log:
norminv function

Added:
    poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java
      - copied, changed from r1897477, poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java
    poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java
      - copied, changed from r1897477, poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java
Modified:
    poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
    poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java

Modified: poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java?rev=1897479&r1=1897478&r2=1897479&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java Tue Jan 25 23:26:29 2022
@@ -151,6 +151,7 @@ public final class AnalysisToolPak imple
         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);

Modified: poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java?rev=1897479&r1=1897478&r2=1897479&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/eval/FunctionEval.java Tue Jan 25 23:26:29 2022
@@ -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;

Copied: poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java (from r1897477, poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java)
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java?p2=poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java&p1=poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java&r1=1897477&r2=1897479&rev=1897479&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormDist.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/NormInv.java Tue Jan 25 23:26:29 2022
@@ -26,29 +26,28 @@ import org.apache.poi.ss.formula.eval.Op
 import org.apache.poi.ss.formula.eval.ValueEval;
 
 /**
- * Implementation for Excel NORMDIST() and NORM.DIST() functions.<p>
+ * Implementation for Excel NORMINV() and NORM.INV() functions.<p>
  * <ul>
- *   <li>https://support.microsoft.com/en-us/office/normdist-function-126db625-c53e-4591-9a22-c9ff422d6d58</li>
- *   <li>https://support.microsoft.com/en-us/office/norm-dist-function-edb1cc14-a21c-4e53-839d-8082074c9f8d</li>
+ *   <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 NormDist extends Fixed4ArgFunction implements FreeRefFunction {
+public final class NormInv extends Fixed3ArgFunction implements FreeRefFunction {
 
-    public static final NormDist instance = new NormDist();
+    public static final NormInv instance = new NormInv();
 
-    static double probability(double x, double mean, double stdev, boolean cumulative) {
+    static double inverse(double probability, double mean, double stdev) {
         NormalDistribution normalDistribution = new NormalDistribution(mean, stdev);
-        return cumulative ? normalDistribution.cumulativeProbability(x) : normalDistribution.density(x);
+        return normalDistribution.inverseCumulativeProbability(probability);
     }
 
     @Override
-    public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2,
-                              ValueEval arg3, ValueEval arg4) {
+    public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2, ValueEval arg3) {
         try {
-            Double xval = evaluateValue(arg1, srcRowIndex, srcColumnIndex);
-            if (xval == null) {
+            Double probability = evaluateValue(arg1, srcRowIndex, srcColumnIndex);
+            if (probability == null) {
                 return ErrorEval.VALUE_INVALID;
-            } else if (xval < 0) {
+            } else if (probability <= 0 || probability >= 1) {
                 return ErrorEval.NUM_ERROR;
             }
             Double mean = evaluateValue(arg2, srcRowIndex, srcColumnIndex);
@@ -61,13 +60,9 @@ public final class NormDist extends Fixe
             } 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()));
+            return new NumberEval(inverse(
+                    probability.doubleValue(), mean.doubleValue(), stdev.doubleValue()));
         } catch (EvaluationException e) {
             return e.getErrorEval();
         }
@@ -75,8 +70,8 @@ public final class NormDist extends Fixe
 
     @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]);
+        if (args.length == 3) {
+            return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0], args[1], args[2]);
         }
 
         return ErrorEval.VALUE_INVALID;

Copied: poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java (from r1897477, poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java)
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java?p2=poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java&p1=poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java&r1=1897477&r2=1897479&rev=1897479&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormDist.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestNormInv.java Tue Jan 25 23:26:29 2022
@@ -22,7 +22,6 @@ import org.apache.poi.hssf.usermodel.HSS
 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;
@@ -37,67 +36,68 @@ import static org.apache.poi.ss.util.Uti
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
- * Tests for {@link NormDist}
+ * Tests for {@link NormInv}
  */
-final class TestNormDist {
+final class TestNormInv {
 
     private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
 
     @Test
     void testBasic() {
-        confirmValue("42", "40", "1.5", true, 0.9087888);
-        confirmValue("42", "40", "1.5", false, 0.10934);
+        confirmValue("0.908789", "40", "1.5", 42.000002);
     }
 
     @Test
     void testInvalid() {
-        confirmInvalidError("A1","B2","C2", false);
+        confirmInvalidError("A1","B2","C2");
     }
 
     @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);
+        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/normdist-function-126db625-c53e-4591-9a22-c9ff422d6d58
-    //https://support.microsoft.com/en-us/office/norm-dist-function-edb1cc14-a21c-4e53-839d-8082074c9f8d
+    //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, 42, "Value for which you want the distribution");
+            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, "NORMDIST(A2,A3,A4,TRUE)", 0.9087888, 0.000001);
-            assertDouble(fe, cell, "NORM.DIST(A2,A3,A4,TRUE)", 0.9087888, 0.000001);
+            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, 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 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, boolean cumulative, double expected) {
-        ValueEval result = invokeValue(number1, number2, number3, cumulative);
+    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, boolean cumulative) {
-        ValueEval result = invokeValue(number1, number2, number3, cumulative);
+    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, boolean cumulative) {
-        ValueEval result = invokeValue(number1, number2, number3, cumulative);
+    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);
     }



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org