Click or drag to resize

DescriptiveStatisticsCorrelationOrDefaultTSource Method (IEnumerableTSource, IEnumerableTSource, FuncTSource, Double, Double, Boolean)
Returns correlation between values in containers. The containers must have the same size. http://en.wikipedia.org/wiki/Correlation_and_dependence

Namespace:  FinMath.Statistics
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
Copy
public static double CorrelationOrDefault<TSource>(
	this IEnumerable<TSource> data,
	IEnumerable<TSource> other,
	Func<TSource, double> selector,
	double defaultValue = 0,
	bool checkForAbnormals = false
)

Parameters

data
Type: System.Collections.GenericIEnumerableTSource
Reference to a container object.
other
Type: System.Collections.GenericIEnumerableTSource
Another container to calculate statistics.
selector
Type: SystemFuncTSource, Double
A transform function to apply to each element.
defaultValue (Optional)
Type: SystemDouble
The default value to return of calculation fail.
checkForAbnormals (Optional)
Type: SystemBoolean
Check is array contains NaN values and properly process them.

Type Parameters

TSource
The source data type.

Return Value

Type: Double
The correlation.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableTSource. 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).
See Also