src/data/casegrouper.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2007 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    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, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17    02110-1301, USA. */
  18
  19 /* Casegrouper.
  20
  21    Breaks up the cases from a casereader into sets of contiguous
  22    cases based on some criteria, e.g. sets of cases that all have
  23    the same values for some subset of variables.  Each set of
  24    cases is made available to the client as a casereader. */
  25
  26 #ifndef DATA_CASEGROUPER_H
  27 #define DATA_CASEGROUPER_H 1
  28
  29 #include <stdbool.h>
  30 #include <stddef.h>
  31
  32 struct case_ordering;
  33 struct casereader;
  34 struct ccase;
  35 struct dictionary;
  36 struct variable;
  37
  38 struct casegrouper *
  39 casegrouper_create_func (struct casereader *,
  40                          bool (*same_group) (const struct ccase *,
  41                                              const struct ccase *,
  42                                              void *aux),
  43                          void (*destroy) (void *aux),
  44                          void *aux);
  45 struct casegrouper *casegrouper_create_vars (struct casereader *,
  46                                              const struct variable *const *vars,
  47                                              size_t var_cnt);
  48 struct casegrouper *casegrouper_create_splits (struct casereader *,
  49                                                const struct dictionary *);
  50 struct casegrouper *casegrouper_create_case_ordering (struct casereader *,
  51                                                       const struct case_ordering *);
  52 bool casegrouper_get_next_group (struct casegrouper *, struct casereader **);
  53 bool casegrouper_destroy (struct casegrouper *);
  54
  55 #endif /* data/casegrouper.h */