Add GRAPH command initially with just scatterplots and histograms.
[pspp] / src / output / charts / scatterplot.h
diff --git a/src/output/charts/scatterplot.h b/src/output/charts/scatterplot.h
new file mode 100644 (file)
index 0000000..e95562b
--- /dev/null
@@ -0,0 +1,106 @@
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2014 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
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+
+#ifndef OUTPUT_CHARTS_SCATTERPLOT_H
+#define OUTPUT_CHARTS_SCATTERPLOT_H 1
+
+#include "output/chart-item.h"
+
+/* A  scatterplot. */
+struct scatterplot_chart
+  {
+    struct chart_item chart_item;
+    struct casereader *data;
+    const struct variable *xvar, *yvar, *byvar;
+
+    double y_min, y_max;
+    double x_min, x_max;
+    /* If the number of distinct values of byvar */
+    /* exceeds a certain limit, the warning flag */
+    /* is activated after the chart is drawn     */
+    bool *byvar_overflow;
+  };
+
+struct scatterplot_chart *
+scatterplot_create (const struct casereader *, 
+                   const struct variable *, 
+                   const struct variable *,
+                   const struct variable *,
+                   bool *,
+                   const char *label,
+                   double xmin, double xmax, double ymin, double ymax);
+\f
+/* This boilerplate for scatterplot_chart, a subclass of chart_item, was
+   autogenerated by mk-class-boilerplate. */
+
+#include <assert.h>
+#include "libpspp/cast.h"
+
+extern const struct chart_item_class scatterplot_chart_class;
+
+/* Returns true if SUPER is a scatterplot_chart, otherwise false. */
+static inline bool
+is_scatterplot_chart (const struct chart_item *super)
+{
+  return super->class == &scatterplot_chart_class;
+}
+
+/* Returns SUPER converted to scatterplot_chart.  SUPER must be a scatterplot_chart, as
+   reported by is_scatterplot_chart. */
+static inline struct scatterplot_chart *
+to_scatterplot_chart (const struct chart_item *super)
+{
+  assert (is_scatterplot_chart (super));
+  return UP_CAST (super, struct scatterplot_chart, chart_item);
+}
+
+/* Returns INSTANCE converted to chart_item. */
+static inline struct chart_item *
+scatterplot_chart_super (const struct scatterplot_chart *instance)
+{
+  return CONST_CAST (struct chart_item *, &instance->chart_item);
+}
+
+/* Increments INSTANCE's reference count and returns INSTANCE. */
+static inline struct scatterplot_chart *
+scatterplot_chart_ref (const struct scatterplot_chart *instance)
+{
+  return to_scatterplot_chart (chart_item_ref (&instance->chart_item));
+}
+
+/* Decrements INSTANCE's reference count, then destroys INSTANCE if
+   the reference count is now zero. */
+static inline void
+scatterplot_chart_unref (struct scatterplot_chart *instance)
+{
+  chart_item_unref (&instance->chart_item);
+}
+
+/* Returns true if INSTANCE's reference count is greater than 1,
+   false otherwise. */
+static inline bool
+scatterplot_chart_is_shared (const struct scatterplot_chart *instance)
+{
+  return chart_item_is_shared (&instance->chart_item);
+}
+
+static inline void
+scatterplot_chart_submit (struct scatterplot_chart *instance)
+{
+  chart_item_submit (&instance->chart_item);
+}
+\f
+#endif /* output/charts/scatterplot.h */