Forecast (Keikai Spreadsheet Build 6.0.0 API)

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

All Implemented Interfaces:

FreeRefFunction, Function, Function3Arg
```
public class Forecast
extends Fixed3ArgFunction
implements FreeRefFunction
```
Implementation for Excel FORECAST() and FORECAST.LINEAR() functions.
Syntax:
FORECAST (number, array1, array2)

See https://support.microsoft.com/en-us/office/forecast-and-forecast-linear-functions-50ca49c9-7b40-4892-94e4-7ad38bbeda99

Field Summary

Fields
Modifier and Type Field Description

static Forecast instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ValueEval`	`evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, 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.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 Forecast instance
```
- Method Detail
  - evaluate
```
public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg0,
                          ValueEval arg1,
                          ValueEval arg2)
```
    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).