Start working to eliminate VFM dependence on static variables.
[pspp-builds.git] / 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 /* DESCRIPTIVES private data.  Note that the DESCRIPTIVES procedure also
119    has a transformation, descriptives_trns. */
120 enum
121   {
122     /* As these are used as bit indexes, there must be 32 or fewer.
123        Be very careful in adjusting these, see the structure below
124        and the table in descriptives.q. */
125     dsc_mean = 0, dsc_semean, dsc_stddev, dsc_variance, dsc_kurt,
126     dsc_sekurt, dsc_skew, dsc_seskew, dsc_range, dsc_min,
127     dsc_max, dsc_sum, dsc_n_stats
128   };
129
130 struct descriptives_proc
131   {
132     /* Miscellaneous. */
133     int dup;                    /* Finds duplicates in list of
134                                    variables. */
135     char zname[10];             /* Name for z-score variable. */
136
137     /* Counts. */
138     double valid, miss;         /* Valid, missing--general. */
139
140     /* Mean, moments about the mean. */
141     double X_bar, M2, M3, M4;
142     double min, max;
143
144     /* Statistics. */
145     double stats[dsc_n_stats];  /* Everything glommed together. */
146   };
147
148 /* GET private data. */
149 struct get_proc
150   {
151     int fv, nv;                 /* First, # of values. */
152   };
153
154 /* MEANS private data. */
155 struct means_proc
156   {
157     double min, max;            /* Range for integer mode. */
158   };
159
160 /* Different types of variables for MATRIX DATA procedure.  Order is
161    important: these are used for sort keys. */
162 enum
163   {
164     MXD_SPLIT,                  /* SPLIT FILE variables. */
165     MXD_ROWTYPE,                /* ROWTYPE_. */
166     MXD_FACTOR,                 /* Factor variables. */
167     MXD_VARNAME,                /* VARNAME_. */
168     MXD_CONTINUOUS,             /* Continuous variables. */
169
170     MXD_COUNT
171   };
172
173 /* MATRIX DATA private data. */
174 struct matrix_data_proc
175   {
176     int vartype;                /* Variable type. */
177     int subtype;                /* Subtype. */
178   };
179
180 /* MATCH FILES private data. */
181 struct match_files_proc
182   {
183     struct variable *master;    /* Corresponding master file variable. */
184   };
185
186 \f
187 /* Script variables. */
188
189 /* Variable type. */
190 enum
191   {
192     NUMERIC,                    /* A numeric variable. */
193     ALPHA                       /* A string variable.  (STRING is pre-empted by lexer.h) */
194   };
195
196 /* Types of missing values.  Order is significant, see
197    mis-val.c:parse_numeric(), sfm-read.c:sfm_read_dictionary()
198    sfm-write.c:sfm_write_dictionary(),
199    sysfile-info.c:cmd_sysfile_info(), mis-val.c:copy_missing_values(),
200    pfm-read.c:read_variables(), pfm-write.c:write_variables(),
201    apply-dict.c:cmd_apply_dictionary(), and more (?). */
202 enum
203   {
204     MISSING_NONE,               /* No user-missing values. */
205     MISSING_1,                  /* One user-missing value. */
206     MISSING_2,                  /* Two user-missing values. */
207     MISSING_3,                  /* Three user-missing values. */
208     MISSING_RANGE,              /* [a,b]. */
209     MISSING_LOW,                /* (-inf,a]. */
210     MISSING_HIGH,               /* (a,+inf]. */
211     MISSING_RANGE_1,            /* [a,b], c. */
212     MISSING_LOW_1,              /* (-inf,a], b. */
213     MISSING_HIGH_1,             /* (a,+inf), b. */
214     MISSING_COUNT
215   };
216
217 /* A variable's dictionary entry.  */
218 struct variable
219   {
220     char name[9];               /* As a string. */
221     int index;                  /* Index into its dictionary's var[]. */
222     int type;                   /* NUMERIC or ALPHA. */
223
224     /* Also important but parse_variables() doesn't need it.  Still,
225        check before reordering. */
226     int width;                  /* Size of string variables in chars. */
227     int fv, nv;                 /* Index into `value's, number of values. */
228     unsigned init : 1;          /* 1=VFM must init and possibly reinit. */
229     unsigned reinit : 1;        /* Cases are: 1=reinitialized; 0=left. */
230
231     /* Missing values. */
232     int miss_type;              /* One of the MISSING_* constants. */
233     union value missing[3];     /* User-missing value. */
234
235     /* Display formats. */
236     struct fmt_spec print;      /* Default format for PRINT. */
237     struct fmt_spec write;      /* Default format for WRITE. */
238
239     /* Labels. */
240     struct val_labs *val_labs;
241     char *label;                /* Variable label. */
242
243     /* Per-procedure info. */
244     void *aux;
245     struct get_proc get;
246     union
247       {
248         struct crosstab_proc crs;
249         struct descriptives_proc dsc;
250         struct frequencies_proc frq;
251         struct list_proc lst;
252         struct means_proc mns;
253         struct matrix_data_proc mxd;
254         struct match_files_proc mtf;
255         struct t_test_proc t_t;
256       }
257     p;
258   };
259
260 int compare_variables (const void *, const void *, void *);
261 unsigned hash_variable (const void *, void *);
262
263 /* Classes of variables. */
264 enum dict_class 
265   {
266     DC_ORDINARY,                /* Ordinary identifier. */
267     DC_SYSTEM,                  /* System variable. */
268     DC_SCRATCH                  /* Scratch variable. */
269   };
270
271 enum dict_class dict_class_from_id (const char *name);
272 const char *dict_class_to_name (enum dict_class dict_class);
273 \f
274 /* Vector of variables. */
275 struct vector
276   {
277     int idx;                    /* Index for dict_get_vector(). */
278     char name[9];               /* Name. */
279     struct variable **var;      /* Vector of variables. */
280     int cnt;                    /* Number of variables. */
281   };
282 \f
283 /* Cases. */
284
285 /* A single case.  (This doesn't need to be a struct anymore, but it
286    remains so for hysterical raisins.) */
287 struct ccase
288   {
289     union value data[1];
290   };
291
292 /* Linked list of cases. */
293 struct case_list 
294   {
295     struct case_list *next;
296     struct ccase c;
297   };
298 \f
299 /* Dictionary. */ 
300
301 /* Complete dictionary state. */
302 struct dictionary;
303
304 struct dictionary *dict_create (void);
305 struct dictionary *dict_clone (const struct dictionary *);
306 void dict_clear (struct dictionary *);
307 void dict_destroy (struct dictionary *);
308
309 size_t dict_get_var_cnt (const struct dictionary *);
310 struct variable *dict_get_var (const struct dictionary *, size_t idx);
311 void dict_get_vars (const struct dictionary *,
312                     struct variable ***vars, size_t *cnt,
313                     unsigned exclude_classes);
314
315 struct variable *dict_create_var (struct dictionary *, const char *,
316                                   int width);
317 struct variable *dict_create_var_assert (struct dictionary *, const char *,
318                                   int width);
319 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
320                                  const char *);
321 void dict_rename_var (struct dictionary *, struct variable *, const char *);
322
323 struct variable *dict_lookup_var (const struct dictionary *, const char *);
324 struct variable *dict_lookup_var_assert (const struct dictionary *,
325                                          const char *);
326 int dict_contains_var (const struct dictionary *, const struct variable *);
327 void dict_delete_var (struct dictionary *, struct variable *);
328 void dict_delete_vars (struct dictionary *,
329                        struct variable *const *, size_t count);
330 void dict_reorder_vars (struct dictionary *,
331                         struct variable *const *, size_t count);
332 int dict_rename_vars (struct dictionary *,
333                       struct variable **, char **new_names,
334                       size_t count, char **err_name);
335
336 struct variable *dict_get_weight (const struct dictionary *);
337 double dict_get_case_weight (const struct dictionary *, const struct ccase *);
338 void dict_set_weight (struct dictionary *, struct variable *);
339
340 struct variable *dict_get_filter (const struct dictionary *);
341 void dict_set_filter (struct dictionary *, struct variable *);
342
343 int dict_get_case_limit (const struct dictionary *);
344 void dict_set_case_limit (struct dictionary *, int);
345
346 int dict_get_next_value_idx (const struct dictionary *);
347 size_t dict_get_case_size (const struct dictionary *);
348 void dict_compact_values (struct dictionary *);
349
350 struct variable *const *dict_get_split_vars (const struct dictionary *);
351 size_t dict_get_split_cnt (const struct dictionary *);
352 void dict_set_split_vars (struct dictionary *,
353                           struct variable *const *, size_t cnt);
354
355 const char *dict_get_label (const struct dictionary *);
356 void dict_set_label (struct dictionary *, const char *);
357
358 const char *dict_get_documents (const struct dictionary *);
359 void dict_set_documents (struct dictionary *, const char *);
360
361 int dict_create_vector (struct dictionary *,
362                         const char *name,
363                         struct variable **, size_t cnt);
364 const struct vector *dict_get_vector (const struct dictionary *,
365                                       size_t idx);
366 size_t dict_get_vector_cnt (const struct dictionary *);
367 const struct vector *dict_lookup_vector (const struct dictionary *,
368                                          const char *name);
369 void dict_clear_vectors (struct dictionary *);
370 \f
371 void discard_variables (void);
372
373 /* This is the active file dictionary. */
374 extern struct dictionary *default_dict;
375 \f
376 /* Transformation state. */
377
378 /* Default file handle for DATA LIST, REREAD, REPEATING DATA
379    commands. */
380 extern struct file_handle *default_handle;
381
382 /* PROCESS IF expression. */
383 extern struct expression *process_if_expr;
384 \f
385 /* TEMPORARY support. */
386
387 /* 1=TEMPORARY has been executed at some point. */
388 extern int temporary;
389
390 /* If temporary!=0, the saved dictionary. */
391 extern struct dictionary *temp_dict;
392
393 /* If temporary!=0, index into t_trns[] (declared far below) that
394    gives the point at which data should be written out.  -1 means that
395    the data shouldn't be changed since all transformations are
396    temporary. */
397 extern int temp_trns;
398
399 /* If FILTER is active, whether it was executed before or after
400    TEMPORARY. */
401 extern int FILTER_before_TEMPORARY;
402
403 void cancel_temporary (void);
404 \f
405 /* Functions. */
406
407 void dump_split_vars (const struct ccase *);
408
409 int is_num_user_missing (double, const struct variable *);
410 int is_str_user_missing (const unsigned char[], const struct variable *);
411 int is_missing (const union value *, const struct variable *);
412 int is_system_missing (const union value *, const struct variable *);
413 int is_user_missing (const union value *, const struct variable *);
414 void copy_missing_values (struct variable *dest, const struct variable *src);
415 \f
416 /* Transformations. */
417
418 struct trns_header;
419 typedef int trns_proc_func (struct trns_header *, struct ccase *, int);
420 typedef void trns_free_func (struct trns_header *);
421
422 /* Header for all transformations. */
423 struct trns_header
424   {
425     int index;                  /* Index into t_trns[]. */
426     trns_proc_func *proc;       /* Transformation proc. */
427     trns_free_func *free;       /* Garbage collector proc. */
428   };
429
430 /* Array of transformations */
431 extern struct trns_header **t_trns;
432
433 /* Number of transformations, maximum number in array currently. */
434 extern int n_trns, m_trns;
435
436 /* Index of first transformation that is really a transformation.  Any
437    transformations before this belong to INPUT PROGRAM. */
438 extern int f_trns;
439
440 void add_transformation (struct trns_header *trns);
441 void cancel_transformations (void);
442 \f
443 struct var_set;
444
445 struct var_set *var_set_create_from_dict (struct dictionary *d);
446 struct var_set *var_set_create_from_array (struct variable **var, size_t);
447
448 size_t var_set_get_cnt (struct var_set *vs);
449 struct variable *var_set_get_var (struct var_set *vs, size_t idx);
450 struct variable *var_set_lookup_var (struct var_set *vs, const char *name);
451 void var_set_destroy (struct var_set *vs);
452
453 \f
454 /* Variable parsers. */
455
456 enum
457   {
458     PV_NONE = 0,                /* No options. */
459     PV_SINGLE = 0001,           /* Restrict to a single name or TO use. */
460     PV_DUPLICATE = 0002,        /* Don't merge duplicates. */
461     PV_APPEND = 0004,           /* Append to existing list. */
462     PV_NO_DUPLICATE = 0010,     /* Error on duplicates. */
463     PV_NUMERIC = 0020,          /* Vars must be numeric. */
464     PV_STRING = 0040,           /* Vars must be string. */
465     PV_SAME_TYPE = 00100,       /* All vars must be the same type. */
466     PV_NO_SCRATCH = 00200,      /* Disallow scratch variables. */
467   };
468
469 struct variable *parse_variable (void);
470 struct variable *parse_dict_variable (struct dictionary *);
471 int parse_variables (struct dictionary *, struct variable ***, int *,
472                      int opts);
473 int parse_var_set_vars (struct var_set *, struct variable ***, int *,
474                         int opts);
475 int parse_DATA_LIST_vars (char ***names, int *cnt, int opts);
476 int parse_mixed_vars (char ***names, int *cnt, int opts);
477
478 #endif /* !var_h */