File: Running-Statistics-Example-programs.html

package info (click to toggle)
gsl-ref-html 2.3-1
links: PTS
area: non-free
in suites: bookworm, bullseye, buster, forky, sid, trixie
size: 6,876 kB
ctags: 4,574
sloc: makefile: 35
file content (234 lines) | stat: -rw-r--r-- 9,724 bytes
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "GNU General Public License" and "Free Software
Needs Free Documentation", the Front-Cover text being "A GNU Manual",
and with the Back-Cover Text being (a) (see below). A copy of the
license is included in the section entitled "GNU Free Documentation
License".

(a) The Back-Cover Text is: "You have the freedom to copy and modify this
GNU Manual." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Running Statistics Example programs</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Running Statistics Example programs">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Running Statistics Example programs">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Running-Statistics.html#Running-Statistics" rel="up" title="Running Statistics">
<link href="Running-Statistics-References-and-Further-Reading.html#Running-Statistics-References-and-Further-Reading" rel="next" title="Running Statistics References and Further Reading">
<link href="Running-Statistics-Quantiles.html#Running-Statistics-Quantiles" rel="previous" title="Running Statistics Quantiles">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Running-Statistics-Example-programs"></a>
<div class="header">
<p>
Next: <a href="Running-Statistics-References-and-Further-Reading.html#Running-Statistics-References-and-Further-Reading" accesskey="n" rel="next">Running Statistics References and Further Reading</a>, Previous: <a href="Running-Statistics-Quantiles.html#Running-Statistics-Quantiles" accesskey="p" rel="previous">Running Statistics Quantiles</a>, Up: <a href="Running-Statistics.html#Running-Statistics" accesskey="u" rel="up">Running Statistics</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Examples-15"></a>
<h3 class="section">22.5 Examples</h3>

<p>Here is a basic example of how to use the statistical functions:
</p>
<div class="example">
<pre class="verbatim">#include &lt;stdio.h&gt;
#include &lt;gsl/gsl_rstat.h&gt;

int
main(void)
{
  double data[5] = {17.2, 18.1, 16.5, 18.3, 12.6};
  double mean, variance, largest, smallest, sd,
         rms, sd_mean, median, skew, kurtosis;
  gsl_rstat_workspace *rstat_p = gsl_rstat_alloc();
  size_t i, n;

  /* add data to rstat accumulator */
  for (i = 0; i &lt; 5; ++i)
    gsl_rstat_add(data[i], rstat_p);

  mean     = gsl_rstat_mean(rstat_p);
  variance = gsl_rstat_variance(rstat_p);
  largest  = gsl_rstat_max(rstat_p);
  smallest = gsl_rstat_min(rstat_p);
  median   = gsl_rstat_median(rstat_p);
  sd       = gsl_rstat_sd(rstat_p);
  sd_mean  = gsl_rstat_sd_mean(rstat_p);
  skew     = gsl_rstat_skew(rstat_p);
  rms      = gsl_rstat_rms(rstat_p);
  kurtosis = gsl_rstat_kurtosis(rstat_p);
  n        = gsl_rstat_n(rstat_p);

  printf (&quot;The dataset is %g, %g, %g, %g, %g\n&quot;,
         data[0], data[1], data[2], data[3], data[4]);

  printf (&quot;The sample mean is %g\n&quot;, mean);
  printf (&quot;The estimated variance is %g\n&quot;, variance);
  printf (&quot;The largest value is %g\n&quot;, largest);
  printf (&quot;The smallest value is %g\n&quot;, smallest);
  printf( &quot;The median is %g\n&quot;, median);
  printf( &quot;The standard deviation is %g\n&quot;, sd);
  printf( &quot;The root mean square is %g\n&quot;, rms);
  printf( &quot;The standard devation of the mean is %g\n&quot;, sd_mean);
  printf( &quot;The skew is %g\n&quot;, skew);
  printf( &quot;The kurtosis %g\n&quot;, kurtosis);
  printf( &quot;There are %zu items in the accumulator\n&quot;, n);

  gsl_rstat_reset(rstat_p);
  n = gsl_rstat_n(rstat_p);
  printf( &quot;There are %zu items in the accumulator\n&quot;, n);

  gsl_rstat_free(rstat_p);

  return 0;
}
</pre></div>

