Stats.Correlation As Method
Definition
Namespace: Numerics.NET.Statistics
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
Overload List
Correlation | Gets the Pearson correlation coefficient between two sets of values. |
Correlation | Gets the Pearson correlation coefficient between two arrays. |
CorrelationAs<T, TResult>(Vector<T>, Vector<T>)
Gets the Pearson correlation coefficient between two sets of values.
public static TResult CorrelationAs<T, TResult>(
this Vector<T> values1,
Vector<T> values2
)
Parameters
Type Parameters
- T
- The type of the elements of values1 and values2.
- TResult
- The type of the result.
Return Value
TResultThe correlation between the two sets of values.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions
Argument | values1 is null. -or- values2 is null. |
Dimension | The length of values1 does not equal the length of values2. |
CorrelationAs<T, TResult>(ReadOnlySpan<T>, ReadOnlySpan<T>, Boolean)
Gets the Pearson correlation coefficient between two arrays.
public static TResult CorrelationAs<T, TResult>(
this ReadOnlySpan<T> values1,
ReadOnlySpan<T> values2,
bool skipMissingValues
)
Parameters
- values1 ReadOnlySpan<T>
- A numerical vector.
- values2 ReadOnlySpan<T>
- A numerical vector.
- skipMissingValues Boolean
- Optional. Specifies whether missing values should be excluded from the calculation. The default is false.
Type Parameters
- T
- The type of the elements of values1 and values2.
- TResult
- The type of the result.
Return Value
TResultThe correlation between values1 and values2.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type ReadOnlySpan<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions
Dimension | The length of values1 does not equal the length of values2. |