Top Description Fields Constructors Methods
org.apache.poi.ss.formula.functions

public Class Correl

extends Fixed2ArgFunction
Class Inheritance
Imports
org.apache.commons.math3.stat.correlation.PearsonsCorrelation, org.apache.poi.ss.formula.eval.ErrorEval, .EvaluationException, .NumberEval, .ValueEval, java.util.List
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

Modifier and TypeField and Description
public static final Correl
instance

Constructor Summary

AccessConstructor and Description
private
Correl()

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)

Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

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

Inherited from org.apache.poi.ss.formula.functions.Fixed2ArgFunction:
evaluate

Field Detail

instanceback to summary
public static final Correl instance

Constructor Detail

Correlback to summary
private Correl()

Method Detail

evaluateback to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)

Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

Doc from org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

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

Annotations
@Override