math: Coding style updates in some order-stat implementations.

[pspp] / src / math / box-whisker.c

diff --git a/src/math/box-whisker.c b/src/math/box-whisker.c
index 288fc072ef119ccb2c49b2001a015a34834378ad..86277333ff4ec67611833860d2402611dfd133a3 100644 (file)
--- a/src/math/box-whisker.c
+++ b/src/math/box-whisker.c
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2008 Free Software Foundation, Inc.
+   Copyright (C) 2008, 2009, 2011 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -15,26 +15,32 @@
    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #include <config.h>
+
 #include "box-whisker.h"
-#include "order-stats.h"
-#include "tukey-hinges.h"
-#include <gl/xalloc.h>
-#include <libpspp/assertion.h>
+
 #include <math.h>
 #include <float.h>
-#include <data/val-type.h>
-#include <libpspp/str.h>
-#include <data/case.h>
-#include <data/variable.h>
+
+#include "data/case.h"
+#include "data/data-out.h"
+#include "data/val-type.h"
+#include "data/variable.h"
+#include "libpspp/assertion.h"
+#include "libpspp/cast.h"
+#include "libpspp/str.h"
+#include "math/order-stats.h"
+#include "math/tukey-hinges.h"
+
+#include "gl/xalloc.h"
 
 static void
 destroy (struct statistic *s)
 {
-  struct order_stats *os = (struct order_stats *) s;
-  struct box_whisker *bw = (struct box_whisker *) s;
+  struct box_whisker *bw = UP_CAST (s, struct box_whisker, parent.parent);
+  struct order_stats *os = &bw->parent;
   struct ll *ll;
 
-  for (ll = ll_head (&bw->outliers); ll != ll_null (&bw->outliers); )
+  for (ll = ll_head (&bw->outliers); ll != ll_null (&bw->outliers);)
     {
       struct outlier *e = ll_data (ll, struct outlier, ll);
 
@@ -53,38 +59,53 @@ static void
 acc (struct statistic *s, const struct ccase *cx,
      double c UNUSED, double cc UNUSED, double y)
 {
-  struct box_whisker *bw = (struct box_whisker *) s;
+  struct box_whisker *bw = UP_CAST (s, struct box_whisker, parent.parent);
   bool extreme;
-  struct outlier *o;
 
-  if ( y < bw->hinges[2] + bw->step)
-      bw->whiskers[1] = y;
+  if (y > bw->hinges[2] + bw->step) /* Upper outlier */
+    {
+      extreme = (y > bw->hinges[2] + 2 * bw->step) ;
+    }
+
+  else if (y < bw->hinges[0] - bw->step) /* Lower outlier */
+    {
+      extreme = (y < bw->hinges[0] - 2 * bw->step) ;
+    }
 
-  if (bw->whiskers[0] == SYSMIS ||  bw->hinges[0] - bw->step > y)
-      bw->whiskers[0] = y;
+  else /* Not an outlier */
+    {
+      if (bw->whiskers[0] == SYSMIS)
+       bw->whiskers[0] = y;
 
-  if ( y > bw->hinges[2] + bw->step)
-    extreme = (y > bw->hinges[2] + 2 * bw->step) ;
+      if (y > bw->whiskers[1])
+       bw->whiskers[1] = y;
 
-  else if (y < bw->hinges[0] - bw->step)
-    extreme = (y < bw->hinges[0] - 2 * bw->step) ;
+      return;
+    }
 
-  else
-    return;
+  /* y is an outlier */
 
-  o = xzalloc (sizeof *o) ;
+  struct outlier *o = XZALLOC (struct outlier);
   o->value = y;
   o->extreme = extreme;
   ds_init_empty (&o->label);
 
   if (bw->id_var)
-    var_append_value_name (bw->id_var,
-                          case_data (cx, bw->id_var),
-                          &o->label);
+    {
+      char *s = data_out (case_data_idx (cx, bw->id_idx),
+                          var_get_encoding (bw->id_var),
+                          var_get_print_format (bw->id_var),
+                          settings_get_fmt_settings ());
+
+      ds_put_cstr (&o->label, s);
+      free (s);
+    }
   else
-    ds_put_format (&o->label,
-                  "%ld",
-                  (casenumber) case_data_idx (cx, bw->casenumber_idx)->f);
+    {
+      ds_put_format (&o->label,
+                     "%ld",
+                     (casenumber) case_num_idx (cx, bw->id_idx));
+    }
 
   ll_push_head (&bw->outliers, &o->ll);
 }
@@ -110,30 +131,37 @@ box_whisker_outliers (const struct box_whisker *bw)
   return &bw->outliers;
 }
 
-struct statistic *
-box_whisker_create (const struct tukey_hinges *th,
-                   const struct variable *id_var,  size_t casenumber_idx)
-{
-  struct box_whisker *w = xzalloc (sizeof (*w));
-  struct order_stats *os = (struct order_stats *) w;
-  struct statistic *stat = (struct statistic *) w;
-
-  os->n_k = 0;
-
-  stat->destroy = destroy;
-  stat->accumulate = acc;
+/*
+  Create a box_whisker struct, suitable for generating a boxplot.
 
-  tukey_hinges_calculate (th, w->hinges);
+  TH are the tukey hinges of the dataset.
 
-  w->casenumber_idx = casenumber_idx;
-  w->id_var = id_var;
-
-  w->step = (w->hinges[2] - w->hinges[0]) * 1.5;
-
-  w->whiskers[1] = w->hinges[2];
-  w->whiskers[0] = SYSMIS;
-
-  ll_init (&w->outliers);
-
-  return stat;
+  id_idx is the index into the casereader which will be used to label
+  outliers.
+  id_var is the variable from which that label came, or NULL
+*/
+struct box_whisker *
+box_whisker_create (const struct tukey_hinges *th,
+                   size_t id_idx, const struct variable *id_var)
+{
+  double hinges[3];
+  tukey_hinges_calculate (th, hinges);
+
+  struct box_whisker *w = xmalloc (sizeof *w);
+  *w = (struct box_whisker) {
+    .parent = {
+      .parent = {
+        .accumulate = acc,
+        .destroy = destroy,
+      },
+    },
+    .hinges = { hinges[0], hinges[1], hinges[2] },
+    .whiskers = { SYSMIS, hinges[2] },
+    .outliers = LL_INITIALIZER (w->outliers),
+    .step = (hinges[2] - hinges[0]) * 1.5,
+    .id_idx = id_idx,
+    .id_var = id_var,
+  };
+
+  return w;
 }