src/language/stats/aggregate.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2010 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
  18 #ifndef AGGREGATE_H
  19 #define AGGREGATE_H
  20
  21 #include <data/format.h>
  22 #include <data/val-type.h>
  23
  24 #include <stddef.h>
  25
  26 enum agr_src_vars
  27   {
  28     AGR_SV_NO,
  29     AGR_SV_YES,
  30     AGR_SV_OPT
  31   };
  32
  33 /* Aggregation functions. */
  34 enum
  35   {
  36     SUM, MEAN, MEDIAN, SD, MAX, MIN, PGT, PLT, PIN, POUT, FGT, FLT, FIN,
  37     FOUT, N, NU, NMISS, NUMISS, FIRST, LAST,
  38
  39     FUNC = 0x1f, /* Function mask. */
  40     FSTRING = 1<<5, /* String function bit. */
  41   };
  42
  43 /* Attributes of an aggregation function. */
  44 struct agr_func
  45   {
  46     const char *name;           /* Aggregation function name. */
  47     const char *description;    /* Translatable string describing the function. */
  48     enum agr_src_vars src_vars; /* Whether source variables are a parameter of the function */
  49     size_t n_args;              /* Number of arguments (not including src vars). */
  50     enum val_type alpha_type;   /* When given ALPHA arguments, output type. */
  51     struct fmt_spec format;     /* Format spec if alpha_type != ALPHA. */
  52   };
  53
  54 extern const struct agr_func agr_func_tab[];
  55
  56
  57 #endif