Click or drag to resize

DescriptiveStatisticsTransformsCorrelogram Method (Vector, Vector, Int32, Vector, Boolean, Double)

Builds correlogram between values from containers. Method will enum all lags between -lag and +lag. Be careful with result array size it must be at least lag * 2 + 1. The containers must have the same size. http://en.wikipedia.org/wiki/Correlogram

Namespace:  FinMath.Statistics
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
public static int Correlogram(
	this Vector dataVector,
	Vector otherVector,
	int lag,
	Vector resultVector,
	bool checkForAbnormals,
	double defaultValue
)

Parameters

dataVector
Type: FinMath.LinearAlgebraVector
Reference to a container object.
otherVector
Type: FinMath.LinearAlgebraVector
Another container to calculate statistics.
lag
Type: SystemInt32
The lags (from -lags .. +lags) of desired correlogram.
resultVector
Type: FinMath.LinearAlgebraVector
The correlogram container.
checkForAbnormals
Type: SystemBoolean
Check is array contains NaN values and properly process them.
defaultValue
Type: SystemDouble
The default value to replace missing values.

Return Value

Type: Int32
The non-missed values count.

Usage Note

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