Package org.apache.poi.ss.formula.functions

Class LinearRegressionFunction

java.lang.Object

org.apache.poi.ss.formula.functions.Fixed2ArgFunction

org.apache.poi.ss.formula.functions.LinearRegressionFunction

All Implemented Interfaces:

Function, Function2Arg

public final class LinearRegressionFunction
extends Fixed2ArgFunction

Base class for linear regression functions. Calculates the linear regression line that is used to predict y values from x values
(http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html) Syntax:
INTERCEPT(arrayX, arrayY)

or SLOPE(arrayX, arrayY)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinearRegressionFunction.FUNCTION

Constructor Summary

Constructors

Constructor	Description
LinearRegressionFunction(LinearRegressionFunction.FUNCTION function)

Method Summary

Modifier and Type	Method	Description
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)	see Function.evaluate(ValueEval[], int, int)

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

Constructor Detail

LinearRegressionFunction

public LinearRegressionFunction(LinearRegressionFunction.FUNCTION function)

Method Detail

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg0,
                          ValueEval arg1)

Description copied from interface: Function2Arg

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