<p>The program should produce the following output,
</p>
<div class="example">
<pre class="verbatim">The dataset is 17.2, 18.1, 16.5, 18.3, 12.6
The sample mean is 16.54
The estimated variance is 5.373
The largest value is 18.3
The smallest value is 12.6
The median is 16.5
The standard deviation is 2.31797
The root mean square is 16.6694
The standard devation of the mean is 1.03663
The skew is -0.829058
The kurtosis -1.2217
There are 5 items in the accumulator
There are 0 items in the accumulator
</pre></div>

<p>This next program estimates the lower quartile, median and upper
quartile from 10,000 samples of a random Rayleigh distribution,
using the <em>P^2</em> algorithm of Jain and Chlamtec. For
comparison, the exact values are also computed from the sorted
dataset.
</p>
<div class="example">
<pre class="verbatim">#include &lt;stdio.h&gt;
#include &lt;stdlib.h&gt;
#include &lt;gsl/gsl_rstat.h&gt;
#include &lt;gsl/gsl_statistics.h&gt;
#include &lt;gsl/gsl_rng.h&gt;
#include &lt;gsl/gsl_randist.h&gt;
#include &lt;gsl/gsl_sort.h&gt;

int
main(void)
{
  const size_t N = 10000;
  double *data = malloc(N * sizeof(double));
  gsl_rstat_quantile_workspace *work_25 = gsl_rstat_quantile_alloc(0.25);
  gsl_rstat_quantile_workspace *work_50 = gsl_rstat_quantile_alloc(0.5);
  gsl_rstat_quantile_workspace *work_75 = gsl_rstat_quantile_alloc(0.75);
  gsl_rng *r = gsl_rng_alloc(gsl_rng_default);
  double exact_p25, exact_p50, exact_p75;
  double val_p25, val_p50, val_p75;
  size_t i;

  /* add data to quantile accumulators; also store data for exact
   * comparisons */
  for (i = 0; i &lt; N; ++i)
    {
      data[i] = gsl_ran_rayleigh(r, 1.0);
      gsl_rstat_quantile_add(data[i], work_25);
      gsl_rstat_quantile_add(data[i], work_50);
      gsl_rstat_quantile_add(data[i], work_75);
    }

  /* exact values */
  gsl_sort(data, 1, N);
  exact_p25 = gsl_stats_quantile_from_sorted_data(data, 1, N, 0.25);
  exact_p50 = gsl_stats_quantile_from_sorted_data(data, 1, N, 0.5);
  exact_p75 = gsl_stats_quantile_from_sorted_data(data, 1, N, 0.75);

  /* estimated values */
  val_p25 = gsl_rstat_quantile_get(work_25);
  val_p50 = gsl_rstat_quantile_get(work_50);
  val_p75 = gsl_rstat_quantile_get(work_75);

  printf (&quot;The dataset is %g, %g, %g, %g, %g, ...\n&quot;,
         data[0], data[1], data[2], data[3], data[4]);

  printf (&quot;0.25 quartile: exact = %.5f, estimated = %.5f, error = %.6e\n&quot;,
          exact_p25, val_p25, (val_p25 - exact_p25) / exact_p25);
  printf (&quot;0.50 quartile: exact = %.5f, estimated = %.5f, error = %.6e\n&quot;,
          exact_p50, val_p50, (val_p50 - exact_p50) / exact_p50);
  printf (&quot;0.75 quartile: exact = %.5f, estimated = %.5f, error = %.6e\n&quot;,
          exact_p75, val_p75, (val_p75 - exact_p75) / exact_p75);

  gsl_rstat_quantile_free(work_25);
  gsl_rstat_quantile_free(work_50);
  gsl_rstat_quantile_free(work_75);
  gsl_rng_free(r);
  free(data);

  return 0;
}
</pre></div>

<p>The program should produce the following output,
</p>
<div class="example">
<pre class="verbatim">The dataset is 0.00645272, 0.0074002, 0.0120706, 0.0207256, 0.0227282, ...
0.25 quartile: exact = 0.75766, estimated = 0.75580, error = -2.450209e-03
0.50 quartile: exact = 1.17508, estimated = 1.17438, error = -5.995912e-04
0.75 quartile: exact = 1.65347, estimated = 1.65696, error = 2.110571e-03
</pre></div>

<hr>
<div class="header">
<p>
Next: <a href="Running-Statistics-References-and-Further-Reading.html#Running-Statistics-References-and-Further-Reading" accesskey="n" rel="next">Running Statistics References and Further Reading</a>, Previous: <a href="Running-Statistics-Quantiles.html#Running-Statistics-Quantiles" accesskey="p" rel="previous">Running Statistics Quantiles</a>, Up: <a href="Running-Statistics.html#Running-Statistics" accesskey="u" rel="up">Running Statistics</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>