src/output/charts/np-plot.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2004, 2008, 2009 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 OUTPUT_CHARTS_NP_PLOT_H
  18 #define OUTPUT_CHARTS_NP_PLOT_H 1
  19
  20 #include <output/chart-item.h>
  21
  22 struct np;
  23
  24 /* An NP or DNP plot. */
  25 struct np_plot_chart
  26   {
  27     struct chart_item chart_item;
  28     struct casereader *data;
  29     bool detrended;
  30
  31     /* Copied directly from struct np. */
  32     double y_min, y_max;
  33     double dns_min, dns_max;
  34
  35     /* Calculated. */
  36     double slope, intercept;
  37     double y_first, y_last;
  38     double x_lower, x_upper;
  39     double slack;
  40   };
  41
  42 struct chart_item *np_plot_create (const struct np *,
  43                                    const struct casereader *,
  44                                    const char *label);
  45 struct chart_item *dnp_plot_create (const struct np *,
  46                                     const struct casereader *,
  47                                     const char *label);
  48 \f
  49 /* This boilerplate for np_plot_chart, a subclass of chart_item, was
  50    autogenerated by mk-class-boilerplate. */
  51
  52 #include <assert.h>
  53 #include <libpspp/cast.h>
  54
  55 extern const struct chart_item_class np_plot_chart_class;
  56
  57 /* Returns true if SUPER is a np_plot_chart, otherwise false. */
  58 static inline bool
  59 is_np_plot_chart (const struct chart_item *super)
  60 {
  61   return super->class == &np_plot_chart_class;
  62 }
  63
  64 /* Returns SUPER converted to np_plot_chart.  SUPER must be a np_plot_chart, as
  65    reported by is_np_plot_chart. */
  66 static inline struct np_plot_chart *
  67 to_np_plot_chart (const struct chart_item *super)
  68 {
  69   assert (is_np_plot_chart (super));
  70   return UP_CAST (super, struct np_plot_chart, chart_item);
  71 }
  72
  73 /* Returns INSTANCE converted to chart_item. */
  74 static inline struct chart_item *
  75 np_plot_chart_super (const struct np_plot_chart *instance)
  76 {
  77   return CONST_CAST (struct chart_item *, &instance->chart_item);
  78 }
  79
  80 /* Increments INSTANCE's reference count and returns INSTANCE. */
  81 static inline struct np_plot_chart *
  82 np_plot_chart_ref (const struct np_plot_chart *instance)
  83 {
  84   return to_np_plot_chart (chart_item_ref (&instance->chart_item));
  85 }
  86
  87 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
  88    the reference count is now zero. */
  89 static inline void
  90 np_plot_chart_unref (struct np_plot_chart *instance)
  91 {
  92   chart_item_unref (&instance->chart_item);
  93 }
  94
  95 /* Returns true if INSTANCE's reference count is greater than 1,
  96    false otherwise. */
  97 static inline bool
  98 np_plot_chart_is_shared (const struct np_plot_chart *instance)
  99 {
 100   return chart_item_is_shared (&instance->chart_item);
 101 }
 102
 103 static inline void
 104 np_plot_chart_submit (struct np_plot_chart *instance)
 105 {
 106   chart_item_submit (&instance->chart_item);
 107 }
 108 \f
 109 #endif /* output/charts/np-plot.h */