src/weight.c

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   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., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #include <config.h>
  21 #include <assert.h>
  22 #include <stdio.h>
  23 #include "command.h"
  24 #include "error.h"
  25 #include "lexer.h"
  26 #include "str.h"
  27 #include "var.h"
  28
  29 /* Notes:
  30
  31    If the weighting variable is deleted somehow (for instance by
  32    end-of-scope of TEMPORARY), weighting must be canceled.
  33
  34    Scratch vars may not be used for weighting. */
  35
  36 /* WEIGHT transformation. */
  37 struct weight_trns
  38   {
  39     struct trns_header h;
  40     int src;                    /* `value' index of weighting variable. */
  41     int dest;                   /* `value' index of $WEIGHT. */
  42   };
  43
  44 int
  45 cmd_weight (void)
  46 {
  47   lex_match_id ("WEIGHT");
  48
  49   if (lex_match_id ("OFF"))
  50     default_dict.weight_var[0] = 0;
  51   else
  52     {
  53       struct variable *v;
  54
  55       lex_match (T_BY);
  56       v = parse_variable ();
  57       if (!v)
  58         return CMD_FAILURE;
  59       if (v->type == ALPHA)
  60         {
  61           msg (SE, _("The weighting variable must be numeric."));
  62           return CMD_FAILURE;
  63         }
  64       if (v->name[0] == '#')
  65         {
  66           msg (SE, _("The weighting variable may not be scratch."));
  67           return CMD_FAILURE;
  68         }
  69
  70       strcpy (default_dict.weight_var, v->name);
  71     }
  72
  73   return lex_end_of_command ();
  74 }
  75
  76 #if 0 /* FIXME: dead code. */
  77 static int
  78 weight_trns_proc (any_trns * pt, ccase * c)
  79 {
  80   weight_trns *t = (weight_trns *) pt;
  81
  82   c->data[t->dest].f = c->data[t->src].f;
  83   return -1;
  84 }
  85 #endif
  86 \f
  87 /* Global functions. */
  88
  89 /* Sets the weight_index member of dictionary D to an appropriate
  90    value for the value of weight_var, and returns the weighting
  91    variable if any or NULL if none. */
  92 struct variable *
  93 update_weighting (struct dictionary * d)
  94 {
  95   if (d->weight_var[0])
  96     {
  97       struct variable *v = find_dict_variable (d, d->weight_var);
  98       if (v && v->type == NUMERIC)
  99         {
 100           d->weight_index = v->fv;
 101           return v;
 102         }
 103       else
 104         {
 105 #if GLOBAL_DEBUGGING
 106           printf (_("bad weighting variable, canceling\n"));
 107 #endif
 108           d->weight_var[0] = 0;
 109         }
 110     }
 111
 112   d->weight_index = -1;
 113   return NULL;
 114 }
 115
 116 /* Turns off case weighting for dictionary D. */
 117 void
 118 stop_weighting (struct dictionary * d)
 119 {
 120   d->weight_var[0] = 0;
 121 }