DescriptiveStatisticsTransformsCorrelogram Method (IEnumerableNullableSingle, IEnumerableNullableSingle, Int32, Single, Boolean, Single) |
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
SyntaxC#
public static int Correlogram( this IEnumerable<Nullable<float>> data, IEnumerable<Nullable<float>> other, int lag, float[] result, bool checkForAbnormals, float defaultValue )
Parameters
- data
- Type: System.Collections.GenericIEnumerableNullableSingle
Reference to a container object. - other
- Type: System.Collections.GenericIEnumerableNullableSingle
Another container to calculate statistics. - lag
- Type: SystemInt32
The lags (from -lags .. +lags) of desired correlogram. - result
- Type: SystemSingle
The correlogram container. - checkForAbnormals
- Type: SystemBoolean
Check is array contains NaN values and properly process them. - defaultValue
- Type: SystemSingle
The default value to replace missing values.
Return Value
Type: Int32The 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 IEnumerableNullableSingle. 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