7c2b37af1524d4324d16c1a1f8300cb9c39bdddd
[pspp] / src / language / stats / npar.c
1 /* PSPP - a program for statistical analysis. -*-c-*-
2    Copyright (C) 2006, 2008, 2009, 2010, 2011, 2016 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "language/stats/npar.h"
20
21 #include <stdlib.h>
22 #include <math.h>
23
24 #include "data/case.h"
25 #include "data/casegrouper.h"
26 #include "data/casereader.h"
27 #include "data/dataset.h"
28 #include "data/dictionary.h"
29 #include "data/settings.h"
30 #include "data/variable.h"
31 #include "language/command.h"
32 #include "language/lexer/lexer.h"
33 #include "language/lexer/value-parser.h"
34 #include "language/lexer/variable-parser.h"
35 #include "language/stats/binomial.h"
36 #include "language/stats/chisquare.h"
37 #include "language/stats/ks-one-sample.h"
38 #include "language/stats/cochran.h"
39 #include "language/stats/friedman.h"
40 #include "language/stats/jonckheere-terpstra.h"
41 #include "language/stats/kruskal-wallis.h"
42 #include "language/stats/mann-whitney.h"
43 #include "language/stats/mcnemar.h"
44 #include "language/stats/median.h"
45 #include "language/stats/npar-summary.h"
46 #include "language/stats/runs.h"
47 #include "language/stats/sign.h"
48 #include "language/stats/wilcoxon.h"
49 #include "libpspp/array.h"
50 #include "libpspp/assertion.h"
51 #include "libpspp/cast.h"
52 #include "libpspp/hash-functions.h"
53 #include "libpspp/hmapx.h"
54 #include "libpspp/message.h"
55 #include "libpspp/pool.h"
56 #include "libpspp/str.h"
57 #include "libpspp/taint.h"
58 #include "math/moments.h"
59
60 #include "gl/xalloc.h"
61
62 #include "gettext.h"
63 #define _(msgid) gettext (msgid)
64
65 /* Settings for subcommand specifiers. */
66 enum missing_type
67   {
68     MISS_ANALYSIS,
69     MISS_LISTWISE,
70   };
71
72 /* Array indices for STATISTICS subcommand. */
73 enum
74   {
75     NPAR_ST_DESCRIPTIVES = 0,
76     NPAR_ST_QUARTILES = 1,
77     NPAR_ST_ALL = 2,
78     NPAR_ST_count
79   };
80
81 /* NPAR TESTS structure. */
82 struct cmd_npar_tests
83   {
84     /* Count variables indicating how many
85        of the subcommands have been given. */
86     int chisquare;
87     int cochran;
88     int binomial;
89     int ks_one_sample;
90     int wilcoxon;
91     int sign;
92     int runs;
93     int friedman;
94     int kendall;
95     int kruskal_wallis;
96     int mann_whitney;
97     int mcnemar;
98     int median;
99     int jonckheere_terpstra;
100     int missing;
101     int method;
102     int statistics;
103
104     /* How missing values should be treated */
105     long miss;
106
107     /* Which statistics have been requested */
108     int a_statistics[NPAR_ST_count];
109   };
110
111
112 struct npar_specs
113 {
114   struct pool *pool;
115   struct npar_test **test;
116   size_t n_tests;
117
118   const struct variable **vv; /* Compendium of all variables
119                                   (those mentioned on ANY subcommand */
120   int n_vars; /* Number of variables in vv */
121
122   enum mv_class filter;    /* Missing values to filter. */
123
124   bool descriptives;       /* Descriptive statistics should be calculated */
125   bool quartiles;          /* Quartiles should be calculated */
126
127   bool exact;  /* Whether exact calculations have been requested */
128   double timer;   /* Maximum time (in minutes) to wait for exact calculations */
129 };
130
131
132 /* Prototype for custom subcommands of NPAR TESTS. */
133 static int npar_chisquare (struct lexer *, struct dataset *, struct npar_specs *);
134 static int npar_binomial (struct lexer *, struct dataset *,  struct npar_specs *);
135 static int npar_ks_one_sample (struct lexer *, struct dataset *, struct npar_specs *);
136 static int npar_runs (struct lexer *, struct dataset *, struct npar_specs *);
137 static int npar_friedman (struct lexer *, struct dataset *, struct npar_specs *);
138 static int npar_kendall (struct lexer *, struct dataset *, struct npar_specs *);
139 static int npar_cochran (struct lexer *, struct dataset *, struct npar_specs *);
140 static int npar_wilcoxon (struct lexer *, struct dataset *, struct npar_specs *);
141 static int npar_sign (struct lexer *, struct dataset *, struct npar_specs *);
142 static int npar_kruskal_wallis (struct lexer *, struct dataset *, struct npar_specs *);
143 static int npar_jonckheere_terpstra (struct lexer *, struct dataset *, struct npar_specs *);
144 static int npar_mann_whitney (struct lexer *, struct dataset *, struct npar_specs *);
145 static int npar_mcnemar (struct lexer *, struct dataset *, struct npar_specs *);
146 static int npar_median (struct lexer *, struct dataset *, struct npar_specs *);
147
148 static int npar_method (struct lexer *, struct npar_specs *);
149
150 /* Command parsing functions. */
151 static int parse_npar_tests (struct lexer *lexer, struct dataset *ds, struct cmd_npar_tests *p,
152                              struct npar_specs *npar_specs );
153
154 static int
155 parse_npar_tests (struct lexer *lexer, struct dataset *ds, struct cmd_npar_tests *npt,
156                   struct npar_specs *nps)
157 {
158   npt->chisquare = 0;
159   npt->cochran = 0;
160   npt->binomial = 0;
161   npt->ks_one_sample = 0;
162   npt->wilcoxon = 0;
163   npt->sign = 0;
164   npt->runs = 0;
165   npt->friedman = 0;
166   npt->kendall = 0;
167   npt->kruskal_wallis = 0;
168   npt->mann_whitney = 0;
169   npt->mcnemar = 0;
170   npt->median = 0;
171   npt->jonckheere_terpstra = 0;
172
173   npt->miss = MISS_ANALYSIS;
174   npt->missing = 0;
175   npt->method = 0;
176   npt->statistics = 0;
177
178   memset (npt->a_statistics, 0, sizeof npt->a_statistics);
179   for (;;)
180     {
181       if (lex_match_id (lexer, "COCHRAN"))
182         {
183           npt->cochran++;
184           switch (npar_cochran (lexer, ds, nps))
185             {
186             case 0:
187               goto lossage;
188             case 1:
189               break;
190             case 2:
191               lex_error (lexer, NULL);
192               goto lossage;
193             default:
194               NOT_REACHED ();
195             }
196         }
197       else if (lex_match_id (lexer, "FRIEDMAN"))
198         {
199           npt->friedman++;
200           switch (npar_friedman (lexer, ds, nps))
201             {
202             case 0:
203               goto lossage;
204             case 1:
205               break;
206             case 2:
207               lex_error (lexer, NULL);
208               goto lossage;
209             default:
210               NOT_REACHED ();
211             }
212         }
213       else if (lex_match_id (lexer, "KENDALL"))
214         {
215           npt->kendall++;
216           switch (npar_kendall (lexer, ds, nps))
217             {
218             case 0:
219               goto lossage;
220             case 1:
221               break;
222             case 2:
223               lex_error (lexer, NULL);
224               goto lossage;
225             default:
226               NOT_REACHED ();
227             }
228         }
229       else if (lex_match_id (lexer, "RUNS"))
230         {
231           npt->runs++;
232           switch (npar_runs (lexer, ds, nps))
233             {
234             case 0:
235               goto lossage;
236             case 1:
237               break;
238             case 2:
239               lex_error (lexer, NULL);
240               goto lossage;
241             default:
242               NOT_REACHED ();
243             }
244         }
245       else if (lex_match_id (lexer, "CHISQUARE"))
246         {
247           lex_match (lexer, T_EQUALS);
248           npt->chisquare++;
249           switch (npar_chisquare (lexer, ds, nps))
250             {
251             case 0:
252               goto lossage;
253             case 1:
254               break;
255             case 2:
256               lex_error (lexer, NULL);
257               goto lossage;
258             case 3:
259               continue;
260             default:
261               NOT_REACHED ();
262             }
263         }
264       else if (lex_match_id (lexer, "BINOMIAL"))
265         {
266           lex_match (lexer, T_EQUALS);
267           npt->binomial++;
268           switch (npar_binomial (lexer, ds, nps))
269             {
270             case 0:
271               goto lossage;
272             case 1:
273               break;
274             case 2:
275               lex_error (lexer, NULL);
276               goto lossage;
277             default:
278               NOT_REACHED ();
279             }
280         }
281       else if (lex_match_phrase (lexer, "K-S") ||
282                lex_match_phrase (lexer, "KOLMOGOROV-SMIRNOV"))
283         {
284           lex_match (lexer, T_EQUALS);
285           npt->ks_one_sample++;
286           switch (npar_ks_one_sample (lexer, ds, nps))
287             {
288             case 0:
289               goto lossage;
290             case 1:
291               break;
292             case 2:
293               lex_error (lexer, NULL);
294               goto lossage;
295             default:
296               NOT_REACHED ();
297             }
298         }
299       else if (lex_match_phrase (lexer, "J-T") ||
300                lex_match_phrase (lexer, "JONCKHEERE-TERPSTRA"))
301         {
302           lex_match (lexer, T_EQUALS);
303           npt->jonckheere_terpstra++;
304           switch (npar_jonckheere_terpstra (lexer, ds, nps))
305             {
306             case 0:
307               goto lossage;
308             case 1:
309               break;
310             case 2:
311               lex_error (lexer, NULL);
312               goto lossage;
313             default:
314               NOT_REACHED ();
315             }
316         }
317       else if (lex_match_phrase (lexer, "K-W") ||
318                lex_match_phrase (lexer, "KRUSKAL-WALLIS"))
319         {
320           lex_match (lexer, T_EQUALS);
321           npt->kruskal_wallis++;
322           switch (npar_kruskal_wallis (lexer, ds, nps))
323             {
324             case 0:
325               goto lossage;
326             case 1:
327               break;
328             case 2:
329               lex_error (lexer, NULL);
330               goto lossage;
331             default:
332               NOT_REACHED ();
333             }
334         }
335       else if (lex_match_phrase (lexer, "MCNEMAR"))
336         {
337           lex_match (lexer, T_EQUALS);
338           npt->mcnemar++;
339           switch (npar_mcnemar (lexer, ds, nps))
340             {
341             case 0:
342               goto lossage;
343             case 1:
344               break;
345             case 2:
346               lex_error (lexer, NULL);
347               goto lossage;
348             default:
349               NOT_REACHED ();
350             }
351         }
352       else if (lex_match_phrase (lexer, "M-W") ||
353                lex_match_phrase (lexer, "MANN-WHITNEY"))
354         {
355           lex_match (lexer, T_EQUALS);
356           npt->mann_whitney++;
357           switch (npar_mann_whitney (lexer, ds, nps))
358             {
359             case 0:
360               goto lossage;
361             case 1:
362               break;
363             case 2:
364               lex_error (lexer, NULL);
365               goto lossage;
366             default:
367               NOT_REACHED ();
368             }
369         }
370       else if (lex_match_phrase (lexer, "MEDIAN"))
371         {
372           npt->median++;
373
374           switch (npar_median (lexer, ds, nps))
375             {
376             case 0:
377               goto lossage;
378             case 1:
379               break;
380             case 2:
381               lex_error (lexer, NULL);
382               goto lossage;
383             default:
384               NOT_REACHED ();
385             }
386         }
387       else if (lex_match_id (lexer, "WILCOXON"))
388         {
389           lex_match (lexer, T_EQUALS);
390           npt->wilcoxon++;
391           switch (npar_wilcoxon (lexer, ds, nps))
392             {
393             case 0:
394               goto lossage;
395             case 1:
396               break;
397             case 2:
398               lex_error (lexer, NULL);
399               goto lossage;
400             default:
401               NOT_REACHED ();
402             }
403         }
404       else if (lex_match_id (lexer, "SIGN"))
405         {
406           lex_match (lexer, T_EQUALS);
407           npt->sign++;
408           switch (npar_sign (lexer, ds, nps))
409             {
410             case 0:
411               goto lossage;
412             case 1:
413               break;
414             case 2:
415               lex_error (lexer, NULL);
416               goto lossage;
417             default:
418               NOT_REACHED ();
419             }
420         }
421       else if (lex_match_id (lexer, "MISSING"))
422         {
423           lex_match (lexer, T_EQUALS);
424           npt->missing++;
425           if (npt->missing > 1)
426             {
427               lex_sbc_only_once ("MISSING");
428               goto lossage;
429             }
430           while (lex_token (lexer) != T_SLASH && lex_token (lexer) != T_ENDCMD)
431             {
432               if (lex_match_id (lexer, "ANALYSIS"))
433                 npt->miss = MISS_ANALYSIS;
434               else if (lex_match_id (lexer, "LISTWISE"))
435                 npt->miss = MISS_LISTWISE;
436               else if (lex_match_id (lexer, "INCLUDE"))
437                 nps->filter = MV_SYSTEM;
438               else if (lex_match_id (lexer, "EXCLUDE"))
439                 nps->filter = MV_ANY;
440               else
441                 {
442                   lex_error (lexer, NULL);
443                   goto lossage;
444                 }
445               lex_match (lexer, T_COMMA);
446             }
447         }
448       else if (lex_match_id (lexer, "METHOD"))
449         {
450           lex_match (lexer, T_EQUALS);
451           npt->method++;
452           if (npt->method > 1)
453             {
454               lex_sbc_only_once ("METHOD");
455               goto lossage;
456             }
457           switch (npar_method (lexer, nps))
458             {
459             case 0:
460               goto lossage;
461             case 1:
462               break;
463             case 2:
464               lex_error (lexer, NULL);
465               goto lossage;
466             default:
467               NOT_REACHED ();
468             }
469         }
470       else if (lex_match_id (lexer, "STATISTICS"))
471         {
472           lex_match (lexer, T_EQUALS);
473           npt->statistics++;
474           while (lex_token (lexer) != T_SLASH && lex_token (lexer) != T_ENDCMD)
475             {
476               if (lex_match_id (lexer, "DESCRIPTIVES"))
477                 npt->a_statistics[NPAR_ST_DESCRIPTIVES] = 1;
478               else if (lex_match_id (lexer, "QUARTILES"))
479                 npt->a_statistics[NPAR_ST_QUARTILES] = 1;
480               else if (lex_match (lexer, T_ALL))
481                 npt->a_statistics[NPAR_ST_ALL] = 1;
482               else
483                 {
484                   lex_error (lexer, NULL);
485                   goto lossage;
486                 }
487               lex_match (lexer, T_COMMA);
488             }
489         }
490       else if ( settings_get_syntax () != COMPATIBLE && lex_match_id (lexer, "ALGORITHM"))
491         {
492           lex_match (lexer, T_EQUALS);
493           if (lex_match_id (lexer, "COMPATIBLE"))
494             settings_set_cmd_algorithm (COMPATIBLE);
495           else if (lex_match_id (lexer, "ENHANCED"))
496             settings_set_cmd_algorithm (ENHANCED);
497           }
498         if (!lex_match (lexer, T_SLASH))
499           break;
500       }
501
502     if (lex_token (lexer) != T_ENDCMD)
503       {
504         lex_error (lexer, _("expecting end of command"));
505         goto lossage;
506       }
507
508   return true;
509
510 lossage:
511   return false;
512 }
513
514
515 static void one_sample_insert_variables (const struct npar_test *test,
516                                          struct hmapx *);
517
518 static void two_sample_insert_variables (const struct npar_test *test,
519                                          struct hmapx *);
520
521 static void n_sample_insert_variables (const struct npar_test *test,
522                                        struct hmapx *);
523
524 static void
525 npar_execute (struct casereader *input,
526              const struct npar_specs *specs,
527              const struct dataset *ds)
528 {
529   int t;
530   struct descriptives *summary_descriptives = NULL;
531
532   for ( t = 0 ; t < specs->n_tests; ++t )
533     {
534       const struct npar_test *test = specs->test[t];
535       if ( NULL == test->execute )
536         {
537           msg (SW, _("%s subcommand not currently implemented."), "NPAR");
538           continue;
539         }
540       test->execute (ds, casereader_clone (input), specs->filter, test, specs->exact, specs->timer);
541     }
542
543   if ( specs->descriptives )
544     {
545       summary_descriptives = xnmalloc (sizeof (*summary_descriptives),
546                                        specs->n_vars);
547
548       npar_summary_calc_descriptives (summary_descriptives,
549                                       casereader_clone (input),
550                                       dataset_dict (ds),
551                                       specs->vv, specs->n_vars,
552                                       specs->filter);
553     }
554
555   if ( (specs->descriptives || specs->quartiles)
556        && !taint_has_tainted_successor (casereader_get_taint (input)) )
557     do_summary_box (summary_descriptives, specs->vv, specs->n_vars );
558
559   free (summary_descriptives);
560   casereader_destroy (input);
561 }
562
563 int
564 cmd_npar_tests (struct lexer *lexer, struct dataset *ds)
565 {
566   struct cmd_npar_tests cmd;
567   bool ok;
568   int i;
569   struct npar_specs npar_specs = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
570   struct casegrouper *grouper;
571   struct casereader *input, *group;
572   struct hmapx var_map = HMAPX_INITIALIZER (var_map);
573
574
575   npar_specs.pool = pool_create ();
576   npar_specs.filter = MV_ANY;
577   npar_specs.n_vars = -1;
578   npar_specs.vv = NULL;
579
580   if ( ! parse_npar_tests (lexer, ds, &cmd, &npar_specs) )
581     {
582       pool_destroy (npar_specs.pool);
583       return CMD_FAILURE;
584     }
585
586   for (i = 0; i < npar_specs.n_tests; ++i )
587     {
588       const struct npar_test *test = npar_specs.test[i];
589       test->insert_variables (test, &var_map);
590     }
591
592   {
593     struct hmapx_node *node;
594     struct variable *var;
595     npar_specs.n_vars = 0;
596
597     HMAPX_FOR_EACH (var, node, &var_map)
598       {
599         npar_specs.n_vars ++;
600         npar_specs.vv = pool_nrealloc (npar_specs.pool, npar_specs.vv, npar_specs.n_vars, sizeof (*npar_specs.vv));
601         npar_specs.vv[npar_specs.n_vars - 1] = var;
602       }
603   }
604
605   sort (npar_specs.vv, npar_specs.n_vars, sizeof (*npar_specs.vv), 
606          compare_var_ptrs_by_name, NULL);
607
608   if ( cmd.statistics )
609     {
610       int i;
611
612       for ( i = 0 ; i < NPAR_ST_count; ++i )
613         {
614           if ( cmd.a_statistics[i] )
615             {
616               switch ( i )
617                 {
618                 case NPAR_ST_DESCRIPTIVES:
619                   npar_specs.descriptives = true;
620                   break;
621                 case NPAR_ST_QUARTILES:
622                   npar_specs.quartiles = true;
623                   break;
624                 case NPAR_ST_ALL:
625                   npar_specs.quartiles = true;
626                   npar_specs.descriptives = true;
627                   break;
628                 default:
629                   NOT_REACHED ();
630                 };
631             }
632         }
633     }
634
635   input = proc_open (ds);
636   if ( cmd.miss == MISS_LISTWISE )
637     {
638       input = casereader_create_filter_missing (input,
639                                                 npar_specs.vv,
640                                                 npar_specs.n_vars,
641                                                 npar_specs.filter,
642                                                 NULL, NULL);
643     }
644
645
646   grouper = casegrouper_create_splits (input, dataset_dict (ds));
647   while (casegrouper_get_next_group (grouper, &group))
648     npar_execute (group, &npar_specs, ds);
649   ok = casegrouper_destroy (grouper);
650   ok = proc_commit (ds) && ok;
651
652   pool_destroy (npar_specs.pool);
653   hmapx_destroy (&var_map);
654
655   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
656 }
657
658 static int
659 npar_runs (struct lexer *lexer, struct dataset *ds,
660            struct npar_specs *specs)
661 {
662   struct runs_test *rt = pool_alloc (specs->pool, sizeof (*rt));
663   struct one_sample_test *tp = &rt->parent;
664   struct npar_test *nt = &tp->parent;
665
666   nt->execute = runs_execute;
667   nt->insert_variables = one_sample_insert_variables;
668
669   if ( lex_force_match (lexer, T_LPAREN) )
670     {
671       if ( lex_match_id (lexer, "MEAN"))
672         {
673           rt->cp_mode = CP_MEAN;
674         }
675       else if (lex_match_id (lexer, "MEDIAN"))
676         {
677           rt->cp_mode = CP_MEDIAN;
678         }
679       else if (lex_match_id (lexer, "MODE"))
680         {
681           rt->cp_mode = CP_MODE;
682         }
683       else if (lex_is_number (lexer))
684         {
685           rt->cutpoint = lex_number (lexer);
686           rt->cp_mode = CP_CUSTOM;
687           lex_get (lexer);
688         }
689       else
690         {
691           lex_error (lexer, _("Expecting %s, %s, %s or a number."), "MEAN", "MEDIAN", "MODE");
692           return 0;
693         }
694                   
695       if (! lex_force_match (lexer, T_RPAREN))
696         return 2;
697       
698       if (! lex_force_match (lexer, T_EQUALS))
699         return 2;
700       
701       if (!parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
702                                   &tp->vars, &tp->n_vars,
703                                   PV_NO_SCRATCH | PV_NO_DUPLICATE | PV_NUMERIC))
704         {
705           return 2;
706         }
707     }
708
709   specs->n_tests++;
710   specs->test = pool_realloc (specs->pool,
711                               specs->test,
712                               sizeof (*specs->test) * specs->n_tests);
713
714   specs->test[specs->n_tests - 1] = nt;
715
716   return 1;
717 }
718
719 static int
720 npar_friedman (struct lexer *lexer, struct dataset *ds,
721                struct npar_specs *specs)
722 {
723   struct friedman_test *ft = pool_alloc (specs->pool, sizeof (*ft)); 
724   struct one_sample_test *ost = &ft->parent;
725   struct npar_test *nt = &ost->parent;
726
727   ft->kendalls_w = false;
728   nt->execute = friedman_execute;
729   nt->insert_variables = one_sample_insert_variables;
730
731   lex_match (lexer, T_EQUALS);
732
733   if (!parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
734                                    &ost->vars, &ost->n_vars,
735                                    PV_NO_SCRATCH | PV_NO_DUPLICATE | PV_NUMERIC))
736     {
737       return 2;
738     }
739
740   specs->n_tests++;
741   specs->test = pool_realloc (specs->pool,
742                               specs->test,
743                               sizeof (*specs->test) * specs->n_tests);
744
745   specs->test[specs->n_tests - 1] = nt;
746
747   return 1;
748 }
749
750 static int
751 npar_kendall (struct lexer *lexer, struct dataset *ds,
752                struct npar_specs *specs)
753 {
754   struct friedman_test *kt = pool_alloc (specs->pool, sizeof (*kt)); 
755   struct one_sample_test *ost = &kt->parent;
756   struct npar_test *nt = &ost->parent;
757
758   kt->kendalls_w = true;
759   nt->execute = friedman_execute;
760   nt->insert_variables = one_sample_insert_variables;
761
762   lex_match (lexer, T_EQUALS);
763
764   if (!parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
765                                    &ost->vars, &ost->n_vars,
766                                    PV_NO_SCRATCH | PV_NO_DUPLICATE | PV_NUMERIC))
767     {
768       return 2;
769     }
770
771   specs->n_tests++;
772   specs->test = pool_realloc (specs->pool,
773                               specs->test,
774                               sizeof (*specs->test) * specs->n_tests);
775
776   specs->test[specs->n_tests - 1] = nt;
777
778   return 1;
779 }
780
781
782 static int
783 npar_cochran (struct lexer *lexer, struct dataset *ds,
784                struct npar_specs *specs)
785 {
786   struct one_sample_test *ft = pool_alloc (specs->pool, sizeof (*ft)); 
787   struct npar_test *nt = &ft->parent;
788
789   nt->execute = cochran_execute;
790   nt->insert_variables = one_sample_insert_variables;
791
792   lex_match (lexer, T_EQUALS);
793
794   if (!parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
795                                    &ft->vars, &ft->n_vars,
796                                    PV_NO_SCRATCH | PV_NO_DUPLICATE | PV_NUMERIC))
797     {
798       return 2;
799     }
800
801   specs->n_tests++;
802   specs->test = pool_realloc (specs->pool,
803                               specs->test,
804                               sizeof (*specs->test) * specs->n_tests);
805
806   specs->test[specs->n_tests - 1] = nt;
807
808   return 1;
809 }
810
811
812 static int
813 npar_chisquare (struct lexer *lexer, struct dataset *ds,
814                 struct npar_specs *specs)
815 {
816   struct chisquare_test *cstp = pool_alloc (specs->pool, sizeof (*cstp));
817   struct one_sample_test *tp = &cstp->parent;
818   struct npar_test *nt = &tp->parent;
819   int retval = 1;
820
821   nt->execute = chisquare_execute;
822   nt->insert_variables = one_sample_insert_variables;
823
824   if (!parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
825                                    &tp->vars, &tp->n_vars,
826                                    PV_NO_SCRATCH | PV_NO_DUPLICATE))
827     {
828       return 2;
829     }
830
831   cstp->ranged = false;
832
833   if ( lex_match (lexer, T_LPAREN))
834     {
835       cstp->ranged = true;
836       if ( ! lex_force_num (lexer)) return 0;
837       cstp->lo = lex_number (lexer);
838       lex_get (lexer);
839       lex_force_match (lexer, T_COMMA);
840       if (! lex_force_num (lexer) ) return 0;
841       cstp->hi = lex_number (lexer);
842       if ( cstp->lo >= cstp->hi )
843         {
844           msg (ME,
845               _("The specified value of HI (%d) is "
846                 "lower than the specified value of LO (%d)"),
847               cstp->hi, cstp->lo);
848           return 0;
849         }
850       lex_get (lexer);
851       if (! lex_force_match (lexer, T_RPAREN)) return 0;
852     }
853
854   cstp->n_expected = 0;
855   cstp->expected = NULL;
856   if (lex_match_phrase (lexer, "/EXPECTED"))
857     {
858       lex_force_match (lexer, T_EQUALS);
859       if ( ! lex_match_id (lexer, "EQUAL") )
860         {
861           double f;
862           int n;
863           while ( lex_is_number (lexer) )
864             {
865               int i;
866               n = 1;
867               f = lex_number (lexer);
868               lex_get (lexer);
869               if ( lex_match (lexer, T_ASTERISK))
870                 {
871                   n = f;
872                   if (!lex_force_num (lexer))
873                     return 0;
874                   f = lex_number (lexer);
875                   lex_get (lexer);
876                 }
877               lex_match (lexer, T_COMMA);
878
879               cstp->n_expected += n;
880               cstp->expected = pool_realloc (specs->pool,
881                                              cstp->expected,
882                                              sizeof (double) *
883                                              cstp->n_expected);
884               for ( i = cstp->n_expected - n ;
885                     i < cstp->n_expected;
886                     ++i )
887                 cstp->expected[i] = f;
888
889             }
890         }
891     }
892
893   if ( cstp->ranged && cstp->n_expected > 0 &&
894        cstp->n_expected != cstp->hi - cstp->lo + 1 )
895     {
896       msg (ME,
897           _("%d expected values were given, but the specified "
898             "range (%d-%d) requires exactly %d values."),
899           cstp->n_expected, cstp->lo, cstp->hi,
900           cstp->hi - cstp->lo +1);
901       return 0;
902     }
903
904   specs->n_tests++;
905   specs->test = pool_realloc (specs->pool,
906                               specs->test,
907                               sizeof (*specs->test) * specs->n_tests);
908
909   specs->test[specs->n_tests - 1] = nt;
910
911   return retval;
912 }
913
914
915 static int
916 npar_binomial (struct lexer *lexer, struct dataset *ds,
917                struct npar_specs *specs)
918 {
919   struct binomial_test *btp = pool_alloc (specs->pool, sizeof (*btp));
920   struct one_sample_test *tp = &btp->parent;
921   struct npar_test *nt = &tp->parent;
922   bool equals = false;
923
924   nt->execute = binomial_execute;
925   nt->insert_variables = one_sample_insert_variables;
926
927   btp->category1 = btp->category2 = btp->cutpoint = SYSMIS;
928
929   btp->p = 0.5;
930
931   if ( lex_match (lexer, T_LPAREN) )
932     {
933       equals = false;
934       if ( lex_force_num (lexer) )
935         {
936           btp->p = lex_number (lexer);
937           lex_get (lexer);
938           lex_force_match (lexer, T_RPAREN);
939         }
940       else
941         return 0;
942     }
943   else
944     equals = true;
945
946   if (equals || lex_match (lexer, T_EQUALS) )
947     {
948       if (parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
949                                       &tp->vars, &tp->n_vars,
950                                       PV_NUMERIC | PV_NO_SCRATCH | PV_NO_DUPLICATE) )
951         {
952           if (lex_match (lexer, T_LPAREN))
953             {
954               if (! lex_force_num (lexer))
955                 return 2;
956               btp->category1 = lex_number (lexer);
957               lex_get (lexer);
958               if ( lex_match (lexer, T_COMMA))
959                 {
960                   if ( ! lex_force_num (lexer) ) return 2;
961                   btp->category2 = lex_number (lexer);
962                   lex_get (lexer);
963                 }
964               else
965                 {
966                   btp->cutpoint = btp->category1;
967                 }
968
969               lex_force_match (lexer, T_RPAREN);
970             }
971         }
972       else
973         return 2;
974
975     }
976
977   specs->n_tests++;
978   specs->test = pool_realloc (specs->pool,
979                               specs->test,
980                               sizeof (*specs->test) * specs->n_tests);
981
982   specs->test[specs->n_tests - 1] = nt;
983
984   return 1;
985 }
986
987
988
989 static void
990 ks_one_sample_parse_params (struct lexer *lexer, struct ks_one_sample_test *kst, int params)
991 {
992   assert (params == 1 || params == 2);
993
994   if (lex_is_number (lexer))
995     {
996       kst->p[0] = lex_number (lexer);
997
998       lex_get (lexer);
999       if ( params == 2)
1000         {
1001           lex_match (lexer, T_COMMA);
1002           if (lex_force_num (lexer))
1003             {
1004               kst->p[1] = lex_number (lexer);
1005               lex_get (lexer);
1006             }
1007         }
1008     }
1009 }
1010
1011 static int
1012 npar_ks_one_sample (struct lexer *lexer, struct dataset *ds, struct npar_specs *specs)
1013 {
1014   struct ks_one_sample_test *kst = pool_alloc (specs->pool, sizeof (*kst));
1015   struct one_sample_test *tp = &kst->parent;
1016   struct npar_test *nt = &tp->parent;
1017
1018   nt->execute = ks_one_sample_execute;
1019   nt->insert_variables = one_sample_insert_variables;
1020
1021   kst->p[0] = kst->p[1] = SYSMIS;
1022
1023   if (! lex_force_match (lexer, T_LPAREN))
1024     return 2;
1025
1026   if (lex_match_id (lexer, "NORMAL"))
1027     {
1028       kst->dist = KS_NORMAL;
1029       ks_one_sample_parse_params (lexer, kst, 2);
1030     }
1031   else if (lex_match_id (lexer, "POISSON"))
1032     {
1033       kst->dist = KS_POISSON;
1034       ks_one_sample_parse_params (lexer, kst, 1);
1035     }
1036   else if (lex_match_id (lexer, "UNIFORM"))
1037     {
1038       kst->dist = KS_UNIFORM;
1039       ks_one_sample_parse_params (lexer, kst, 2);
1040     }
1041   else if (lex_match_id (lexer, "EXPONENTIAL"))
1042     {
1043       kst->dist = KS_EXPONENTIAL;
1044       ks_one_sample_parse_params (lexer, kst, 1);
1045     }
1046   else
1047     return 2;
1048
1049   if (! lex_force_match (lexer, T_RPAREN))
1050     return 2;
1051
1052   lex_match (lexer, T_EQUALS);
1053
1054   if (! parse_variables_const_pool (lexer, specs->pool, dataset_dict (ds),
1055                                   &tp->vars, &tp->n_vars,
1056                                   PV_NUMERIC | PV_NO_SCRATCH | PV_NO_DUPLICATE) )
1057     return 2;
1058
1059   specs->n_tests++;
1060   specs->test = pool_realloc (specs->pool,
1061                               specs->test,
1062                               sizeof (*specs->test) * specs->n_tests);
1063
1064   specs->test[specs->n_tests - 1] = nt;
1065
1066   return 1;
1067 }
1068
1069
1070 static bool
1071 parse_two_sample_related_test (struct lexer *lexer,
1072                                const struct dictionary *dict,
1073                                struct two_sample_test *test_parameters,
1074                                struct pool *pool)
1075 {
1076   int n = 0;
1077   bool paired = false;
1078   bool with = false;
1079   const struct variable **vlist1;
1080   size_t n_vlist1;
1081
1082   const struct variable **vlist2;
1083   size_t n_vlist2;
1084
1085   test_parameters->parent.insert_variables = two_sample_insert_variables;
1086
1087   if (!parse_variables_const_pool (lexer, pool,
1088                                    dict,
1089                                    &vlist1, &n_vlist1,
1090                                    PV_NUMERIC | PV_NO_SCRATCH | PV_DUPLICATE) )
1091     return false;
1092
1093   if ( lex_match (lexer, T_WITH))
1094     {
1095       with = true;
1096       if ( !parse_variables_const_pool (lexer, pool, dict,
1097                                         &vlist2, &n_vlist2,
1098                                         PV_NUMERIC | PV_NO_SCRATCH | PV_DUPLICATE) )
1099         return false;
1100
1101       paired = (lex_match (lexer, T_LPAREN) &&
1102                 lex_match_id (lexer, "PAIRED") && lex_match (lexer, T_RPAREN));
1103     }
1104
1105
1106   if ( with )
1107     {
1108       if (paired)
1109         {
1110           if ( n_vlist1 != n_vlist2)
1111             {
1112               msg (SE, _("PAIRED was specified but the number of variables "
1113                        "preceding WITH (%zu) did not match the number "
1114                        "following (%zu)."), n_vlist1, n_vlist2);
1115               return false;
1116             }
1117
1118           test_parameters->n_pairs = n_vlist1 ;
1119         }
1120       else
1121         {
1122           test_parameters->n_pairs = n_vlist1 * n_vlist2;
1123         }
1124     }
1125   else
1126     {
1127       test_parameters->n_pairs = (n_vlist1 * (n_vlist1 - 1)) / 2 ;
1128     }
1129
1130   test_parameters->pairs =
1131     pool_alloc (pool, sizeof ( variable_pair) * test_parameters->n_pairs);
1132
1133   if ( with )
1134     {
1135       if (paired)
1136         {
1137           int i;
1138           assert (n_vlist1 == n_vlist2);
1139           for ( i = 0 ; i < n_vlist1; ++i )
1140             {
1141               test_parameters->pairs[n][0] = vlist1[i];
1142               test_parameters->pairs[n][1] = vlist2[i];
1143               n++;
1144             }
1145         }
1146       else
1147         {
1148           int i,j;
1149           for ( i = 0 ; i < n_vlist1; ++i )
1150             {
1151               for ( j = 0 ; j < n_vlist2; ++j )
1152                 {
1153                   test_parameters->pairs[n][0] = vlist1[i];
1154                   test_parameters->pairs[n][1] = vlist2[j];
1155                   n++;
1156                 }
1157             }
1158         }
1159     }
1160   else
1161     {
1162       int i,j;
1163       for ( i = 0 ; i < n_vlist1 - 1; ++i )
1164         {
1165           for ( j = i + 1 ; j < n_vlist1; ++j )
1166             {
1167               assert ( n < test_parameters->n_pairs);
1168               test_parameters->pairs[n][0] = vlist1[i];
1169               test_parameters->pairs[n][1] = vlist1[j];
1170               n++;
1171             }
1172         }
1173     }
1174
1175   assert ( n == test_parameters->n_pairs);
1176
1177   return true;
1178 }
1179
1180
1181 static bool
1182 parse_n_sample_related_test (struct lexer *lexer,
1183                              const struct dictionary *dict,
1184                              struct n_sample_test *nst,
1185                              struct pool *pool
1186                              )
1187 {
1188   if (!parse_variables_const_pool (lexer, pool,
1189                                    dict,
1190                                    &nst->vars, &nst->n_vars,
1191                                    PV_NUMERIC | PV_NO_SCRATCH | PV_NO_DUPLICATE) )
1192     return false;
1193
1194   if ( ! lex_force_match (lexer, T_BY))
1195     return false;
1196
1197   nst->indep_var = parse_variable_const (lexer, dict);
1198   if (!nst->indep_var)
1199     return false;
1200
1201   if ( ! lex_force_match (lexer, T_LPAREN))
1202     return false;
1203
1204   value_init (&nst->val1, var_get_width (nst->indep_var));
1205   if ( ! parse_value (lexer, &nst->val1, nst->indep_var))
1206     {
1207       value_destroy (&nst->val1, var_get_width (nst->indep_var));
1208       return false;
1209     }
1210
1211   lex_match (lexer, T_COMMA);
1212
1213   value_init (&nst->val2, var_get_width (nst->indep_var));
1214   if ( ! parse_value (lexer, &nst->val2, nst->indep_var))
1215     {
1216       value_destroy (&nst->val2, var_get_width (nst->indep_var));
1217       return false;
1218     }
1219
1220   if ( ! lex_force_match (lexer, T_RPAREN))
1221     return false;
1222
1223   return true;
1224 }
1225
1226 static int
1227 npar_wilcoxon (struct lexer *lexer,
1228                struct dataset *ds,
1229                struct npar_specs *specs )
1230 {
1231   struct two_sample_test *tp = pool_alloc (specs->pool, sizeof (*tp));
1232   struct npar_test *nt = &tp->parent;
1233   nt->execute = wilcoxon_execute;
1234
1235   if (!parse_two_sample_related_test (lexer, dataset_dict (ds),
1236                                       tp, specs->pool) )
1237     return 0;
1238
1239   specs->n_tests++;
1240   specs->test = pool_realloc (specs->pool,
1241                               specs->test,
1242                               sizeof (*specs->test) * specs->n_tests);
1243   specs->test[specs->n_tests - 1] = nt;
1244
1245   return 1;
1246 }
1247
1248
1249 static int
1250 npar_mann_whitney (struct lexer *lexer,
1251                struct dataset *ds,
1252                struct npar_specs *specs )
1253 {
1254   struct n_sample_test *tp = pool_alloc (specs->pool, sizeof (*tp));
1255   struct npar_test *nt = &tp->parent;
1256
1257   nt->insert_variables = n_sample_insert_variables;
1258   nt->execute = mann_whitney_execute;
1259
1260   if (!parse_n_sample_related_test (lexer, dataset_dict (ds),
1261                                     tp, specs->pool) )
1262     return 0;
1263
1264   specs->n_tests++;
1265   specs->test = pool_realloc (specs->pool,
1266                               specs->test,
1267                               sizeof (*specs->test) * specs->n_tests);
1268   specs->test[specs->n_tests - 1] = nt;
1269
1270   return 1;
1271 }
1272
1273
1274 static int
1275 npar_median (struct lexer *lexer,
1276              struct dataset *ds,
1277              struct npar_specs *specs)
1278 {
1279   struct median_test *mt = pool_alloc (specs->pool, sizeof (*mt));
1280   struct n_sample_test *tp = &mt->parent;
1281   struct npar_test *nt = &tp->parent;
1282
1283   mt->median = SYSMIS;
1284
1285   if ( lex_match (lexer, T_LPAREN) && lex_force_num (lexer))
1286     {
1287       mt->median = lex_number (lexer);
1288       lex_get (lexer);
1289       lex_force_match (lexer, T_RPAREN);
1290     }
1291
1292   lex_match (lexer, T_EQUALS);
1293
1294   nt->insert_variables = n_sample_insert_variables;
1295   nt->execute = median_execute;
1296
1297   if (!parse_n_sample_related_test (lexer, dataset_dict (ds),
1298                                     tp, specs->pool) )
1299     return 0;
1300
1301   specs->n_tests++;
1302   specs->test = pool_realloc (specs->pool,
1303                               specs->test,
1304                               sizeof (*specs->test) * specs->n_tests);
1305   specs->test[specs->n_tests - 1] = nt;
1306
1307   return 1;
1308 }
1309
1310
1311 static int
1312 npar_sign (struct lexer *lexer, struct dataset *ds,
1313            struct npar_specs *specs)
1314 {
1315   struct two_sample_test *tp = pool_alloc (specs->pool, sizeof (*tp));
1316   struct npar_test *nt = &tp->parent;
1317
1318   nt->execute = sign_execute;
1319
1320   if (!parse_two_sample_related_test (lexer, dataset_dict (ds),
1321                                       tp, specs->pool) )
1322     return 0;
1323
1324   specs->n_tests++;
1325   specs->test = pool_realloc (specs->pool,
1326                               specs->test,
1327                               sizeof (*specs->test) * specs->n_tests);
1328   specs->test[specs->n_tests - 1] = nt;
1329
1330   return 1;
1331 }
1332
1333
1334 static int
1335 npar_mcnemar (struct lexer *lexer, struct dataset *ds,
1336            struct npar_specs *specs)
1337 {
1338   struct two_sample_test *tp = pool_alloc (specs->pool, sizeof (*tp));
1339   struct npar_test *nt = &tp->parent;
1340
1341   nt->execute = mcnemar_execute;
1342
1343   if (!parse_two_sample_related_test (lexer, dataset_dict (ds),
1344                                       tp, specs->pool) )
1345     return 0;
1346
1347   specs->n_tests++;
1348   specs->test = pool_realloc (specs->pool,
1349                               specs->test,
1350                               sizeof (*specs->test) * specs->n_tests);
1351   specs->test[specs->n_tests - 1] = nt;
1352
1353   return 1;
1354 }
1355
1356
1357 static int
1358 npar_jonckheere_terpstra (struct lexer *lexer, struct dataset *ds,
1359                       struct npar_specs *specs)
1360 {
1361   struct n_sample_test *tp = pool_alloc (specs->pool, sizeof (*tp));
1362   struct npar_test *nt = &tp->parent;
1363
1364   nt->insert_variables = n_sample_insert_variables;
1365
1366   nt->execute = jonckheere_terpstra_execute;
1367
1368   if (!parse_n_sample_related_test (lexer, dataset_dict (ds),
1369                                       tp, specs->pool) )
1370     return 0;
1371
1372   specs->n_tests++;
1373   specs->test = pool_realloc (specs->pool,
1374                               specs->test,
1375                               sizeof (*specs->test) * specs->n_tests);
1376   specs->test[specs->n_tests - 1] = nt;
1377
1378   return 1;
1379 }
1380
1381 static int
1382 npar_kruskal_wallis (struct lexer *lexer, struct dataset *ds,
1383                       struct npar_specs *specs)
1384 {
1385   struct n_sample_test *tp = pool_alloc (specs->pool, sizeof (*tp));
1386   struct npar_test *nt = &tp->parent;
1387
1388   nt->insert_variables = n_sample_insert_variables;
1389
1390   nt->execute = kruskal_wallis_execute;
1391
1392   if (!parse_n_sample_related_test (lexer, dataset_dict (ds),
1393                                       tp, specs->pool) )
1394     return 0;
1395
1396   specs->n_tests++;
1397   specs->test = pool_realloc (specs->pool,
1398                               specs->test,
1399                               sizeof (*specs->test) * specs->n_tests);
1400   specs->test[specs->n_tests - 1] = nt;
1401
1402   return 1;
1403 }
1404
1405 static void
1406 insert_variable_into_map (struct hmapx *var_map, const struct variable *var)
1407 {
1408   size_t hash = hash_pointer (var, 0);
1409   struct hmapx_node *node;
1410   const struct variable *v = NULL;
1411       
1412   HMAPX_FOR_EACH_WITH_HASH (v, node, hash, var_map)
1413     {
1414       if ( v == var)
1415         return ;
1416     }
1417
1418   hmapx_insert (var_map, CONST_CAST (struct variable *, var), hash);
1419 }
1420
1421 /* Insert the variables for TEST into VAR_MAP */
1422 static void
1423 one_sample_insert_variables (const struct npar_test *test,
1424                              struct hmapx *var_map)
1425 {
1426   int i;
1427   const struct one_sample_test *ost = UP_CAST (test, const struct one_sample_test, parent);
1428
1429   for ( i = 0 ; i < ost->n_vars ; ++i )
1430     insert_variable_into_map (var_map, ost->vars[i]);
1431 }
1432
1433
1434 static void
1435 two_sample_insert_variables (const struct npar_test *test,
1436                              struct hmapx *var_map)
1437 {
1438   int i;
1439   const struct two_sample_test *tst = UP_CAST (test, const struct two_sample_test, parent);
1440
1441   for ( i = 0 ; i < tst->n_pairs ; ++i )
1442     {
1443       variable_pair *pair = &tst->pairs[i];
1444
1445       insert_variable_into_map (var_map, (*pair)[0]);
1446       insert_variable_into_map (var_map, (*pair)[1]);
1447     }
1448 }
1449
1450 static void 
1451 n_sample_insert_variables (const struct npar_test *test,
1452                            struct hmapx *var_map)
1453 {
1454   int i;
1455   const struct n_sample_test *tst = UP_CAST (test, const struct n_sample_test, parent);
1456
1457   for ( i = 0 ; i < tst->n_vars ; ++i )
1458     insert_variable_into_map (var_map, tst->vars[i]);
1459
1460   insert_variable_into_map (var_map, tst->indep_var);
1461 }
1462
1463
1464 static int
1465 npar_method (struct lexer *lexer,  struct npar_specs *specs)
1466 {
1467   if ( lex_match_id (lexer, "EXACT") )
1468     {
1469       specs->exact = true;
1470       specs->timer = 0.0;
1471       if (lex_match_id (lexer, "TIMER"))
1472         {
1473           specs->timer = 5.0;
1474
1475           if ( lex_match (lexer, T_LPAREN))
1476             {
1477               if ( lex_force_num (lexer) )
1478                 {
1479                   specs->timer = lex_number (lexer);
1480                   lex_get (lexer);
1481                 }
1482               lex_force_match (lexer, T_RPAREN);
1483             }
1484         }
1485     }
1486
1487   return 1;
1488 }