src/data/casefilter.c

   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 #include <config.h>
  21 #include <libpspp/alloc.h>
  22 #include <libpspp/compiler.h>
  23 #include "casefilter.h"
  24 #include <stdlib.h>
  25
  26 #include <stdio.h>
  27 #include <data/case.h>
  28 #include <data/variable.h>
  29 #include <data/missing-values.h>
  30
  31 struct casefilter
  32  {
  33    bool exclude_user_missing;
  34
  35    const struct variable **vars;
  36    int n_vars;
  37  };
  38
  39
  40 /* Returns true iff the entire case should be skipped */
  41 bool
  42 casefilter_skip_case (const struct casefilter *filter, const struct ccase *c)
  43 {
  44   int i;
  45
  46   for (i = 0; i < filter->n_vars; ++i)
  47     {
  48       if ( casefilter_variable_missing (filter, c, filter->vars[i]))
  49         return true;
  50     }
  51
  52   return false;
  53 }
  54
  55 /* Returns true iff the variable V in case C is missing */
  56 bool
  57 casefilter_variable_missing (const struct casefilter *filter,
  58                              const struct ccase *c,
  59                              const struct variable *var)
  60 {
  61   const union value *val = case_data (c, var->fv) ;
  62
  63   if ( val->f == SYSMIS )
  64     return true;
  65
  66   if ( filter->exclude_user_missing &&
  67        var_is_value_user_missing (var, val) )
  68     return true;
  69
  70   return false;
  71 }
  72
  73 /* Create a new casefilter.
  74    If EXCL is true, then the filter  user missing values to be missing,
  75    otherwise they are considered at their face value.
  76    VARS is an array of variables which if *any* of them are missing.
  77    N_VARS is the size of VARS.
  78  */
  79 struct casefilter *
  80 casefilter_create (bool excl, struct variable **vars, int n_vars)
  81 {
  82   int i;
  83   struct casefilter * filter = xmalloc (sizeof (*filter)) ;
  84
  85   filter->exclude_user_missing = excl ;
  86   filter->vars = xnmalloc (n_vars, sizeof (*filter->vars) );
  87
  88   for ( i = 0 ; i < n_vars ; ++i )
  89     filter->vars[i] = vars[i];
  90
  91   filter->n_vars = n_vars ;
  92
  93   return filter ;
  94 }
  95
  96
  97 /* Add the variables in VARS to the list of variables for which the
  98    filter considers. N_VARS is the size of VARS */
  99 void
 100 casefilter_add_variables (struct casefilter *filter,
 101                            struct variable **vars, int n_vars)
 102 {
 103   int i;
 104
 105   filter->vars = xnrealloc (filter->vars, filter->n_vars + n_vars,
 106                            sizeof (*filter->vars) );
 107
 108   for ( i = 0 ; i < n_vars ; ++i )
 109     filter->vars[i + filter->n_vars] = vars[i];
 110
 111   filter->n_vars += n_vars ;
 112 }
 113
 114 /* Destroy the filter FILTER */
 115 void
 116 casefilter_destroy (struct casefilter *filter)
 117 {
 118   free (filter->vars);
 119   free (filter);
 120 }
 121
 122