SeriesStatsExtensions Type
The type implements C# and F# extension methods that add numerical operations to Deedle series.
Table of contents
Other module members
Static members
| Static member |
Description
|
Full Usage:
SeriesStatsExtensions.Kurtosis(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Returns the kurtosis of the elements of the series.
|
Full Usage:
SeriesStatsExtensions.Max(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Returns the maximum of the values in a series. The result is an float value.
When the series contains no values, the result is NaN.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
Full Usage:
SeriesStatsExtensions.Mean(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
|
Full Usage:
SeriesStatsExtensions.Median(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
|
Full Usage:
SeriesStatsExtensions.Min(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Returns the minimum of the values in a series. The result is an float value.
When the series contains no values, the result is NaN.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
Full Usage:
SeriesStatsExtensions.NumSum(series)
Parameters:
Series<'K, ^V>
Returns: ^V
Modifiers: inline Type parameters: 'K, ^V (requires equality and (static member get_Zero : -> ^V) and (static member op_Addition : ^V * ^V -> ^V)) |
Returns the sum of the elements of the series of numeric values.
|
Full Usage:
SeriesStatsExtensions.Skewness(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Returns the skewness of the elements of the series.
|
Full Usage:
SeriesStatsExtensions.StdDev(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Returns the standard deviation of the elements of the series.
|
Full Usage:
SeriesStatsExtensions.Sum(series)
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Returns the sum of the elements of the series of float values.
|
Full Usage:
SeriesStatsExtensions.TryMax(series)
Parameters:
Series<'K, 'V>
Returns: 'V option
Modifiers: inline Type parameters: 'K, 'V (requires equality and comparison) |
Returns the maximum of the values in a series. The result is an option value.
When the series contains no values, the result is `None`.
|
Full Usage:
SeriesStatsExtensions.TryMin(series)
Parameters:
Series<'K, 'V>
Returns: 'V option
Modifiers: inline Type parameters: 'K, 'V (requires equality and comparison) |
Returns the minimum of the values in a series. The result is an option value.
When the series contains no values, the result is `None`.
|
Calculations, aggregation and statistics
Static members
| Static member |
Description
|
Full Usage:
SeriesStatsExtensions.InterpolateLinear(series, keys, keyDiff)
Parameters:
Series<'K, 'V>
-
The input series to interpolate
keys : 'K seq
-
Sequence of new keys that forms the index of interpolated results
keyDiff : Func<'K, 'K, float>
-
A function representing "subtraction" between two keys
Returns: Series<'K, float>
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Linearly interpolates an ordered series given a new sequence of keys.
|
Full Usage:
SeriesStatsExtensions.InterpolateLinearWith(series, keys, keyDiff, extrapolation)
Parameters:
Series<'K, 'V>
-
The input series to interpolate
keys : 'K seq
-
Sequence of new keys that forms the index of interpolated results
keyDiff : Func<'K, 'K, float>
-
A function representing "subtraction" between two keys
extrapolation : Extrapolation
-
Controls how keys outside the source range are handled:
Extrapolation.Clamp uses the nearest boundary value;
Extrapolation.Missing produces nan for out-of-range keys;
Extrapolation.Linear continues the boundary slope.
Returns: Series<'K, float>
Modifiers: inline Type parameters: 'K, 'V (requires equality) |
Linearly interpolates an ordered series given a new sequence of keys, with configurable extrapolation behavior for keys that fall outside the range of the original series.
|
Statistics
Static members
| Static member |
Description
|
Full Usage:
SeriesStatsExtensions.MaxLevel(series, groupSelector)
Parameters:
Series<'K1, 'V>
-
A series of values that are used to calculate the greatest elements
groupSelector : Func<'K1, 'K2>
-
A delegate that returns a new group key, based on the key in the input series
Returns: Series<'K2, 'V>
Modifiers: inline Type parameters: 'K1, 'V, 'K2 (requires equality and comparison and equality) |
Groups the elements of the input series in groups based on the keys produced by `groupSelector` and then returns a new series containing the greatest element of each group. This operation is designed to be used with [hierarchical indexing](../features.html#indexing).
|
Full Usage:
SeriesStatsExtensions.MeanLevel(series, groupSelector)
Parameters:
Series<'K1, 'V>
-
A series of values that are used to calculate the means
groupSelector : Func<'K1, 'K2>
-
A delegate that returns a new group key, based on the key in the input series
Returns: Series<'K2, float>
Modifiers: inline Type parameters: 'K1, 'V, 'K2 (requires equality and equality) |
Groups the elements of the input series in groups based on the keys produced by `groupSelector` and then returns a new series containing the mean of each group. This operation is designed to be used with [hierarchical indexing](../features.html#indexing).
|
Full Usage:
SeriesStatsExtensions.MedianLevel(series, groupSelector)
Parameters:
Series<'K1, 'V>
-
A series of values that are used to calculate the medians
groupSelector : Func<'K1, 'K2>
-
A delegate that returns a new group key, based on the key in the input series
Returns: Series<'K2, float>
Modifiers: inline Type parameters: 'K1, 'V, 'K2 (requires equality and equality) |
Groups the elements of the input series in groups based on the keys produced by `groupSelector` and then returns a new series containing the median of each group. This operation is designed to be used with [hierarchical indexing](../features.html#indexing).
|
Full Usage:
SeriesStatsExtensions.MinLevel(series, groupSelector)
Parameters:
Series<'K1, 'V>
-
A series of values that are used to calculate the smallest elements
groupSelector : Func<'K1, 'K2>
-
A delegate that returns a new group key, based on the key in the input series
Returns: Series<'K2, 'V>
Modifiers: inline Type parameters: 'K1, 'V, 'K2 (requires equality and comparison and equality) |
Groups the elements of the input series in groups based on the keys produced by `groupSelector` and then returns a new series containing the smallest element of each group. This operation is designed to be used with [hierarchical indexing](../features.html#indexing).
|
Full Usage:
SeriesStatsExtensions.StdDevLevel(series, groupSelector)
Parameters:
Series<'K1, 'V>
-
A series of values that are used to calculate the standard deviations
groupSelector : Func<'K1, 'K2>
-
A delegate that returns a new group key, based on the key in the input series
Returns: Series<'K2, float>
Modifiers: inline Type parameters: 'K1, 'V, 'K2 (requires equality and equality) |
Groups the elements of the input series in groups based on the keys produced by `groupSelector` and then returns a new series containing the standard deviation of each group. This operation is designed to be used with [hierarchical indexing](../features.html#indexing).
|
Full Usage:
SeriesStatsExtensions.SumLevel(series, groupSelector)
Parameters:
Series<'K1, 'V>
-
A series of values that are used to calculate the sums
groupSelector : Func<'K1, 'K2>
-
A delegate that returns a new group key, based on the key in the input series
Returns: Series<'K2, float>
Modifiers: inline Type parameters: 'K1, 'V, 'K2 (requires equality and equality) |
Groups the elements of the input series in groups based on the keys produced by `groupSelector` and then returns a new series containing the sum of each group. This operation is designed to be used with [hierarchical indexing](../features.html#indexing).
|
Deedle