add TDIST.RT support

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

5 files changed, 190 insertions, 3 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 927b85d621..3531559e28 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
@@ -173,7 +173,7 @@ public final class AnalysisToolPak implements UDFFinder {
         r(m, "TBILLEQ", null);
         r(m, "TBILLPRICE", null);
         r(m, "TBILLYIELD", null);
-        //r(m, "TDIST.AR", TDist.instance);
+        r(m, "TDIST.RT", TDistRt.instance);
         r(m, "TEXTJOIN", TextJoinFunction.instance);
         r(m, "WEEKNUM", WeekNum.instance);
         r(m, "WORKDAY", WorkdayFunction.instance);
diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/TDist.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/TDist.java
index 84cea9894a..537320e617 100644
--- a/poi/src/main/java/org/apache/poi/ss/formula/functions/TDist.java
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/TDist.java
@@ -40,10 +40,10 @@ import org.apache.poi.ss.formula.eval.*;
  *
  * <ul>
  *     <li>If any argument is non-numeric, TDIST returns the #VALUE! error value.</li>
- *     <li>If Deg_freedom < 1, TDIST returns the #NUM! error value.</li>
+ *     <li>If Deg_freedom &lt; 1, TDIST returns the #NUM! error value.</li>
  *     <li>The Deg_freedom and Tails arguments are truncated to integers.
  *     <li>If Tails is any value other than 1 or 2, TDIST returns the #NUM! error value.</li>
- *     <li>If x < 0, then TDIST returns the #NUM! error value.</li>
+ *     <li>If x &lt; 0, then TDIST returns the #NUM! error value.</li>
  * </ul>
  */
 public final class TDist extends Fixed3ArgFunction implements FreeRefFunction {
diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/TDistRt.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/TDistRt.java
new file mode 100644
index 0000000000..eca23837c5
--- /dev/null
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/TDistRt.java
@@ -0,0 +1,84 @@
+/* ====================================================================
+   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.TDistribution;
+import org.apache.poi.ss.formula.OperationEvaluationContext;
+import org.apache.poi.ss.formula.eval.*;
+
+/**
+ * Implementation for Excel TDIST.RT() function.
+ * <p>
+ * <b>Syntax</b>:<br> <b>TDIST.RT </b>(<b>X</b>,<b>Deg_freedom</b>)<br>
+ * <p>
+ * Returns the right-tailed Student's t-distribution.
+ *
+ * The t-distribution is used in the hypothesis testing of small sample data sets.
+ * Use this function in place of a table of critical values for the t-distribution.
+ *
+ * <ul>
+ *     <li>X     Required. The numeric value at which to evaluate the distribution.</li>
+ *     <li>Deg_freedom     Required. An integer indicating the number of degrees of freedom.</li>
+ * </ul>
+ *
+ * <ul>
+ *     <li>If any argument is non-numeric, TDIST.RT returns the #VALUE! error value.</li>
+ *     <li>If Deg_freedom &lt; 1, TDIST.RT returns the #NUM! error value.</li>
+ *     <li>The Deg_freedom argument is truncated to an integer.
+ * </ul>
+ */
+public final class TDistRt extends Fixed2ArgFunction implements FreeRefFunction {
+
+    public static final TDistRt instance = new TDistRt();
+
+    @Override
+    public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2) {
+        try {
+            Double number1 = evaluateValue(arg1, srcRowIndex, srcColumnIndex);
+            if (number1 == null) {
+                return ErrorEval.VALUE_INVALID;
+            }
+            Double number2 = evaluateValue(arg2, srcRowIndex, srcColumnIndex);
+            if (number2 == null) {
+                return ErrorEval.VALUE_INVALID;
+            }
+            int degreesOfFreedom = number2.intValue();
+            if (degreesOfFreedom < 1) {
+                return ErrorEval.NUM_ERROR;
+            }
+            return new NumberEval(TDist.tdistOneTail(Math.abs(number1), degreesOfFreedom));
+        } catch (EvaluationException e) {
+            return e.getErrorEval();
+        }
+    }
+
+    @Override
+    public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
+         if (args.length == 2) {
+            return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0], args[1]);
+        }
+
+        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/TestTDist.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestTDist.java
index 4698455b2a..ab9a3f9d3d 100644
--- a/poi/src/test/java/org/apache/poi/ss/formula/functions/TestTDist.java
+++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestTDist.java
@@ -61,6 +61,7 @@ final class TestTDist {
     void testNumError() {
         confirmNumError("5.968191467", "8", "0");
         confirmNumError("-5.968191467", "8", "2");
+        confirmNumError("5.968191467", "-8", "2");
     }
 
     //https://support.microsoft.com/en-us/office/tdist-function-630a7695-4021-4853-9468-4a1f9dcdd192
diff --git a/poi/src/test/java/org/apache/poi/ss/formula/functions/TestTDistRt.java b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestTDistRt.java
new file mode 100644
index 0000000000..301b0fb263
--- /dev/null
+++ b/poi/src/test/java/org/apache/poi/ss/formula/functions/TestTDistRt.java
@@ -0,0 +1,102 @@
+/* ====================================================================
+   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.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 TDistRt}
+ */
+final class TestTDistRt {
+
+    private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
+
+    @Test
+    void testBasic() {
+        confirmValue("5.968191467", "8", 0.00016754180265310392);
+        confirmValue("5.968191467", "8.2", 0.00016754180265310392);
+        confirmValue("5.968191467", "8.9", 0.00016754180265310392);
+        confirmValue("-5.968191467", "8", 0.00016754180265310392);
+    }
+
+    @Test
+    void testInvalid() {
+        confirmInvalidError("A1","B2");
+        confirmInvalidError("5.968191467","B2");
+        confirmInvalidError("A1","8");
+    }
+
+    @Test
+    void testNumError() {
+        confirmNumError("-5.968191467", "-8");
+    }
+
+    //https://support.microsoft.com/en-us/office/t-dist-rt-function-20a30020-86f9-4b35-af1f-7ef6ae683eda
+    @Test
+    void testMicrosoftExample1() throws IOException {
+        try (HSSFWorkbook wb = new HSSFWorkbook()) {
+            HSSFSheet sheet = wb.createSheet();
+            addRow(sheet, 0, "Data", "Description");
+            addRow(sheet, 1, 1.959999998, "Value at which to evaluate the distribution");
+            addRow(sheet, 2, 60, "Degrees of freedom");
+            HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
+            HSSFCell cell = wb.getSheetAt(0).getRow(0).createCell(100);
+            assertDouble(fe, cell, "TDIST.RT(A2,A3)", 0.027322465, 0.01);
+            assertDouble(fe, cell, "TDIST.RT(-A2,A3)", 0.027322465, 0.01);
+        }
+    }
+
+    private static ValueEval invokeValue(String number1, String number2) {
+        ValueEval[] args = new ValueEval[] { new StringEval(number1), new StringEval(number2) };
+        return TDistRt.instance.evaluate(args, ec);
+    }
+
+    private static void confirmValue(String number1, String number2, double expected) {
+        ValueEval result = invokeValue(number1, number2);
+        assertEquals(NumberEval.class, result.getClass());
+        assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.0);
+    }
+
+    private static void confirmInvalidError(String number1, String number2) {
+        ValueEval result = invokeValue(number1, number2);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.VALUE_INVALID, result);
+    }
+
+    private static void confirmNumError(String number1, String number2) {
+        ValueEval result = invokeValue(number1, number2);
+        assertEquals(ErrorEval.class, result.getClass());
+        assertEquals(ErrorEval.NUM_ERROR, result);
+    }
+
+}