Stats Type
Table of contents
Other module members
Static members
| Static member |
Description
|
|
|
Full Usage:
Stats.count series
Parameters:
Series<'K, 'V>
Returns: int
Modifiers: inline Type parameters: 'K, 'V |
Returns the number of the values in a series. This excludes missing values
and values created from `Double.NaN` etc.
|
|
Returns a frame with summary statistics (unique count, mean, standard
deviation, min, lower quartile, median, upper quartile, max) for each
numerical column of the input frame. Only columns convertible to
|
|
|
|
|
|
|
|
Returns a series that contains maximum over an expanding window. The value
for a key _k_ in the returned series is the maximum from all elements with
smaller keys.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
|
|
Returns a series that contains median over an expanding window. The value
for a key _k_ in the returned series is the median from all elements with
smaller keys.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
Returns a series that contains minimum over an expanding window. The value
for a key _k_ in the returned series is the minimum from all elements with
smaller keys.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
Stats.kurt series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the kurtosis of the values in a series. The function skips over missing
values and `NaN` values. When there are less than 4 values, the result is NaN.
|
|
|
|
For each group with equal keys at the level specified by `level`,
returns the kurtosis of the values in a series. The function skips over missing values
and `NaN` values. When there are less than 4 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.
|
|
For each group with equal keys at the level specified by `level`,
returns the maximum of the values in the group. The function skips over missing
values and `NaN` values. When the group 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.
|
|
For each group with equal keys at the level specified by `level`,
returns the mean of the values in the group. The function skips over missing
values and `NaN` values. When there are no available 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.
|
|
For each group with equal keys at the level specified by `level`,
returns the median of the values in the group.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
For each group with equal keys at the level specified by `level`,
returns the minimum of the values in the group. The function skips over missing
values and `NaN` values. When the group 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.
|
|
For each group with equal keys at the level specified by `level`,
returns the skewness of the values in a series. The function skips over missing
values and `NaN` values. When there are less than 3 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.
|
|
For each group with equal keys at the level specified by `level`,
returns the standard deviation of the values in the group. The function skips over
missing values and `NaN` values. When there are less than 2 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.
|
|
For each group with equal keys at the level specified by `level`,
returns the sum of the values in the group. The function skips over missing values
and `NaN` values. When there are no available values, the result is 0.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
For each group with equal keys at the level specified by `level`,
returns the variance of the values in the group. The function skips over missing
values and `NaN` values. When there are less than 2 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:
Stats.max series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
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:
Stats.maxBy f series
Parameters:
'T -> 'a
series : Series<'K, 'T>
Returns: ('K * 'T) option
Modifiers: inline Type parameters: 'T, 'a, 'K |
Returns the key and value of the greatest element in the series. The result
is an optional value. When the series contains no values, the result is `None`.
|
|
|
Full Usage:
Stats.mean series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the mean of the values in a series. The function skips over missing values
and `NaN` values. When there are no available 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:
Stats.median series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the median of the elements of the series.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
|
Full Usage:
Stats.min series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
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:
Stats.minBy f series
Parameters:
'T -> 'a
series : Series<'K, 'T>
Returns: ('K * 'T) option
Modifiers: inline Type parameters: 'T, 'a, 'K |
Returns the key and value of the least element in the series. The result
is an optional value. When the series contains no values, the result is `None`.
|
|
Returns a series that contains counts over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is 0.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is not convertible to floating point number.
|
|
Returns a series that contains kurtosis over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is also missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is not convertible to floating point number.
|
|
Returns a series that contains maximum over a moving window of the specified size.
The first `size-1` elements are calculated using smaller windows spanning over `1 .. size-1`
values. If the entire window contains missing values, the result is missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
Returns a series that contains means over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is also missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is not convertible to floating point number.
|
|
Returns a series that contains median over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is also missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
Returns a series that contains minimum over a moving window of the specified size.
The first `size-1` elements are calculated using smaller windows spanning over `1 .. size-1`
values. If the entire window contains missing values, the result is missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
Returns a series that contains skewness over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is also missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is not convertible to floating point number.
|
|
Returns a series that contains standard deviations over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is also missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is not convertible to floating point number.
|
|
Returns a series that contains sums over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is 0.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is notconvertible to floating point number.
|
|
Returns a series that contains variance over a moving window of the specified size.
The first `size-1` elements of the returned series are always missing; if the
entire window contains missing values, the result is also missing.
Throws a `FormatException` or an `InvalidCastException` if the value type of the specified series
is not convertible to floating point number.
|
Full Usage:
Stats.numSum series
Parameters:
Series<'K, ^V>
Returns: ^V
Modifiers: inline Type parameters: 'K, ^V |
Sum that operates only any appropriate numeric type. When there are no available
values, the result is zero of the approriate numeric type.
|
|
Returns the series of quantiles of the series. Excel version of quantile,
equivalent to QuantileDefinition.R7 from Math.Net
Throws a `FormatException` or an `InvalidCastException` if the value type of the series
is not convertible to floating point number.
|
|
|
Full Usage:
Stats.skew series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the skewness of the values in a series. The function skips over missing
values and `NaN` values. When there are less than 3 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:
Stats.stdDev series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the standard deviation of the values in a series. The function skips over
missing values and `NaN` values. When there are less than 2 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:
Stats.sum series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the sum of the values in a series. The function skips over missing values
and `NaN` values. When there are no available 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:
Stats.tryMax series
Parameters:
Series<'K, 'V>
Returns: 'V option
Modifiers: inline Type parameters: 'K, 'V |
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:
Stats.tryMin series
Parameters:
Series<'K, 'V>
Returns: 'V option
Modifiers: inline Type parameters: 'K, 'V |
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`.
|
|
|
Full Usage:
Stats.uniqueCount series
Parameters:
Series<'K, 'V>
Returns: int
Modifiers: inline Type parameters: 'K, 'V |
|
|
|
Full Usage:
Stats.variance series
Parameters:
Series<'K, 'V>
Returns: float
Modifiers: inline Type parameters: 'K, 'V |
Returns the variance of the values in a series. The function skips over missing values
and `NaN` values. When there are less than 2 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.
|
Series interoploation
Static members
| Static member |
Description
|
Full Usage:
Stats.interpolate keys f series
Parameters:
'K seq
-
Sequence of new keys that forms the index of interpolated results
f : 'K -> ('K * 'T) option -> ('K * 'T) option -> 'T
-
Function to do the interpolating
series : Series<'K, 'T>
-
The input series to interpolate
Returns: Series<'K, 'T>
|
Interpolates an ordered series given a new sequence of keys. The function iterates through each new key, and invokes a function on the current key, the nearest smaller and larger valid observations from the series argument. The function must return a new valid float.
|
Full Usage:
Stats.interpolateLinear keys keyDiff series
Parameters:
'K seq
-
Sequence of new keys that forms the index of interpolated results
keyDiff : 'K -> 'K -> float
-
A function representing "subtraction" between two keys
series : Series<'K, 'V>
-
The input series to interpolate
Returns: Series<'K, float>
Modifiers: inline Type parameters: 'K, 'V |
Linearly interpolates an ordered series given a new sequence of keys. Throws a `FormatException` or an `InvalidCastException` if the value type of the series is not convertible to floating point number.
|
Full Usage:
Stats.interpolateLinearWith keys keyDiff extrapolation series
Parameters:
'K seq
-
Sequence of new keys that forms the index of interpolated results
keyDiff : 'K -> 'K -> float
-
A function representing "subtraction" between two keys
extrapolation : Extrapolation
-
Specifies the behavior for keys outside the source series range:
Extrapolation.Clamp retains the nearest boundary value (same as
interpolateLinear); Extrapolation.Missing produces nan for
out-of-range keys; Extrapolation.Linear continues the boundary slope.
series : Series<'K, 'V>
-
The input series to interpolate
Returns: Series<'K, float>
Modifiers: inline Type parameters: 'K, 'V |
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. Throws a `FormatException` or an `InvalidCastException` if the value type of the series is not convertible to a floating point number.
|
Series statistics
Static members
| Static member |
Description
|
|
Returns the Pearson correlation coefficient of the values in two series. The series are aligned on their keys (inner join) and correlation is computed over all key-aligned, non-missing pairs. Returns `NaN` when fewer than 2 pairs are available or when either series has zero variance. Throws a `FormatException` or an `InvalidCastException` if the value type of either series is not convertible to floating point number.
|
|
Returns the sample covariance of the values in two series. The series are aligned on their keys (inner join) and covariance is computed over all key-aligned, non-missing pairs. Returns `NaN` when fewer than 2 pairs are available. Throws a `FormatException` or an `InvalidCastException` if the value type of either series is not convertible to floating point number.
|
Deedle