pintos-os.org Git - pspp/blob - src/output/charts/barchart.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2015 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #ifndef BARCHART_H
  18 #define BARCHART_H
  19
  20 #include "libpspp/str.h"
  21 #include "libpspp/hmap.h"
  22 #include "data/value.h"
  23 #include "output/chart-item.h"
  24
  25
  26 struct category
  27 {
  28   struct hmap_node node;
  29   int idx;                     /* Unique zero based index */
  30   struct string label;         /* The label to be displayed for this category */
  31   union value val;             /* The value of this category */
  32   int width;                   /* The width of VAL */
  33 };
  34
  35
  36 struct barchart
  37   {
  38     struct chart_item chart_item;
  39
  40     /* Should the chart be displayed as percentages */
  41     bool percent;
  42
  43     /* The categories */
  44     struct freq **cats;
  45
  46     /* The total number of categories (regardless of level) */
  47     int n_nzcats;
  48
  49     /* The number of primary categories */
  50     int n_pcats;
  51
  52     /* The largest count of all the categories */
  53     double largest;
  54
  55     /* The sum of all the counts */
  56     double total_count;
  57
  58     /* The label for the ordinate (vertical axis) */
  59     char *ylabel;
  60
  61     /* The variables holding the categorical values */
  62     const struct variable **var;
  63     int n_vars;
  64
  65     int widths[2];
  66
  67     /* A hash table of struct category indexed by VAL */
  68     struct hmap primaries;
  69
  70     /* A hash table of struct category indexed by VAL */
  71     struct hmap secondaries;
  72
  73
  74     /* A array of pointers to the members of the above hmap,
  75        sorted by VAL */
  76     struct category **ss;
  77   };
  78
  79
  80 struct variable;
  81 struct freq;
  82
  83 struct chart_item *barchart_create (const struct variable **, int n_vars,
  84                                     const char *ylabel, bool percent,
  85                                     struct freq *const *, int n_cats);
  86 \f
  87 /* This boilerplate for barchart, a subclass of chart_item, was
  88    autogenerated by mk-class-boilerplate. */
  89
  90 #include <assert.h>
  91 #include "libpspp/cast.h"
  92
  93 extern const struct chart_item_class barchart_class;
  94
  95 /* Returns true if SUPER is a barchart, otherwise false. */
  96 static inline bool
  97 is_barchart (const struct chart_item *super)
  98 {
  99   return super->class == &barchart_class;
 100 }
 101
 102 /* Returns SUPER converted to barchart.  SUPER must be a barchart, as
 103    reported by is_barchart. */
 104 static inline struct barchart *
 105 to_barchart (const struct chart_item *super)
 106 {
 107   assert (is_barchart (super));
 108   return UP_CAST (super, struct barchart, chart_item);
 109 }
 110
 111 /* Returns INSTANCE converted to chart_item. */
 112 static inline struct chart_item *
 113 barchart_super (const struct barchart *instance)
 114 {
 115   return CONST_CAST (struct chart_item *, &instance->chart_item);
 116 }
 117
 118 /* Increments INSTANCE's reference count and returns INSTANCE. */
 119 static inline struct barchart *
 120 barchart_ref (const struct barchart *instance)
 121 {
 122   return to_barchart (chart_item_ref (&instance->chart_item));
 123 }
 124
 125 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
 126    the reference count is now zero. */
 127 static inline void
 128 barchart_unref (struct barchart *instance)
 129 {
 130   chart_item_unref (&instance->chart_item);
 131 }
 132
 133 /* Returns true if INSTANCE's reference count is greater than 1,
 134    false otherwise. */
 135 static inline bool
 136 barchart_is_shared (const struct barchart *instance)
 137 {
 138   return chart_item_is_shared (&instance->chart_item);
 139 }
 140
 141 static inline void
 142 barchart_submit (struct barchart *instance)
 143 {
 144   chart_item_submit (&instance->chart_item);
 145 }
 146 \f
 147 #endif /* output/charts/barchart.h */