TDistRt (Keikai Spreadsheet Build 6.0.0 API)

java.lang.Object
- org.apache.poi.ss.formula.functions.Fixed2ArgFunction
- - org.apache.poi.ss.formula.functions.TDistRt

All Implemented Interfaces:

FreeRefFunction, Function, Function2Arg
```
public final class TDistRt
extends Fixed2ArgFunction
implements FreeRefFunction
```
Implementation for Excel T.DIST.RT() function.
Syntax:
T.DIST.RT (X,Deg_freedom)

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.
- X Required. The numeric value at which to evaluate the distribution.
- Deg_freedom Required. An integer indicating the number of degrees of freedom.
- If any argument is non-numeric, T.DIST.RT returns the #VALUE! error value.
- If Deg_freedom < 1, T.DIST.RT returns the #NUM! error value.
- The Deg_freedom argument is truncated to an integer.
https://support.microsoft.com/en-us/office/t-dist-rt-function-20a30020-86f9-4b35-af1f-7ef6ae683eda

Field Summary

Fields
Modifier and Type Field Description

static TDistRt instance

Constructor Summary

Constructors
Constructor Description

TDistRt()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ValueEval`	`evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg1, ValueEval arg2)`	see `Function.evaluate(ValueEval[], int, int)`
`ValueEval`	`evaluate(ValueEval[] args, OperationEvaluationContext ec)`

Methods inherited from class org.apache.poi.ss.formula.functions.Fixed2ArgFunction
evaluate, evaluate, evaluateArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - instance
```
public static final TDistRt instance
```
- Constructor Detail
  - TDistRt
```
public TDistRt()
```
- Method Detail
  - evaluate
```
public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg1,
                          ValueEval arg2)
```
    Description copied from interface: Function2Arg
    
    see Function.evaluate(ValueEval[], int, int)
    
    Specified by:
    
    evaluate in interface Function2Arg
  - 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).