--- /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.ss.formula.OperationEvaluationContext;
+import org.apache.poi.ss.formula.eval.*;
+
+/**
+ * Implementation for Excel TDIST.2T() function.
+ * <p>
+ * <b>Syntax</b>:<br> <b>TDIST.2T </b>(<b>X</b>,<b>Deg_freedom</b>)<br>
+ * <p>
+ * Returns the two-tailed Student's t-distribution.
+ *
+ * The Student's 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.2T returns the #VALUE! error value.</li>
+ * <li>If Deg_freedom < 1, TDIST.2T returns the #NUM! error value.</li>
+ * <li>If x < 0, then T.DIST.2T returns the #NUM! error value.</li>
+ * <li>The Deg_freedom argument is truncated to an integer.
+ * </ul>
+ *
+ * https://support.microsoft.com/en-us/office/t-dist-2t-function-198e9340-e360-4230-bd21-f52f22ff5c28
+ */
+public final class TDist2t extends Fixed2ArgFunction implements FreeRefFunction {
+
+ public static final TDist2t instance = new TDist2t();
+
+ @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;
+ } else if (number1 < 0) {
+ return ErrorEval.NUM_ERROR;
+ }
+ 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.tdistTwoTails(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
--- /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.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 TDist2t}
+ */
+final class TestTDist2t {
+
+ private static final OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
+
+ @Test
+ void testBasic() {
+ confirmValue("5.968191467", "8", 0.00033508360530620784);
+ confirmValue("5.968191467", "8.2", 0.00033508360530620784);
+ confirmValue("5.968191467", "8.9", 0.00033508360530620784);
+ }
+
+ @Test
+ void testInvalid() {
+ confirmInvalidError("A1","B2");
+ confirmInvalidError("5.968191467","B2");
+ confirmInvalidError("A1","8");
+ }
+
+ @Test
+ void testNumError() {
+ confirmNumError("-5.968191467", "8");
+ confirmNumError("5.968191467", "-8");
+ }
+
+ //https://support.microsoft.com/en-us/office/t-dist-2t-function-198e9340-e360-4230-bd21-f52f22ff5c28
+ @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.2T(A2,A3)", 0.054644930, 0.01);
+ }
+ }
+
+ private static ValueEval invokeValue(String number1, String number2) {
+ ValueEval[] args = new ValueEval[] { new StringEval(number1), new StringEval(number2) };
+ return TDist2t.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);
+ }
+
+}
projects / poi.git / commitdiff