The GSL-FFI-RUNNING-STATISTICS module¶
Running statistics¶
- <gsl-rstat-workspace> Class¶
Accumulator used to store the running statistics.
Initializing the Accumulator¶
- gsl-rstat-alloc Function¶
- Signature:
gsl-rstat-alloc () => (workspace)
- Values:
workspace – An instance of
<gsl-rstat-workspace>.
- Discussion:
Allocate a new
<gsl-rstat-workspace>.
- gsl-rstat-free Function¶
- Signature:
gsl-rstat-free (workspace) => ()
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Discussion:
Free a
<gsl-rstat-workspace>.
- gsl-rstat-reset Function¶
- Signature:
gsl-rstat-reset (workspace) => (status)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
status – An instance of
<c-int>
- Discussion:
Reset a
<gsl-rstat-workspace>.
Adding Data to the Accumulator¶
- gsl-rstat-add Function¶
- Signature:
gsl-rstat-add (workspace x) => (status)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.x – An instance of
<c-double>.
- Values:
status – An instance of
<c-int>.
- Discussion:
Add a new value to the
<gsl-rstat-workspace*>.
- gsl-rstat-n Function¶
- Signature:
gsl-rstat-n (workspace) => (n)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
n – The number of values in the accumulator.
- Discussion:
Get the number of values so far added to the
<gsl-rstat-workspace>.
Current Statistics¶
- gsl-rstat-min Function¶
- Signature:
gsl-rstat-min (workspace) => (min)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
min – The minimum value in the accumulator.
- Discussion:
Get the minimum value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-max Function¶
- Signature:
gsl-rstat-max (workspace) => (max)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
max – The maximum value in the accumulator.
- Discussion:
Get the maximum value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-mean Function¶
- Signature:
gsl-rstat-mean (workspace) => (mean)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
mean – The mean value in the accumulator.
- Discussion:
Get the mean value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-variance Function¶
- Signature:
gsl-rstat-variance (workspace) => (variance)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
variance – The variance value in the accumulator.
- Discussion:
Get the variance value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-sd Function¶
- Signature:
gsl-rstat-sd (workspace) => (sd)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
sd – The standard deviation value in the accumulator.
- Discussion:
Get the standard deviation value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-rms Function¶
- Signature:
gsl-rstat-rms (workspace) => (rms)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
rms – The root mean square value in the accumulator.
- Discussion:
Get the root mean square value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-skew Function¶
- Signature:
gsl-rstat-skew (workspace) => (skew)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
skew – The skewness value in the accumulator.
- Discussion:
Get the skewness value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-kurtosis Function¶
- Signature:
gsl-rstat-kurtosis (workspace) => (kurtosis)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
kurtosis – The kurtosis value in the accumulator.
- Discussion:
Get the kurtosis value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-median Function¶
- Signature:
gsl-rstat-median (workspace) => (median)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
median – The median value in the accumulator.
- Discussion:
Get the median value so far added to the
<gsl-rstat-workspace>.
- gsl-rstat-norm Function¶
- Signature:
gsl-rstat-norm (workspace) => (norm)
- Parameters:
workspace – An instance of
<gsl-rstat-workspace*>.
- Values:
norm – The norm value in the accumulator.
- Discussion:
Get the norm value so far added to the
<gsl-rstat-workspace>.
Quantiles¶
- <gsl-rstat-quantile> Class¶
Accumulator used to store the running quantiles.
Initializing the Accumulator¶
- gsl-rstat-quantile-alloc Function¶
- Signature:
gsl-rstat-quantile-alloc (p) => (quantile)
- Parameters:
p – The quantile to compute.
- Values:
quantile – An instance of
<gsl-rstat-quantile*>.
- gsl-rstat-quantile-free Function¶
- Signature:
gsl-rstat-quantile-free (quantile) => ()
- Parameters:
quantile – An instance of
<gsl-rstat-quantile*>.
- Discussion:
Free a
<gsl-rstat-quantile*>.
- gsl-rstat-quantile-reset Function¶
- Signature:
gsl-rstat-quantile-reset (quantile) => (status)
- Parameters:
quantile – An instance of
<gsl-rstat-quantile*>.
- Values:
status – An instance of
<c-int>.
- Discussion:
Reset a
<gsl-rstat-quantile*>.
Adding Data to the Accumulator¶
- gsl-rstat-quantile-add Function¶
- Signature:
gsl-rstat-quantile-add (x quantile) => (status)
- Parameters:
x – An instance of
<c-double>.quantile – An instance of
<gsl-rstat-quantile*>.
- Values:
status – An instance of
<c-int>.
- Discussion:
Add a new value to the
<gsl-rstat-quantile*>.
Current Statistics¶
- gsl-rstat-quantile-get Function¶
- Signature:
gsl-rstat-quantile-get (quantile) => (quantile)
- Parameters:
quantile – An instance of
<gsl-rstat-quantile*>.
- Values:
quantile – The quantile value in the accumulator.
- Discussion:
Get the quantile value so far added to the
<gsl-rstat-quantile*>.