org.apache.poi.ss.formula.functions

Class TDist

java.lang.Object

org.apache.poi.ss.formula.functions.Fixed3ArgFunction

org.apache.poi.ss.formula.functions.TDist

All Implemented Interfaces:

FreeRefFunction, Function, Function3Arg

public final class TDist
extends Fixed3ArgFunction
implements FreeRefFunction

Implementation for Excel TDIST() function.

Syntax:
TDIST (X,Deg_freedom,Tails)

Returns the Percentage Points (probability) for the Student t-distribution where a numeric value (x) is a calculated value of t for which the Percentage Points are to be computed. 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.

• X Required. The numeric value at which to evaluate the distribution.
• Deg_freedom Required. An integer indicating the number of degrees of freedom.
• Tails Required. Specifies the number of distribution tails to return. If Tails = 1, TDIST returns the one-tailed distribution. If Tails = 2, TDIST returns the two-tailed distribution.

• If any argument is non-numeric, TDIST returns the #VALUE! error value.
• If Deg_freedom < 1, TDIST returns the #NUM! error value.
• The Deg_freedom and Tails arguments are truncated to integers.
• If Tails is any value other than 1 or 2, TDIST returns the #NUM! error value.
• If x < 0, then TDIST returns the #NUM! error value.

https://support.microsoft.com/en-us/office/tdist-function-630a7695-4021-4853-9468-4a1f9dcdd192

Field Summary

Fields

Modifier and Type	Field and Description
static TDist	instance

Constructor Summary

Constructors

Constructor and Description
TDist()

Method Summary

Modifier and Type	Method and Description
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2, ValueEval arg3) see Function.evaluate(ValueEval[], int, int)
ValueEval	evaluate(ValueEval[] args, OperationEvaluationContext ec)

Methods inherited from class org.apache.poi.ss.formula.functions.Fixed3ArgFunction

evaluate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

public static final TDist instance

Constructor Detail

TDist

public TDist()

Method Detail

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg1,
                          ValueEval arg2,
                          ValueEval arg3)

Description copied from interface: Function3Arg

see Function.evaluate(ValueEval[], int, int)

Specified by:

evaluate in interface Function3Arg

evaluate

public ValueEval evaluate(ValueEval[] args,
                          OperationEvaluationContext ec)

Specified by:

evaluate in interface FreeRefFunction

Parameters:

args - the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec - primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).