TDistLt (Keikai Spreadsheet Build 6.0.0 API)

java.lang.Object
- org.apache.poi.ss.formula.functions.Fixed3ArgFunction
- - org.apache.poi.ss.formula.functions.TDistLt

All Implemented Interfaces:

FreeRefFunction, Function, Function3Arg
```
public final class TDistLt
extends Fixed3ArgFunction
implements FreeRefFunction
```
Implementation for Excel T.DIST() function.
Syntax:
T.DIST (X,Deg_freedom,Cumulative)

Returns the Student's left-tailed 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.
- Cumulative Required. A logical value that determines the form of the function. If cumulative is TRUE, T.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
- If any argument is non-numeric, T.DIST returns the #VALUE! error value.
- If Deg_freedom < 1, T.DIST 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 TDistLt instance

Constructor Summary

Constructors
Constructor Description

TDistLt()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 TDistLt instance
```
- Constructor Detail
  - TDistLt
```
public TDistLt()
```
- 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).