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

Class Correl

java.lang.Object

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

org.apache.poi.ss.formula.functions.Correl

All Implemented Interfaces:

Function, Function2Arg

public class Correl
extends Fixed2ArgFunction

Implementation for Excel CORREL() function.

Syntax:
CORREL (array1, array2)

The CORREL function returns the correlation coefficient of two cell ranges. Use the correlation coefficient to determine the relationship between two properties. For example, you can examine the relationship between a location's average temperature and the use of air conditioners.

See https://support.microsoft.com/en-us/office/correl-function-995dcef7-0c0a-4bed-a3fb-239d7b68ca92

Field Summary

Fields

Modifier and Type	Field	Description
static Correl	instance

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

Field Detail

instance

public static final Correl instance

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)