CTABLES: Support setting the title, caption, ...
[pspp] / src / language / stats / ctables.c
index 4f23b3607d46aab491e832c407bc1a00ad8a40cd..53b99519dcadb8bdfb853e44edb0158c30b95df4 100644 (file)
@@ -226,6 +226,7 @@ struct var_array
   {
     struct variable **vars;
     size_t n;
+    size_t scale_idx;
 
     struct ctables_summary_spec *summaries;
     size_t n_summaries;
@@ -1318,6 +1319,9 @@ nest_fts (struct var_array2 va0, struct var_array2 va1)
           NOT_REACHED ();
         vaa.vas[vaa.n++] = (struct var_array) {
           .vars = vars,
+          .scale_idx = (a->scale_idx != SIZE_MAX ? a->scale_idx
+                        : b->scale_idx != SIZE_MAX ? a->n + b->scale_idx
+                        : SIZE_MAX),
           .n = n,
           .summaries = summary_src->summaries,
           .n_summaries = summary_src->n_summaries,
@@ -1353,17 +1357,16 @@ enumerate_fts (enum pivot_axis_type axis_type, const struct ctables_axis *a)
     {
     case CTAO_VAR:
       assert (!a->var.is_mrset);
+
+      struct variable **vars = xmalloc (sizeof *vars);
+      *vars = a->var.var;
+
       struct var_array *va = xmalloc (sizeof *va);
-      if (a->scale)
-        *va = (struct var_array) { .n = 0 };
-      else
-        {
-          struct variable **vars = xmalloc (sizeof *vars);
-          *vars = a->var.var;
-          enum pivot_axis_type *axes = xmalloc (sizeof *axes);
-          *axes = axis_type;
-          *va = (struct var_array) { .vars = vars, .n = 1 };
-        }
+      *va = (struct var_array) {
+        .vars = vars,
+        .n = 1,
+        .scale_idx = a->scale ? 0 : SIZE_MAX,
+      };
       if (a->n_summaries || a->scale)
         {
           va->summaries = a->summaries;
@@ -1406,7 +1409,6 @@ union ctables_summary
     /* XXX percentiles, median, mode, multiple response */
   };
 
-#if 0
 static void
 ctables_summary_init (union ctables_summary *s,
                       const struct ctables_summary_spec *ss)
@@ -1496,7 +1498,7 @@ ctables_summary_init (union ctables_summary *s,
     }
 }
 
-static void
+static void UNUSED
 ctables_summary_uninit (union ctables_summary *s,
                         const struct ctables_summary_spec *ss)
 {
@@ -1811,7 +1813,6 @@ ctables_summary_value (union ctables_summary *s,
 
   NOT_REACHED ();
 }
-#endif
 
 struct ctables_freq
   {
@@ -1825,8 +1826,7 @@ struct ctables_freq
       }
     axes[PIVOT_N_AXES];
 
-    //union ctables_summary *summaries;
-    double count;
+    union ctables_summary *summaries;
   };
 
 #if 0
@@ -1873,13 +1873,14 @@ ctables_freq_compare_3way (const void *a_, const void *b_, const void *aux_)
 
   const struct var_array *va = &aux->t->vaas[aux->a].vas[a_idx];
   for (size_t i = 0; i < va->n; i++)
-    {
-      int cmp = value_compare_3way (&a->axes[aux->a].values[i],
-                                    &b->axes[aux->a].values[i],
-                                    var_get_width (va->vars[i]));
-      if (cmp)
-        return cmp;
-    }
+    if (i != va->scale_idx)
+      {
+        int cmp = value_compare_3way (&a->axes[aux->a].values[i],
+                                      &b->axes[aux->a].values[i],
+                                      var_get_width (va->vars[i]));
+        if (cmp)
+          return cmp;
+      }
   return 0;
 }
 
@@ -1912,6 +1913,7 @@ ctables_freqtab_insert (struct ctables_table *t,
     [PIVOT_AXIS_COLUMN] = ic,
     [PIVOT_AXIS_LAYER] = il,
   };
+  const struct var_array *ss = &t->vaas[t->summary_axis].vas[ix[t->summary_axis]];
 
   size_t hash = 0;
   for (enum pivot_axis_type a = 0; a < PIVOT_N_AXES; a++)
@@ -1919,8 +1921,9 @@ ctables_freqtab_insert (struct ctables_table *t,
       const struct var_array *va = &t->vaas[a].vas[ix[a]];
       hash = hash_int (ix[a], hash);
       for (size_t i = 0; i < va->n; i++)
-        hash = value_hash (case_data (c, va->vars[i]),
-                           var_get_width (va->vars[i]), hash);
+        if (i != va->scale_idx)
+          hash = value_hash (case_data (c, va->vars[i]),
+                             var_get_width (va->vars[i]), hash);
     }
 
   struct ctables_freq *f;
@@ -1932,14 +1935,14 @@ ctables_freqtab_insert (struct ctables_table *t,
           if (f->axes[a].vaa_idx != ix[a])
             goto not_equal;
           for (size_t i = 0; i < va->n; i++)
-            if (!value_equal (case_data (c, va->vars[i]),
-                              &f->axes[a].values[i],
-                              var_get_width (va->vars[i])))
-              goto not_equal;
+            if (i != va->scale_idx
+                && !value_equal (case_data (c, va->vars[i]),
+                                 &f->axes[a].values[i],
+                                 var_get_width (va->vars[i])))
+                goto not_equal;
         }
 
-      f->count += weight;
-      return;
+      goto summarize;
 
     not_equal: ;
     }
