src/data/casefilter.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3    Written by John Darrington <john@darrington.wattle.id.au>
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #if !casefilter_h
  21 #define casefilter_h 1
  22
  23 #include <stdbool.h>
  24
  25 struct ccase;
  26 struct casefilter;
  27 struct variable ;
  28
  29 /* Create a new casefilter.
  30    If EXCL is true, then the filter  user missing values to be missing,
  31    otherwise they are considered at their face value.
  32    VARS is an array of variables which if *any* of them are missing.
  33    N_VARS is the size of VARS.
  34  */
  35 struct casefilter * casefilter_create (bool, struct variable **, int);
  36
  37 /* Add the variables in VARS to the list of variables for which the
  38    filter considers. N_VARS is the size of VARS */
  39 void casefilter_add_variables (struct casefilter *, struct variable **, int);
  40
  41 /* Destroy the filter FILTER */
  42 void casefilter_destroy (struct casefilter *);
  43
  44 /* Returns true iff the entire case should be skipped */
  45 bool casefilter_skip_case (const struct casefilter *, const struct ccase *);
  46
  47 /* Returns true iff the variable V in case C is missing */
  48 bool casefilter_variable_missing (const struct casefilter *f,
  49                                    const struct ccase *c,
  50                                    const struct variable *v);
  51
  52 #endif