dictionary: Limit split file variables to 8, for compatibility.
[pspp] / src / language / xforms / sample.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2009-2011 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 <gsl/gsl_rng.h>
20 #include <limits.h>
21 #include <stdio.h>
22 #include <math.h>
23
24 #include "data/dataset.h"
25 #include "data/variable.h"
26 #include "language/command.h"
27 #include "language/lexer/lexer.h"
28 #include "libpspp/compiler.h"
29 #include "libpspp/message.h"
30 #include "libpspp/str.h"
31 #include "math/random.h"
32
33 #include "gl/xalloc.h"
34
35 #include "gettext.h"
36 #define _(msgid) gettext (msgid)
37
38 /* The two different types of samples. */
39 enum
40   {
41     TYPE_A_FROM_B,              /* 5 FROM 10 */
42     TYPE_FRACTION               /* 0.5 */
43   };
44
45 /* SAMPLE transformation. */
46 struct sample_trns
47   {
48     int type;                   /* One of TYPE_*. */
49     int n, N;                   /* TYPE_A_FROM_B: n from N. */
50     int m, t;                   /* TYPE_A_FROM_B: # picked so far; # so far. */
51     unsigned frac;              /* TYPE_FRACTION: a fraction of UINT_MAX. */
52   };
53
54 static const struct trns_class sample_trns_class;
55
56 int
57 cmd_sample (struct lexer *lexer, struct dataset *ds)
58 {
59   struct sample_trns *trns;
60
61   int type;
62   int a, b;
63   unsigned frac;
64
65   if (!lex_force_num (lexer))
66     return CMD_FAILURE;
67   if (!lex_is_integer (lexer))
68     {
69       unsigned long min = gsl_rng_min (get_rng ());
70       unsigned long max = gsl_rng_max (get_rng ());
71
72       type = TYPE_FRACTION;
73       if (lex_tokval (lexer) <= 0 || lex_tokval (lexer) >= 1)
74         {
75           msg (SE, _("The sampling factor must be between 0 and 1 "
76                      "exclusive."));
77           return CMD_FAILURE;
78         }
79
80       frac = lex_tokval (lexer) * (max - min) + min;
81       a = b = 0;
82     }
83   else
84     {
85       type = TYPE_A_FROM_B;
86       a = lex_integer (lexer);
87       lex_get (lexer);
88       if (!lex_force_match_id (lexer, "FROM"))
89         return CMD_FAILURE;
90       if (!lex_force_int_range (lexer, "FROM", a + 1, INT_MAX))
91         return CMD_FAILURE;
92       b = lex_integer (lexer);
93       frac = 0;
94     }
95   lex_get (lexer);
96
97   trns = xmalloc (sizeof *trns);
98   trns->type = type;
99   trns->n = a;
100   trns->N = b;
101   trns->m = trns->t = 0;
102   trns->frac = frac;
103   add_transformation (ds, &sample_trns_class, trns);
104
105   return CMD_SUCCESS;
106 }
107
108 /* Executes a SAMPLE transformation. */
109 static enum trns_result
110 sample_trns_proc (void *t_, struct ccase **c UNUSED,
111                   casenumber case_num UNUSED)
112 {
113   struct sample_trns *t = t_;
114   double U;
115
116   if (t->type == TYPE_FRACTION)
117     {
118       if (gsl_rng_get (get_rng ()) <= t->frac)
119         return TRNS_CONTINUE;
120       else
121         return TRNS_DROP_CASE;
122     }
123
124   if (t->m >= t->n)
125     return TRNS_DROP_CASE;
126
127   U = gsl_rng_uniform (get_rng ());
128   if ((t->N - t->t) * U >= t->n - t->m)
129     {
130       t->t++;
131       return TRNS_DROP_CASE;
132     }
133   else
134     {
135       t->m++;
136       t->t++;
137       return TRNS_CONTINUE;
138     }
139 }
140
141 static bool
142 sample_trns_free (void *t_)
143 {
144   struct sample_trns *t = t_;
145   free (t);
146   return true;
147 }
148
149 static const struct trns_class sample_trns_class = {
150   .name = "SAMPLE",
151   .execute = sample_trns_proc,
152   .destroy = sample_trns_free,
153 };