The GSL-FFI-RUNNING-STATISTICS module ************************************* .. current-library:: dylan-gsl .. current-module:: gsl-ffi-running-statistics Running statistics ================== .. class:: Accumulator used to store the running statistics. Initializing the Accumulator ---------------------------- .. function:: gsl-rstat-alloc :signature: gsl-rstat-alloc () => (workspace) :value workspace: An instance of :class:``. :description: Allocate a new :class:``. .. function:: gsl-rstat-free :signature: gsl-rstat-free (workspace) => () :parameter workspace: An instance of :class:``. :description: Free a :class:``. .. function:: gsl-rstat-reset :signature: gsl-rstat-reset (workspace) => (status) :parameter workspace: An instance of :class:``. :value status: An instance of :class:`` :description: Reset a :class:``. Adding Data to the Accumulator ------------------------------ .. function:: gsl-rstat-add :signature: gsl-rstat-add (workspace x) => (status) :parameter workspace: An instance of :class:``. :parameter x: An instance of :class:``. :value status: An instance of :class:``. :description: Add a new value to the :class:``. .. function:: gsl-rstat-n :signature: gsl-rstat-n (workspace) => (n) :parameter workspace: An instance of :class:``. :value n: The number of values in the accumulator. :description: Get the number of values so far added to the :class:``. Current Statistics ------------------ .. function:: gsl-rstat-min :signature: gsl-rstat-min (workspace) => (min) :parameter workspace: An instance of :class:``. :value min: The minimum value in the accumulator. :description: Get the minimum value so far added to the :class:``. .. function:: gsl-rstat-max :signature: gsl-rstat-max (workspace) => (max) :parameter workspace: An instance of :class:``. :value max: The maximum value in the accumulator. :description: Get the maximum value so far added to the :class:``. .. function:: gsl-rstat-mean :signature: gsl-rstat-mean (workspace) => (mean) :parameter workspace: An instance of :class:``. :value mean: The mean value in the accumulator. :description: Get the mean value so far added to the :class:``. .. function:: gsl-rstat-variance :signature: gsl-rstat-variance (workspace) => (variance) :parameter workspace: An instance of :class:``. :value variance: The variance value in the accumulator. :description: Get the variance value so far added to the :class:``. .. function:: gsl-rstat-sd :signature: gsl-rstat-sd (workspace) => (sd) :parameter workspace: An instance of :class:``. :value sd: The standard deviation value in the accumulator. :description: Get the standard deviation value so far added to the :class:``. .. function:: gsl-rstat-rms :signature: gsl-rstat-rms (workspace) => (rms) :parameter workspace: An instance of :class:``. :value rms: The root mean square value in the accumulator. :description: Get the root mean square value so far added to the :class:``. .. function:: gsl-rstat-skew :signature: gsl-rstat-skew (workspace) => (skew) :parameter workspace: An instance of :class:``. :value skew: The skewness value in the accumulator. :description: Get the skewness value so far added to the :class:``. .. function:: gsl-rstat-kurtosis :signature: gsl-rstat-kurtosis (workspace) => (kurtosis) :parameter workspace: An instance of :class:``. :value kurtosis: The kurtosis value in the accumulator. :description: Get the kurtosis value so far added to the :class:``. .. function:: gsl-rstat-median :signature: gsl-rstat-median (workspace) => (median) :parameter workspace: An instance of :class:``. :value median: The median value in the accumulator. :description: Get the median value so far added to the :class:``. .. function:: gsl-rstat-norm :signature: gsl-rstat-norm (workspace) => (norm) :parameter workspace: An instance of :class:``. :value norm: The norm value in the accumulator. :description: Get the norm value so far added to the :class:``. Quantiles ========= .. class:: Accumulator used to store the running quantiles. Initializing the Accumulator ---------------------------- .. function:: gsl-rstat-quantile-alloc :signature: gsl-rstat-quantile-alloc (p) => (quantile) :parameter p: The quantile to compute. :value quantile: An instance of :class:``. .. function:: gsl-rstat-quantile-free :signature: gsl-rstat-quantile-free (quantile) => () :parameter quantile: An instance of :class:``. :description: Free a :class:``. .. function:: gsl-rstat-quantile-reset :signature: gsl-rstat-quantile-reset (quantile) => (status) :parameter quantile: An instance of :class:``. :value status: An instance of :class:``. :description: Reset a :class:``. Adding Data to the Accumulator ------------------------------ .. function:: gsl-rstat-quantile-add :signature: gsl-rstat-quantile-add (x quantile) => (status) :parameter x: An instance of :class:``. :parameter quantile: An instance of :class:``. :value status: An instance of :class:``. :description: Add a new value to the :class:``. Current Statistics ------------------ .. function:: gsl-rstat-quantile-get :signature: gsl-rstat-quantile-get (quantile) => (quantile) :parameter quantile: An instance of :class:``. :value quantile: The quantile value in the accumulator. :description: Get the quantile value so far added to the :class:``.