src/var.h

   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 #if !var_h
  21 #define var_h 1
  22
  23 #include <stddef.h>
  24 #include "format.h"
  25 #include "t-test.h"
  26 #include "val.h"
  27
  28 /* Frequency tables. */
  29
  30 /* Frequency table entry. */
  31 struct freq
  32   {
  33     union value v;              /* The value. */
  34     double c;                   /* The number of occurrences of the value. */
  35   };
  36
  37 /* Types of frequency tables. */
  38 enum
  39   {
  40     FRQM_GENERAL,
  41     FRQM_INTEGER
  42   };
  43
  44 /* Entire frequency table. */
  45 struct freq_tab
  46   {
  47     int mode;                   /* FRQM_GENERAL or FRQM_INTEGER. */
  48
  49     /* General mode. */
  50     struct hsh_table *data;     /* Undifferentiated data. */
  51
  52     /* Integer mode. */
  53     double *vector;             /* Frequencies proper. */
  54     int min, max;               /* The boundaries of the table. */
  55     double out_of_range;        /* Sum of weights of out-of-range values. */
  56     double sysmis;              /* Sum of weights of SYSMIS values. */
  57
  58     /* All modes. */
  59     struct freq *valid;         /* Valid freqs. */
  60     int n_valid;                /* Number of total freqs. */
  61
  62     struct freq *missing;       /* Missing freqs. */
  63     int n_missing;              /* Number of missing freqs. */
  64
  65     /* Statistics. */
  66     double total_cases;         /* Sum of weights of all cases. */
  67     double valid_cases;         /* Sum of weights of valid cases. */
  68   };
  69 \f
  70 /* Procedures' private per-variable data. */
  71
  72 /* Structure name suffixes for private data:
  73    _proc: for a procedure (i.e., LIST -> list_proc).
  74    _trns: for a transformation (i.e., COMPUTE -> compute_trns.
  75    _pgm: for an input program (i.e., DATA LIST -> data_list_pgm). */
  76
  77 /* CROSSTABS private data. */
  78 struct crosstab_proc
  79   {
  80     /* Integer mode only. */
  81     int min;                    /* Minimum value. */
  82     int max;                    /* Maximum value + 1. */
  83     int count;                  /* max - min. */
  84   };
  85
  86
  87 /* FREQUENCIES private data. */
  88 enum
  89   {
  90     frq_mean = 0, frq_semean, frq_median, frq_mode, frq_stddev, frq_variance,
  91     frq_kurt, frq_sekurt, frq_skew, frq_seskew, frq_range, frq_min, frq_max,
  92     frq_sum, frq_n_stats
  93   };
  94
  95 struct frequencies_proc
  96   {
  97     int used;                   /* 1=This variable already used. */
  98
  99     /* Freqency table. */
 100     struct freq_tab tab;        /* Frequencies table to use. */
 101
 102     /* Percentiles. */
 103     int n_groups;               /* Number of groups. */
 104     double *groups;             /* Groups. */
 105
 106     /* Statistics. */
 107     double stat[frq_n_stats];
 108   };
 109
 110 /* LIST private data. */
 111 struct list_proc
 112   {
 113     int newline;                /* Whether a new line begins here. */
 114     int width;                  /* Field width. */
 115     int vert;                   /* Whether to print the varname vertically. */
 116   };
 117
 118 /* GET private data. */
 119 struct get_proc
 120   {
 121     int fv, nv;                 /* First, # of values. */
 122   };
 123
 124 /* MEANS private data. */
 125 struct means_proc
 126   {
 127     double min, max;            /* Range for integer mode. */
 128   };
 129
 130 /* Different types of variables for MATRIX DATA procedure.  Order is
 131    important: these are used for sort keys. */
 132 enum
 133   {
 134     MXD_SPLIT,                  /* SPLIT FILE variables. */
 135     MXD_ROWTYPE,                /* ROWTYPE_. */
 136     MXD_FACTOR,                 /* Factor variables. */
 137     MXD_VARNAME,                /* VARNAME_. */
 138     MXD_CONTINUOUS,             /* Continuous variables. */
 139
 140     MXD_COUNT
 141   };
 142
 143 /* MATRIX DATA private data. */
 144 struct matrix_data_proc
 145   {
 146     int vartype;                /* Variable type. */
 147     int subtype;                /* Subtype. */
 148   };
 149
 150 /* MATCH FILES private data. */
 151 struct match_files_proc
 152   {
 153     struct variable *master;    /* Corresponding master file variable. */
 154   };
 155
 156 \f
 157 /* Script variables. */
 158
 159 /* Variable type. */
 160 enum
 161   {
 162     NUMERIC,                    /* A numeric variable. */
 163     ALPHA                       /* A string variable.  (STRING is pre-empted by lexer.h) */
 164   };
 165
 166 /* Types of missing values.  Order is significant, see
 167    mis-val.c:parse_numeric(), sfm-read.c:sfm_read_dictionary()
 168    sfm-write.c:sfm_write_dictionary(),
 169    sysfile-info.c:cmd_sysfile_info(), mis-val.c:copy_missing_values(),
 170    pfm-read.c:read_variables(), pfm-write.c:write_variables(),
 171    apply-dict.c:cmd_apply_dictionary(), and more (?). */
 172 enum
 173   {
 174     MISSING_NONE,               /* No user-missing values. */
 175     MISSING_1,                  /* One user-missing value. */
 176     MISSING_2,                  /* Two user-missing values. */
 177     MISSING_3,                  /* Three user-missing values. */
 178     MISSING_RANGE,              /* [a,b]. */
 179     MISSING_LOW,                /* (-inf,a]. */
 180     MISSING_HIGH,               /* (a,+inf]. */
 181     MISSING_RANGE_1,            /* [a,b], c. */
 182     MISSING_LOW_1,              /* (-inf,a], b. */
 183     MISSING_HIGH_1,             /* (a,+inf), b. */
 184     MISSING_COUNT
 185   };
 186
 187 /* A variable's dictionary entry.  */
 188 struct variable
 189   {
 190     char name[9];               /* As a string. */
 191     int index;                  /* Index into its dictionary's var[]. */
 192     int type;                   /* NUMERIC or ALPHA. */
 193
 194     int width;                  /* Size of string variables in chars. */
 195     int fv, nv;                 /* Index into `value's, number of values. */
 196     unsigned init : 1;          /* 1=VFM must init and possibly reinit. */
 197     unsigned reinit : 1;        /* Cases are: 1=reinitialized; 0=left. */
 198
 199     /* Missing values. */
 200     int miss_type;              /* One of the MISSING_* constants. */
 201     union value missing[3];     /* User-missing value. */
 202
 203     /* Display formats. */
 204     struct fmt_spec print;      /* Default format for PRINT. */
 205     struct fmt_spec write;      /* Default format for WRITE. */
 206
 207     /* Labels. */
 208     struct val_labs *val_labs;
 209     char *label;                /* Variable label. */
 210
 211     /* Per-procedure info. */
 212     void *aux;
 213     struct get_proc get;
 214     union
 215       {
 216         struct crosstab_proc crs;
 217         struct frequencies_proc frq;
 218         struct list_proc lst;
 219         struct means_proc mns;
 220         struct matrix_data_proc mxd;
 221         struct match_files_proc mtf;
 222         struct t_test_proc t_t;
 223       }
 224     p;
 225   };
 226
 227 int compare_variables (const void *, const void *, void *);
 228 unsigned hash_variable (const void *, void *);
 229
 230 /* Classes of variables. */
 231 enum dict_class
 232   {
 233     DC_ORDINARY,                /* Ordinary identifier. */
 234     DC_SYSTEM,                  /* System variable. */
 235     DC_SCRATCH                  /* Scratch variable. */
 236   };
 237
 238 enum dict_class dict_class_from_id (const char *name);
 239 const char *dict_class_to_name (enum dict_class dict_class);
 240 \f
 241 /* Vector of variables. */
 242 struct vector
 243   {
 244     int idx;                    /* Index for dict_get_vector(). */
 245     char name[9];               /* Name. */
 246     struct variable **var;      /* Vector of variables. */
 247     int cnt;                    /* Number of variables. */
 248   };
 249 \f
 250 /* Dictionary. */
 251
 252 /* Complete dictionary state. */
 253 struct dictionary;
 254
 255 struct dictionary *dict_create (void);
 256 struct dictionary *dict_clone (const struct dictionary *);
 257 void dict_clear (struct dictionary *);
 258 void dict_destroy (struct dictionary *);
 259
 260 size_t dict_get_var_cnt (const struct dictionary *);
 261 struct variable *dict_get_var (const struct dictionary *, size_t idx);
 262 void dict_get_vars (const struct dictionary *,
 263                     struct variable ***vars, size_t *cnt,
 264                     unsigned exclude_classes);
 265
 266 struct variable *dict_create_var (struct dictionary *, const char *,
 267                                   int width);
 268 struct variable *dict_create_var_assert (struct dictionary *, const char *,
 269                                   int width);
 270 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
 271                                  const char *);
 272 void dict_rename_var (struct dictionary *, struct variable *, const char *);
 273
 274 struct variable *dict_lookup_var (const struct dictionary *, const char *);
 275 struct variable *dict_lookup_var_assert (const struct dictionary *,
 276                                          const char *);
 277 int dict_contains_var (const struct dictionary *, const struct variable *);
 278 void dict_delete_var (struct dictionary *, struct variable *);
 279 void dict_delete_vars (struct dictionary *,
 280                        struct variable *const *, size_t count);
 281 void dict_reorder_vars (struct dictionary *,
 282                         struct variable *const *, size_t count);
 283 int dict_rename_vars (struct dictionary *,
 284                       struct variable **, char **new_names,
 285                       size_t count, char **err_name);
 286
 287 struct ccase;
 288 struct variable *dict_get_weight (const struct dictionary *);
 289 double dict_get_case_weight (const struct dictionary *,
 290                              const struct ccase *, int *);
 291 void dict_set_weight (struct dictionary *, struct variable *);
 292
 293 struct variable *dict_get_filter (const struct dictionary *);
 294 void dict_set_filter (struct dictionary *, struct variable *);
 295
 296 int dict_get_case_limit (const struct dictionary *);
 297 void dict_set_case_limit (struct dictionary *, int);
 298
 299 int dict_get_next_value_idx (const struct dictionary *);
 300 size_t dict_get_case_size (const struct dictionary *);
 301
 302 void dict_compact_values (struct dictionary *);
 303 size_t dict_get_compacted_value_cnt (const struct dictionary *);
 304 int *dict_get_compacted_idx_to_fv (const struct dictionary *);
 305
 306 struct variable *const *dict_get_split_vars (const struct dictionary *);
 307 size_t dict_get_split_cnt (const struct dictionary *);
 308 void dict_set_split_vars (struct dictionary *,
 309                           struct variable *const *, size_t cnt);
 310
 311 const char *dict_get_label (const struct dictionary *);
 312 void dict_set_label (struct dictionary *, const char *);
 313
 314 const char *dict_get_documents (const struct dictionary *);
 315 void dict_set_documents (struct dictionary *, const char *);
 316
 317 int dict_create_vector (struct dictionary *,
 318                         const char *name,
 319                         struct variable **, size_t cnt);
 320 const struct vector *dict_get_vector (const struct dictionary *,
 321                                       size_t idx);
 322 size_t dict_get_vector_cnt (const struct dictionary *);
 323 const struct vector *dict_lookup_vector (const struct dictionary *,
 324                                          const char *name);
 325 void dict_clear_vectors (struct dictionary *);
 326 \f
 327 void discard_variables (void);
 328
 329 /* This is the active file dictionary. */
 330 extern struct dictionary *default_dict;
 331 \f
 332 /* Transformation state. */
 333
 334 /* Default file handle for DATA LIST, REREAD, REPEATING DATA
 335    commands. */
 336 extern struct file_handle *default_handle;
 337
 338 /* PROCESS IF expression. */
 339 extern struct expression *process_if_expr;
 340 \f
 341 /* TEMPORARY support. */
 342
 343 /* 1=TEMPORARY has been executed at some point. */
 344 extern int temporary;
 345
 346 /* If temporary!=0, the saved dictionary. */
 347 extern struct dictionary *temp_dict;
 348
 349 /* If temporary!=0, index into t_trns[] (declared far below) that
 350    gives the point at which data should be written out.  -1 means that
 351    the data shouldn't be changed since all transformations are
 352    temporary. */
 353 extern int temp_trns;
 354
 355 /* If FILTER is active, whether it was executed before or after
 356    TEMPORARY. */
 357 extern int FILTER_before_TEMPORARY;
 358
 359 void cancel_temporary (void);
 360 \f
 361 /* Functions. */
 362
 363 void dump_split_vars (const struct ccase *);
 364 typedef int (* is_missing_func )(const union value *, const struct variable *);
 365
 366 int is_num_user_missing (double, const struct variable *);
 367 int is_str_user_missing (const unsigned char[], const struct variable *);
 368 int is_missing (const union value *, const struct variable *);
 369 int is_system_missing (const union value *, const struct variable *);
 370 int is_user_missing (const union value *, const struct variable *);
 371 void copy_missing_values (struct variable *dest, const struct variable *src);
 372 \f
 373 /* Transformations. */
 374
 375 struct trns_header;
 376 typedef int trns_proc_func (struct trns_header *, struct ccase *, int);
 377 typedef void trns_free_func (struct trns_header *);
 378
 379 /* Header for all transformations. */
 380 struct trns_header
 381   {
 382     int index;                  /* Index into t_trns[]. */
 383     trns_proc_func *proc;       /* Transformation proc. */
 384     trns_free_func *free;       /* Garbage collector proc. */
 385   };
 386
 387 /* Array of transformations */
 388 extern struct trns_header **t_trns;
 389
 390 /* Number of transformations, maximum number in array currently. */
 391 extern int n_trns, m_trns;
 392
 393 /* Index of first transformation that is really a transformation.  Any
 394    transformations before this belong to INPUT PROGRAM. */
 395 extern int f_trns;
 396
 397 void add_transformation (struct trns_header *trns);
 398 void cancel_transformations (void);
 399 \f
 400 struct var_set;
 401
 402 struct var_set *var_set_create_from_dict (const struct dictionary *d);
 403 struct var_set *var_set_create_from_array (struct variable *const *var,
 404                                            size_t);
 405
 406 size_t var_set_get_cnt (const struct var_set *vs);
 407 struct variable *var_set_get_var (const struct var_set *vs, size_t idx);
 408 struct variable *var_set_lookup_var (const struct var_set *vs,
 409                                      const char *name);
 410 void var_set_destroy (struct var_set *vs);
 411 \f
 412 /* Variable parsers. */
 413
 414 enum
 415   {
 416     PV_NONE = 0,                /* No options. */
 417     PV_SINGLE = 0001,           /* Restrict to a single name or TO use. */
 418     PV_DUPLICATE = 0002,        /* Don't merge duplicates. */
 419     PV_APPEND = 0004,           /* Append to existing list. */
 420     PV_NO_DUPLICATE = 0010,     /* Error on duplicates. */
 421     PV_NUMERIC = 0020,          /* Vars must be numeric. */
 422     PV_STRING = 0040,           /* Vars must be string. */
 423     PV_SAME_TYPE = 00100,       /* All vars must be the same type. */
 424     PV_NO_SCRATCH = 00200       /* Disallow scratch variables. */
 425   };
 426
 427 struct variable *parse_variable (void);
 428 struct variable *parse_dict_variable (const struct dictionary *);
 429 int parse_variables (const struct dictionary *, struct variable ***, int *,
 430                      int opts);
 431 int parse_var_set_vars (const struct var_set *, struct variable ***, int *,
 432                         int opts);
 433 int parse_DATA_LIST_vars (char ***names, int *cnt, int opts);
 434 int parse_mixed_vars (char ***names, int *cnt, int opts);
 435
 436 #endif /* !var_h */