@@ -1956,8 +1959,15 @@ ctables_freqtab_insert (struct ctables_table *t,
         value_clone (&f->axes[a].values[i], case_data (c, va->vars[i]),
                      var_get_width (va->vars[i]));
     }
-  f->count = weight;
+  f->summaries = xmalloc (ss->n_summaries * sizeof *f->summaries);
+  for (size_t i = 0; i < ss->n_summaries; i++)
+    ctables_summary_init (&f->summaries[i], &ss->summaries[i]);
   hmap_insert (&t->ft, &f->node, hash);
+
+summarize:
+  for (size_t i = 0; i < ss->n_summaries; i++)
+    ctables_summary_add (&f->summaries[i], &ss->summaries[i], ss->summary_var,
+                         case_data (c, ss->summary_var), weight);
 }
 
 static bool
@@ -2003,11 +2013,13 @@ ctables_execute (struct dataset *ds, struct ctables *ct)
                                                               dataset_dict (ds),
                                                               NULL, NULL);
   bool warn_on_invalid = true;
+  double total_weight = 0;
   for (struct ccase *c = casereader_read (input); c;
        case_unref (c), c = casereader_read (input))
     {
       double weight = dict_get_case_weight (dataset_dict (ds), c,
                                             &warn_on_invalid);
+      total_weight += weight;
 
       for (size_t i = 0; i < ct->n_tables; i++)
         {
@@ -2025,7 +2037,18 @@ ctables_execute (struct dataset *ds, struct ctables *ct)
     {
       struct ctables_table *t = ct->tables[i];
 
-      struct pivot_table *pt = pivot_table_create (N_("Custom Tables"));
+      struct pivot_table *pt = pivot_table_create__ (
+        (t->title
+         ? pivot_value_new_user_text (t->title, SIZE_MAX)
+         : pivot_value_new_text (N_("Custom Tables"))),
+        NULL);
+      if (t->caption)
+        pivot_table_set_caption (
+          pt, pivot_value_new_user_text (t->caption, SIZE_MAX));
+      if (t->corner)
+        pivot_table_set_caption (
+          pt, pivot_value_new_user_text (t->corner, SIZE_MAX));
+
       pivot_table_set_look (pt, ct->look);
       struct pivot_dimension *d[PIVOT_N_AXES];
       for (enum pivot_axis_type a = 0; a < PIVOT_N_AXES; a++)
@@ -2075,9 +2098,10 @@ ctables_execute (struct dataset *ds, struct ctables *ct)
                   if (prev->axes[a].vaa_idx == f->axes[a].vaa_idx)
                     {
                       for (; n_common < va->n; n_common++)
-                        if (!value_equal (&prev->axes[a].values[n_common],
-                                          &f->axes[a].values[n_common],
-                                          var_get_type (va->vars[n_common])))
+                        if (n_common != va->scale_idx
+                            && !value_equal (&prev->axes[a].values[n_common],
+                                             &f->axes[a].values[n_common],
+                                             var_get_type (va->vars[n_common])))
                           break;
                     }
                   else
@@ -2104,14 +2128,17 @@ ctables_execute (struct dataset *ds, struct ctables *ct)
                 {
                   struct pivot_category *parent = k > 0 ? groups[k - 1] : top;
 
-                  struct pivot_value *label = pivot_value_new_var_value (
-                    va->vars[k], &f->axes[a].values[k]);
-
+                  struct pivot_value *label
+                    = (k != va->scale_idx
+                       ? pivot_value_new_var_value (va->vars[k],
+                                                    &f->axes[a].values[k])
+                       : NULL);
                   if (k == va->n - 1)
                     {
                       if (a == t->summary_axis)
                         {
-                          parent = pivot_category_create_group__ (parent, label);
+                          if (label)
+                            parent = pivot_category_create_group__ (parent, label);
                           for (size_t m = 0; m < va->n_summaries; m++)
                             {
                               int leaf = pivot_category_create_leaf (
@@ -2121,11 +2148,18 @@ ctables_execute (struct dataset *ds, struct ctables *ct)
                             }
                         }
                       else
-                        prev_leaf = pivot_category_create_leaf (parent, label);
+                        {
+                          /* This assertion is true as long as the summary axis
+                             is the axis where the summaries are displayed. */
+                          assert (label);
+
+                          prev_leaf = pivot_category_create_leaf (parent, label);
+                        }
                       break;
                     }
 
-                  parent = pivot_category_create_group__ (parent, label);
+                  if (label)
+                    parent = pivot_category_create_group__ (parent, label);
 
                   enum ctables_vlabel vlabel = ct->vlabels[var_get_dict_index (va->vars[k + 1])];
                   if (vlabel != CTVL_NONE)
@@ -2142,14 +2176,26 @@ ctables_execute (struct dataset *ds, struct ctables *ct)
       struct ctables_freq *f;
       HMAP_FOR_EACH (f, struct ctables_freq, node, &t->ft)
         {
-          size_t dindexes[3];
-          size_t n_dindexes = 0;
-
-          for (enum pivot_axis_type a = 0; a < PIVOT_N_AXES; a++)
-            if (d[a])
-              dindexes[n_dindexes++] = f->axes[a].leaf;
-          pivot_table_put (pt, dindexes, n_dindexes,
-                           pivot_value_new_number (f->count));
+          const struct var_array *ss = &t->vaas[t->summary_axis].vas[f->axes[t->summary_axis].vaa_idx];
+          for (size_t j = 0; j < ss->n_summaries; j++)
+            {
+              size_t dindexes[3];
+              size_t n_dindexes = 0;
+
+              for (enum pivot_axis_type a = 0; a < PIVOT_N_AXES; a++)
+                if (d[a])
+                  {
+                    int leaf = f->axes[a].leaf;
+                    if (a == t->summary_axis)
+                      leaf += j;
+                    dindexes[n_dindexes++] = leaf;
+                  }
+
+              double d = ctables_summary_value (&f->summaries[j], &ss->summaries[j]);
+              struct pivot_value *value = pivot_value_new_number (d);
+              value->numeric.format = ss->summaries[j].format;
+              pivot_table_put (pt, dindexes, n_dindexes, value);
+            }
         }
 
       pivot_table_submit (pt);