Class Trend
- java.lang.Object
-
- org.apache.poi.ss.formula.functions.Trend
-
- All Implemented Interfaces:
Function
public final class Trend extends java.lang.Object implements Function
Implementation for the Excel function TRENDSyntax:
TREND(known_y's, known_x's, new_x's, constant)Parameter descriptions known_y's, known_x's, new_x's typically area references, possibly cell references or scalar values constant TRUE or FALSE: determines whether the regression line should include an intercept term
If known_x's is not given, it is assumed to be the default array {1, 2, 3, ...} of the same size as known_y's.
If new_x's is not given, it is assumed to be the same as known_x's
If constant is omitted, it is assumed to be TRUE
-
-
Constructor Summary
Constructors Constructor Description Trend()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ValueEval
evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
-
-
-
Method Detail
-
evaluate
public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
- Specified by:
evaluate
in interfaceFunction
- Parameters:
args
- the evaluated function arguments. Empty values are represented withBlankEval
orMissingArgEval
, nevernull
.srcRowIndex
- row index of the cell containing the formula under evaluationsrcColumnIndex
- column index of the cell containing the formula under evaluation- Returns:
- The evaluated result, possibly an
ErrorEval
, nevernull
. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate toDouble.NaN
be sure to translate the result toErrorEval.NUM_ERROR
.
-
-