Gets the Pearson correlation coefficent with another NumericalVariable.

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Function GetCorrelation ( _
	variable As NumericalVariable _
) As Double
C#
public double GetCorrelation (
	NumericalVariable variable
)
C++
public:
double GetCorrelation (
	NumericalVariable^ variable
)

Parameters

variable (Extreme.Statistics.NumericalVariable)
A NumericalVariable.

Return Value

The correlation between the two variables.

Exceptions

ExceptionCondition
ArgumentNullExceptionvariable is nullNothingnullptr.
DimensionMismatchException The length of variable does not equal the length of this instance.