Deedle


SeriesStatsExtensions

Namespace: Deedle
Attributes:
[<Extension>]

The type implements C# and F# extension methods that add numerical operations to Deedle series. With a few exceptions, the methods are only available for series containing floating-point values, that is Series<'K, float>.

Table of contents

Calculations, aggregation and statistics 

Static members

Static memberDescription
SeriesStatsExtensions.InterpolateLinear(...)
Signature: (series:Series<'K,'V> * keys:seq<'K> * keyDiff:Func<'K,'K,float>) -> Series<'K,float>
Type parameters: 'K, 'V Attributes:
[<Extension>]

Linearly interpolates an ordered series given a new sequence of keys.

Parameters

  • keys - Sequence of new keys that forms the index of interpolated results
  • keyDiff - A function representing "subtraction" between two keys

Statistics 

Static members

Static memberDescription
SeriesStatsExtensions.Kurtosis(series)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the kurtosis of the elements of the series.

SeriesStatsExtensions.Max(series)
Signature: series:Series<'K,'V> -> 'V
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the greatest of all elements of the series.

SeriesStatsExtensions.MaxLevel(...)
Signature: (series:Series<'K1,'V> * groupSelector:Func<'K1,'K2>) -> Series<'K2,'V>
Type parameters: 'K1, 'V, 'K2 Attributes:
[<Extension>]

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.

Parameters

  • series - A series of values that are used to calculate the greatest elements
  • groupSelector - A delegate that returns a new group key, based on the key in the input series
SeriesStatsExtensions.Mean(series)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the mean of the elements of the series.

SeriesStatsExtensions.MeanLevel(...)
Signature: (series:Series<'K1,'V> * groupSelector:Func<'K1,'K2>) -> Series<'K2,float>
Type parameters: 'K1, 'V, 'K2 Attributes:
[<Extension>]

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.

Parameters

  • series - A series of values that are used to calculate the means
  • groupSelector - A delegate that returns a new group key, based on the key in the input series
SeriesStatsExtensions.Median(series)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the median of the elements of the series.

SeriesStatsExtensions.MedianLevel(...)
Signature: (series:Series<'K1,'V> * groupSelector:Func<'K1,'K2>) -> Series<'K2,float>
Type parameters: 'K1, 'V, 'K2 Attributes:
[<Extension>]

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.

Parameters

  • series - A series of values that are used to calculate the medians
  • groupSelector - A delegate that returns a new group key, based on the key in the input series
SeriesStatsExtensions.Min(series)
Signature: series:Series<'K,'V> -> 'V
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the smallest of all elements of the series.

SeriesStatsExtensions.MinLevel(...)
Signature: (series:Series<'K1,'V> * groupSelector:Func<'K1,'K2>) -> Series<'K2,'V>
Type parameters: 'K1, 'V, 'K2 Attributes:
[<Extension>]

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.

Parameters

  • series - A series of values that are used to calculate the smallest elements
  • groupSelector - A delegate that returns a new group key, based on the key in the input series
SeriesStatsExtensions.NumSum(series)
Signature: series:Series<'K,^V> -> ^V
Type parameters: 'K, ^V Attributes:
[<Extension>]

Returns the sum of the elements of the series of numeric values.

SeriesStatsExtensions.Skewness(series)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the skewness of the elements of the series.

SeriesStatsExtensions.StdDev(series)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the standard deviation of the elements of the series.

SeriesStatsExtensions.StdDevLevel(...)
Signature: (series:Series<'K1,'V> * groupSelector:Func<'K1,'K2>) -> Series<'K2,float>
Type parameters: 'K1, 'V, 'K2

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.

Parameters

  • series - A series of values that are used to calculate the standard deviations
  • groupSelector - A delegate that returns a new group key, based on the key in the input series
SeriesStatsExtensions.Sum(series)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]

Returns the sum of the elements of the series of float values.

SeriesStatsExtensions.SumLevel(...)
Signature: (series:Series<'K1,'V> * groupSelector:Func<'K1,'K2>) -> Series<'K2,float>
Type parameters: 'K1, 'V, 'K2 Attributes:
[<Extension>]

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.

Parameters

  • series - A series of values that are used to calculate the sums
  • groupSelector - A delegate that returns a new group key, based on the key in the input series

Other type members 

Static members

Static memberDescription
SeriesStatsExtensions.StandardDeviation(...)
Signature: series:Series<'K,'V> -> float
Type parameters: 'K, 'V Attributes:
[<Extension>]
[<Obsolete("Use StdDev instead")>]
WARNING: This API is obsolete

Use StdDev instead

Fork me on GitHub