org.apache.poi.ss.formula.functions

Class Covar

java.lang.Object

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

org.apache.poi.ss.formula.functions.Covar

All Implemented Interfaces:

FreeRefFunction, Function, Function2Arg

public class Covar
extends Fixed2ArgFunction
implements FreeRefFunction

Implementation for Excel COVAR() and COVARIANCE.P() functions.

Syntax:
COVAR (array1, array2)

See Also:

COVAR, COVARIANCE.P

Field Summary

Fields

Modifier and Type	Field and Description
static Covar	instanceP
static Covar	instanceS

Method Summary

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

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

evaluate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instanceP

public static final Covar instanceP

instanceS

public static final Covar instanceS

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)

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).