1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011, 2013 Free Software Foundation, Inc.
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.
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.
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/>. */
19 #include "data/dataset.h"
26 #include "data/case.h"
27 #include "data/case-map.h"
28 #include "data/caseinit.h"
29 #include "data/casereader.h"
30 #include "data/casereader-provider.h"
31 #include "data/casereader-shim.h"
32 #include "data/casewriter.h"
33 #include "data/dictionary.h"
34 #include "data/file-handle-def.h"
35 #include "data/session.h"
36 #include "data/transformations.h"
37 #include "data/variable.h"
38 #include "libpspp/deque.h"
39 #include "libpspp/hash-functions.h"
40 #include "libpspp/hmap.h"
41 #include "libpspp/misc.h"
42 #include "libpspp/str.h"
43 #include "libpspp/taint.h"
44 #include "libpspp/i18n.h"
46 #include "gl/minmax.h"
47 #include "gl/xalloc.h"
50 /* A dataset is usually part of a session. Within a session its name must
51 unique. The name must either be a valid PSPP identifier or the empty
52 string. (It must be unique within the session even if it is the empty
53 string; that is, there may only be a single dataset within a session with
54 the empty string as its name.) */
55 struct session *session;
57 enum dataset_display display;
59 /* Cases are read from source,
60 their transformation variables are initialized,
61 pass through permanent_trns_chain (which transforms them into
62 the format described by permanent_dict),
64 pass through temporary_trns_chain (which transforms them into
65 the format described by dict),
66 and are finally passed to the procedure. */
67 struct casereader *source;
68 struct caseinit *caseinit;
69 struct trns_chain permanent_trns_chain;
70 struct dictionary *permanent_dict;
71 struct casewriter *sink;
72 struct trns_chain temporary_trns_chain;
74 struct dictionary *dict;
76 /* Stack of transformation chains for DO IF and LOOP and INPUT PROGRAM. */
77 struct trns_chain *stack;
79 size_t allocated_stack;
81 /* If true, cases are discarded instead of being written to
85 /* The case map used to compact a case, if necessary;
86 otherwise a null pointer. */
87 struct case_map *compactor;
89 /* Time at which proc was last invoked. */
90 time_t last_proc_invocation;
92 /* Cases just before ("lagging") the current one. */
93 int n_lag; /* Number of cases to lag. */
94 struct deque lag; /* Deque of lagged cases. */
95 struct ccase **lag_cases; /* Lagged cases managed by deque. */
100 PROC_COMMITTED, /* No procedure in progress. */
101 PROC_OPEN, /* proc_open called, casereader still open. */
102 PROC_CLOSED /* casereader from proc_open destroyed,
103 but proc_commit not yet called. */
106 casenumber cases_written; /* Cases output so far. */
107 bool ok; /* Error status. */
108 struct casereader_shim *shim; /* Shim on proc_open() casereader. */
110 const struct dataset_callbacks *callbacks;
113 /* Uniquely distinguishes datasets. */
117 static void dataset_changed__ (struct dataset *);
118 static void dataset_transformations_changed__ (struct dataset *,
121 static void add_measurement_level_trns (struct dataset *, struct dictionary *);
122 static void cancel_measurement_level_trns (struct trns_chain *);
123 static void add_case_limit_trns (struct dataset *ds);
124 static void add_filter_trns (struct dataset *ds);
126 static void update_last_proc_invocation (struct dataset *ds);
129 dict_callback (struct dictionary *d UNUSED, void *ds_)
131 struct dataset *ds = ds_;
132 dataset_changed__ (ds);
136 dataset_create_finish__ (struct dataset *ds, struct session *session)
138 static unsigned int seqno;
140 dict_set_change_callback (ds->dict, dict_callback, ds);
141 proc_cancel_all_transformations (ds);
142 dataset_set_session (ds, session);
146 /* Creates a new dataset named NAME, adds it to SESSION, and returns it. If
147 SESSION already contains a dataset named NAME, it is deleted and replaced.
148 The dataset initially has an empty dictionary and no data source. */
150 dataset_create (struct session *session, const char *name)
152 struct dataset *ds = XMALLOC (struct dataset);
153 *ds = (struct dataset) {
154 .name = xstrdup (name),
155 .display = DATASET_FRONT,
156 .dict = dict_create (get_default_encoding ()),
157 .caseinit = caseinit_create (),
159 dataset_create_finish__ (ds, session);
164 /* Creates and returns a new dataset that has the same data and dictionary as
165 OLD named NAME, adds it to the same session as OLD, and returns the new
166 dataset. If SESSION already contains a dataset named NAME, it is deleted
169 OLD must not have any active transformations or temporary state and must
170 not be in the middle of a procedure.
172 Callbacks are not cloned. */
174 dataset_clone (struct dataset *old, const char *name)
178 assert (old->proc_state == PROC_COMMITTED);
179 assert (!old->permanent_trns_chain.n);
180 assert (old->permanent_dict == NULL);
181 assert (old->sink == NULL);
182 assert (!old->temporary);
183 assert (!old->temporary_trns_chain.n);
184 assert (!old->n_stack);
186 new = xzalloc (sizeof *new);
187 new->name = xstrdup (name);
188 new->display = DATASET_FRONT;
189 new->source = casereader_clone (old->source);
190 new->dict = dict_clone (old->dict);
191 new->caseinit = caseinit_clone (old->caseinit);
192 new->last_proc_invocation = old->last_proc_invocation;
195 dataset_create_finish__ (new, old->session);
202 dataset_destroy (struct dataset *ds)
206 dataset_set_session (ds, NULL);
208 dict_unref (ds->dict);
209 dict_unref (ds->permanent_dict);
210 caseinit_destroy (ds->caseinit);
211 trns_chain_uninit (&ds->permanent_trns_chain);
212 for (size_t i = 0; i < ds->n_stack; i++)
213 trns_chain_uninit (&ds->stack[i]);
215 dataset_transformations_changed__ (ds, false);
221 /* Discards the active dataset's dictionary, data, and transformations. */
223 dataset_clear (struct dataset *ds)
225 assert (ds->proc_state == PROC_COMMITTED);
227 dict_clear (ds->dict);
228 fh_set_default_handle (NULL);
232 casereader_destroy (ds->source);
235 proc_cancel_all_transformations (ds);
239 dataset_name (const struct dataset *ds)
245 dataset_set_name (struct dataset *ds, const char *name)
247 struct session *session = ds->session;
252 active = session_active_dataset (session) == ds;
254 session_set_active_dataset (session, NULL);
255 dataset_set_session (ds, NULL);
259 ds->name = xstrdup (name);
263 dataset_set_session (ds, session);
265 session_set_active_dataset (session, ds);
270 dataset_session (const struct dataset *ds)
276 dataset_set_session (struct dataset *ds, struct session *session)
278 if (session != ds->session)
280 if (ds->session != NULL)
281 session_remove_dataset (ds->session, ds);
283 session_add_dataset (session, ds);
287 /* Returns the dictionary within DS. This is always nonnull, although it
288 might not contain any variables. */
290 dataset_dict (const struct dataset *ds)
295 /* Replaces DS's dictionary by DICT, discarding any source and
298 dataset_set_dict (struct dataset *ds, struct dictionary *dict)
300 assert (ds->proc_state == PROC_COMMITTED);
301 assert (ds->dict != dict);
305 dict_unref (ds->dict);
307 dict_set_change_callback (ds->dict, dict_callback, ds);
310 /* Returns the casereader that will be read when a procedure is executed on
311 DS. This can be NULL if none has been set up yet. */
312 const struct casereader *
313 dataset_source (const struct dataset *ds)
318 /* Returns true if DS has a data source, false otherwise. */
320 dataset_has_source (const struct dataset *ds)
322 return dataset_source (ds) != NULL;
325 /* Replaces the active dataset's data by READER. READER's cases must have an
326 appropriate format for DS's dictionary. */
328 dataset_set_source (struct dataset *ds, struct casereader *reader)
330 casereader_destroy (ds->source);
333 caseinit_clear (ds->caseinit);
334 caseinit_mark_as_preinited (ds->caseinit, ds->dict);
336 return reader == NULL || !casereader_error (reader);
339 /* Returns the data source from DS and removes it from DS. Returns a null
340 pointer if DS has no data source. */
342 dataset_steal_source (struct dataset *ds)
344 struct casereader *reader = ds->source;
351 dataset_delete_vars (struct dataset *ds, struct variable **vars, size_t n)
353 assert (!proc_in_temporary_transformations (ds));
354 assert (!proc_has_transformations (ds));
355 assert (n < dict_get_n_vars (ds->dict));
357 dict_delete_vars (ds->dict, vars, n);
358 ds->source = case_map_create_input_translator (
359 case_map_to_compact_dict (ds->dict, 0), ds->source);
360 dict_compact_values (ds->dict);
361 caseinit_clear (ds->caseinit);
362 caseinit_mark_as_preinited (ds->caseinit, ds->dict);
365 /* Returns a number unique to DS. It can be used to distinguish one dataset
366 from any other within a given program run, even datasets that do not exist
369 dataset_seqno (const struct dataset *ds)
375 dataset_set_callbacks (struct dataset *ds,
376 const struct dataset_callbacks *callbacks,
379 ds->callbacks = callbacks;
380 ds->cb_data = cb_data;
384 dataset_get_display (const struct dataset *ds)
390 dataset_set_display (struct dataset *ds, enum dataset_display display)
392 ds->display = display;
395 /* Returns the last time the data was read. */
397 time_of_last_procedure (struct dataset *ds)
401 if (ds->last_proc_invocation == 0)
402 update_last_proc_invocation (ds);
403 return ds->last_proc_invocation;
406 /* Regular procedure. */
408 /* Executes any pending transformations, if necessary.
409 This is not identical to the EXECUTE command in that it won't
410 always read the source data. This can be important when the
411 source data is given inline within BEGIN DATA...END FILE. */
413 proc_execute (struct dataset *ds)
417 if ((!ds->temporary || !ds->temporary_trns_chain.n)
418 && !ds->permanent_trns_chain.n)
421 ds->discard_output = false;
422 dict_set_case_limit (ds->dict, 0);
423 dict_clear_vectors (ds->dict);
427 ok = casereader_destroy (proc_open (ds));
428 return proc_commit (ds) && ok;
431 static const struct casereader_class proc_casereader_class;
433 /* Opens dataset DS for reading cases with proc_read. If FILTER is true, then
434 cases filtered out with FILTER BY will not be included in the casereader
435 (which is usually desirable). If FILTER is false, all cases will be
436 included regardless of FILTER BY settings.
438 proc_commit must be called when done. */
440 proc_open_filtering (struct dataset *ds, bool filter)
442 struct casereader *reader;
444 assert (ds->n_stack == 0);
445 assert (ds->source != NULL);
446 assert (ds->proc_state == PROC_COMMITTED);
448 update_last_proc_invocation (ds);
450 caseinit_mark_for_init (ds->caseinit, ds->dict);
451 ds->source = caseinit_translate_casereader_to_init_vars (
452 ds->caseinit, dict_get_proto (ds->dict), ds->source);
454 /* Finish up the collection of transformations. */
455 add_case_limit_trns (ds);
457 add_filter_trns (ds);
458 if (!proc_in_temporary_transformations (ds))
459 add_measurement_level_trns (ds, ds->dict);
461 /* Make permanent_dict refer to the dictionary right before
462 data reaches the sink. */
463 if (ds->permanent_dict == NULL)
464 ds->permanent_dict = ds->dict;
467 if (!ds->discard_output)
469 struct dictionary *pd = ds->permanent_dict;
470 size_t compacted_n_values = dict_count_values (pd, DC_SCRATCH);
471 if (compacted_n_values < dict_get_next_value_idx (pd))
473 struct caseproto *compacted_proto;
474 compacted_proto = dict_get_compacted_proto (pd, DC_SCRATCH);
475 ds->compactor = case_map_to_compact_dict (pd, DC_SCRATCH);
476 ds->sink = autopaging_writer_create (compacted_proto);
477 caseproto_unref (compacted_proto);
481 ds->compactor = NULL;
482 ds->sink = autopaging_writer_create (dict_get_proto (pd));
487 ds->compactor = NULL;
491 /* Allocate memory for lagged cases. */
492 ds->lag_cases = deque_init (&ds->lag, ds->n_lag, sizeof *ds->lag_cases);
494 ds->proc_state = PROC_OPEN;
495 ds->cases_written = 0;
498 /* FIXME: use taint in dataset in place of `ok'? */
499 /* FIXME: for trivial cases we can just return a clone of
502 /* Create casereader and insert a shim on top. The shim allows us to
503 arbitrarily extend the casereader's lifetime, by slurping the cases into
504 the shim's buffer in proc_commit(). That is especially useful when output
505 table_items are generated directly from the procedure casereader (e.g. by
506 the LIST procedure) when we are using an output driver that keeps a
507 reference to the output items passed to it (e.g. the GUI output driver in
509 reader = casereader_create_sequential (NULL, dict_get_proto (ds->dict),
511 &proc_casereader_class, ds);
512 ds->shim = casereader_shim_insert (reader);
516 /* Opens dataset DS for reading cases with proc_read.
517 proc_commit must be called when done. */
519 proc_open (struct dataset *ds)
521 return proc_open_filtering (ds, true);
524 /* Returns true if a procedure is in progress, that is, if
525 proc_open has been called but proc_commit has not. */
527 proc_is_open (const struct dataset *ds)
529 return ds->proc_state != PROC_COMMITTED;
532 /* "read" function for procedure casereader. */
533 static struct ccase *
534 proc_casereader_read (struct casereader *reader UNUSED, void *ds_)
536 struct dataset *ds = ds_;
537 enum trns_result retval = TRNS_DROP_CASE;
540 assert (ds->proc_state == PROC_OPEN);
541 for (; ; case_unref (c))
543 assert (retval == TRNS_DROP_CASE || retval == TRNS_ERROR);
544 if (retval == TRNS_ERROR)
549 /* Read a case from source. */
550 c = casereader_read (ds->source);
553 c = case_unshare_and_resize (c, dict_get_proto (ds->dict));
554 caseinit_restore_left_vars (ds->caseinit, c);
556 /* Execute permanent transformations. */
557 casenumber case_nr = ds->cases_written + 1;
558 retval = trns_chain_execute (&ds->permanent_trns_chain, case_nr, &c);
559 caseinit_save_left_vars (ds->caseinit, c);
560 if (retval != TRNS_CONTINUE)
563 /* Write case to collection of lagged cases. */
566 while (deque_count (&ds->lag) >= ds->n_lag)
567 case_unref (ds->lag_cases[deque_pop_back (&ds->lag)]);
568 ds->lag_cases[deque_push_front (&ds->lag)] = case_ref (c);
571 /* Write case to replacement dataset. */
573 if (ds->sink != NULL)
574 casewriter_write (ds->sink,
575 case_map_execute (ds->compactor, case_ref (c)));
577 /* Execute temporary transformations. */
578 if (ds->temporary_trns_chain.n)
580 retval = trns_chain_execute (&ds->temporary_trns_chain,
581 ds->cases_written, &c);
582 if (retval != TRNS_CONTINUE)
590 /* "destroy" function for procedure casereader. */
592 proc_casereader_destroy (struct casereader *reader, void *ds_)
594 struct dataset *ds = ds_;
597 /* We are always the subreader for a casereader_buffer, so if we're being
598 destroyed then it's because the casereader_buffer has read all the cases
599 that it ever will. */
602 /* Make sure transformations happen for every input case, in
603 case they have side effects, and ensure that the replacement
604 active dataset gets all the cases it should. */
605 while ((c = casereader_read (reader)) != NULL)
608 ds->proc_state = PROC_CLOSED;
609 ds->ok = casereader_destroy (ds->source) && ds->ok;
611 dataset_set_source (ds, NULL);
614 /* Must return false if the source casereader, a transformation,
615 or the sink casewriter signaled an error. (If a temporary
616 transformation signals an error, then the return value is
617 false, but the replacement active dataset may still be
620 proc_commit (struct dataset *ds)
622 if (ds->shim != NULL)
623 casereader_shim_slurp (ds->shim);
625 assert (ds->proc_state == PROC_CLOSED);
626 ds->proc_state = PROC_COMMITTED;
628 dataset_changed__ (ds);
630 /* Free memory for lagged cases. */
631 while (!deque_is_empty (&ds->lag))
632 case_unref (ds->lag_cases[deque_pop_back (&ds->lag)]);
633 free (ds->lag_cases);
635 /* Dictionary from before TEMPORARY becomes permanent. */
636 proc_cancel_temporary_transformations (ds);
637 bool ok = proc_cancel_all_transformations (ds) && ds->ok;
639 if (!ds->discard_output)
641 /* Finish compacting. */
642 if (ds->compactor != NULL)
644 case_map_destroy (ds->compactor);
645 ds->compactor = NULL;
647 dict_delete_scratch_vars (ds->dict);
648 dict_compact_values (ds->dict);
651 /* Old data sink becomes new data source. */
652 if (ds->sink != NULL)
653 ds->source = casewriter_make_reader (ds->sink);
658 ds->discard_output = false;
662 caseinit_clear (ds->caseinit);
663 caseinit_mark_as_preinited (ds->caseinit, ds->dict);
665 dict_clear_vectors (ds->dict);
666 ds->permanent_dict = NULL;
670 /* Casereader class for procedure execution. */
671 static const struct casereader_class proc_casereader_class =
673 proc_casereader_read,
674 proc_casereader_destroy,
679 /* Updates last_proc_invocation. */
681 update_last_proc_invocation (struct dataset *ds)
683 ds->last_proc_invocation = time (NULL);
686 /* Returns a pointer to the lagged case from N_BEFORE cases before the
687 current one, or NULL if there haven't been that many cases yet. */
689 lagged_case (const struct dataset *ds, int n_before)
691 assert (n_before >= 1);
692 assert (n_before <= ds->n_lag);
694 if (n_before <= deque_count (&ds->lag))
695 return ds->lag_cases[deque_front (&ds->lag, n_before - 1)];
700 /* Adds TRNS to the current set of transformations. */
702 add_transformation (struct dataset *ds,
703 const struct trns_class *class, void *aux)
705 struct trns_chain *chain = (ds->n_stack > 0 ? &ds->stack[ds->n_stack - 1]
706 : ds->temporary ? &ds->temporary_trns_chain
707 : &ds->permanent_trns_chain);
708 struct transformation t = { .class = class, .aux = aux };
709 trns_chain_append (chain, &t);
710 dataset_transformations_changed__ (ds, true);
713 /* Returns true if the next call to add_transformation() will add
714 a temporary transformation, false if it will add a permanent
717 proc_in_temporary_transformations (const struct dataset *ds)
719 return ds->temporary;
722 /* Marks the start of temporary transformations.
723 Further calls to add_transformation() will add temporary
726 proc_start_temporary_transformations (struct dataset *ds)
728 assert (!ds->n_stack);
729 if (!proc_in_temporary_transformations (ds))
731 add_case_limit_trns (ds);
733 ds->permanent_dict = dict_clone (ds->dict);
734 add_measurement_level_trns (ds, ds->permanent_dict);
736 ds->temporary = true;
737 dataset_transformations_changed__ (ds, true);
741 /* Converts all the temporary transformations, if any, to permanent
742 transformations. Further transformations will be permanent.
744 The FILTER command is implemented as a temporary transformation, so a
745 procedure that uses this function should usually use proc_open_filtering()
746 with FILTER false, instead of plain proc_open().
748 Returns true if anything changed, false otherwise. */
750 proc_make_temporary_transformations_permanent (struct dataset *ds)
752 if (proc_in_temporary_transformations (ds))
754 cancel_measurement_level_trns (&ds->permanent_trns_chain);
755 trns_chain_splice (&ds->permanent_trns_chain, &ds->temporary_trns_chain);
757 ds->temporary = false;
759 dict_unref (ds->permanent_dict);
760 ds->permanent_dict = NULL;
768 /* Cancels all temporary transformations, if any. Further
769 transformations will be permanent.
770 Returns true if anything changed, false otherwise. */
772 proc_cancel_temporary_transformations (struct dataset *ds)
774 if (proc_in_temporary_transformations (ds))
776 trns_chain_clear (&ds->temporary_trns_chain);
778 dict_unref (ds->dict);
779 ds->dict = ds->permanent_dict;
780 ds->permanent_dict = NULL;
782 dataset_transformations_changed__ (ds, ds->permanent_trns_chain.n != 0);
789 /* Cancels all transformations, if any.
790 Returns true if successful, false on I/O error. */
792 proc_cancel_all_transformations (struct dataset *ds)
795 assert (ds->proc_state == PROC_COMMITTED);
796 ok = trns_chain_clear (&ds->permanent_trns_chain);
797 ok = trns_chain_clear (&ds->temporary_trns_chain) && ok;
798 ds->temporary = false;
799 for (size_t i = 0; i < ds->n_stack; i++)
800 ok = trns_chain_uninit (&ds->stack[i]) && ok;
802 dataset_transformations_changed__ (ds, false);
808 proc_push_transformations (struct dataset *ds)
810 if (ds->n_stack >= ds->allocated_stack)
811 ds->stack = x2nrealloc (ds->stack, &ds->allocated_stack,
813 trns_chain_init (&ds->stack[ds->n_stack++]);
817 proc_pop_transformations (struct dataset *ds, struct trns_chain *chain)
819 assert (ds->n_stack > 0);
820 *chain = ds->stack[--ds->n_stack];
824 proc_has_transformations (const struct dataset *ds)
826 return ds->permanent_trns_chain.n || ds->temporary_trns_chain.n;
829 static enum trns_result
830 store_case_num (void *var_, struct ccase **cc, casenumber case_num)
832 struct variable *var = var_;
834 *cc = case_unshare (*cc);
835 *case_num_rw (*cc, var) = case_num;
837 return TRNS_CONTINUE;
840 /* Add a variable which we can sort by to get back the original order. */
842 add_permanent_ordering_transformation (struct dataset *ds)
844 struct variable *temp_var = dict_create_var_assert (ds->dict, "$ORDER", 0);
845 struct variable *order_var
846 = (proc_in_temporary_transformations (ds)
847 ? dict_clone_var_in_place_assert (ds->permanent_dict, temp_var)
850 static const struct trns_class trns_class = {
852 .execute = store_case_num
854 const struct transformation t = { .class = &trns_class, .aux = order_var };
855 trns_chain_append (&ds->permanent_trns_chain, &t);
860 /* Causes output from the next procedure to be discarded, instead
861 of being preserved for use as input for the next procedure. */
863 proc_discard_output (struct dataset *ds)
865 ds->discard_output = true;
869 /* Checks whether DS has a corrupted active dataset. If so,
870 discards it and returns false. If not, returns true without
873 dataset_end_of_command (struct dataset *ds)
875 if (ds->source != NULL)
877 if (casereader_error (ds->source))
884 const struct taint *taint = casereader_get_taint (ds->source);
885 taint_reset_successor_taint (CONST_CAST (struct taint *, taint));
886 assert (!taint_has_tainted_successor (taint));
892 /* Limits the maximum number of cases processed to
894 static enum trns_result
895 case_limit_trns_proc (void *cases_remaining_,
896 struct ccase **c UNUSED, casenumber case_nr UNUSED)
898 size_t *cases_remaining = cases_remaining_;
899 if (*cases_remaining > 0)
901 (*cases_remaining)--;
902 return TRNS_CONTINUE;
905 return TRNS_DROP_CASE;
908 /* Frees the data associated with a case limit transformation. */
910 case_limit_trns_free (void *cases_remaining_)
912 size_t *cases_remaining = cases_remaining_;
913 free (cases_remaining);
917 /* Adds a transformation that limits the number of cases that may
918 pass through, if DS->DICT has a case limit. */
920 add_case_limit_trns (struct dataset *ds)
922 casenumber case_limit = dict_get_case_limit (ds->dict);
925 casenumber *cases_remaining = xmalloc (sizeof *cases_remaining);
926 *cases_remaining = case_limit;
928 static const struct trns_class trns_class = {
929 .name = "case limit",
930 .execute = case_limit_trns_proc,
931 .destroy = case_limit_trns_free,
933 add_transformation (ds, &trns_class, cases_remaining);
935 dict_set_case_limit (ds->dict, 0);
940 /* FILTER transformation. */
941 static enum trns_result
942 filter_trns_proc (void *filter_var_,
943 struct ccase **c, casenumber case_nr UNUSED)
946 struct variable *filter_var = filter_var_;
947 double f = case_num (*c, filter_var);
948 return (f != 0.0 && !var_is_num_missing (filter_var, f)
949 ? TRNS_CONTINUE : TRNS_DROP_CASE);
952 /* Adds a temporary transformation to filter data according to
953 the variable specified on FILTER, if any. */
955 add_filter_trns (struct dataset *ds)
957 struct variable *filter_var = dict_get_filter (ds->dict);
958 if (filter_var != NULL)
960 proc_start_temporary_transformations (ds);
962 static const struct trns_class trns_class = {
964 .execute = filter_trns_proc,
966 add_transformation (ds, &trns_class, filter_var);
971 dataset_need_lag (struct dataset *ds, int n_before)
973 ds->n_lag = MAX (ds->n_lag, n_before);
976 /* Measurement guesser, for guessing a measurement level from formats and
981 struct hmap_node hmap_node;
987 struct variable *var;
992 mg_var_uninit (struct mg_var *mgv)
994 struct mg_value *mgvalue, *next;
995 HMAP_FOR_EACH_SAFE (mgvalue, next, struct mg_value, hmap_node,
998 hmap_delete (mgv->values, &mgvalue->hmap_node);
1001 hmap_destroy (mgv->values);
1006 mg_var_interpret (const struct mg_var *mgv)
1008 size_t n = hmap_count (mgv->values);
1011 /* All missing (or no data). */
1012 return MEASURE_NOMINAL;
1015 const struct mg_value *mgvalue;
1016 HMAP_FOR_EACH (mgvalue, struct mg_value, hmap_node,
1018 if (mgvalue->value < 10)
1019 return MEASURE_NOMINAL;
1020 return MEASURE_SCALE;
1024 mg_var_add_value (struct mg_var *mgv, double value)
1026 if (var_is_num_missing (mgv->var, value))
1027 return MEASURE_UNKNOWN;
1028 else if (value < 0 || value != floor (value))
1029 return MEASURE_SCALE;
1031 size_t hash = hash_double (value, 0);
1032 struct mg_value *mgvalue;
1033 HMAP_FOR_EACH_WITH_HASH (mgvalue, struct mg_value, hmap_node,
1035 if (mgvalue->value == value)
1036 return MEASURE_UNKNOWN;
1038 mgvalue = xmalloc (sizeof *mgvalue);
1039 mgvalue->value = value;
1040 hmap_insert (mgv->values, &mgvalue->hmap_node, hash);
1041 if (hmap_count (mgv->values) >= settings_get_scalemin ())
1042 return MEASURE_SCALE;
1044 return MEASURE_UNKNOWN;
1047 struct measure_guesser
1049 struct mg_var *vars;
1053 static struct measure_guesser *
1054 measure_guesser_create__ (struct dictionary *dict)
1056 struct mg_var *mgvs = NULL;
1058 size_t allocated_mgvs = 0;
1060 for (size_t i = 0; i < dict_get_n_vars (dict); i++)
1062 struct variable *var = dict_get_var (dict, i);
1063 if (var_get_measure (var) != MEASURE_UNKNOWN)
1066 struct fmt_spec f = var_get_print_format (var);
1067 enum measure m = var_default_measure_for_format (f.type);
1068 if (m != MEASURE_UNKNOWN)
1070 var_set_measure (var, m);
1074 if (n_mgvs >= allocated_mgvs)
1075 mgvs = x2nrealloc (mgvs, &allocated_mgvs, sizeof *mgvs);
1077 struct mg_var *mgv = &mgvs[n_mgvs++];
1078 *mgv = (struct mg_var) {
1080 .values = xmalloc (sizeof *mgv->values),
1082 hmap_init (mgv->values);
1087 struct measure_guesser *mg = xmalloc (sizeof *mg);
1088 *mg = (struct measure_guesser) {
1095 /* Scans through DS's dictionary for variables that have an unknown measurement
1096 level. For those, if the measurement level can be guessed based on the
1097 variable's type and format, sets a default. If that's enough, returns NULL.
1098 If any remain whose levels are unknown and can't be guessed that way,
1099 creates and returns a structure that the caller should pass to
1100 measure_guesser_add_case() or measure_guesser_run() for guessing a
1101 measurement level based on the data. */
1102 struct measure_guesser *
1103 measure_guesser_create (struct dataset *ds)
1105 return measure_guesser_create__ (dataset_dict (ds));
1108 /* Adds data from case C to MG. */
1110 measure_guesser_add_case (struct measure_guesser *mg, const struct ccase *c)
1112 for (size_t i = 0; i < mg->n_vars; )
1114 struct mg_var *mgv = &mg->vars[i];
1115 double value = case_num (c, mgv->var);
1116 enum measure m = mg_var_add_value (mgv, value);
1117 if (m != MEASURE_UNKNOWN)
1119 var_set_measure (mgv->var, m);
1121 mg_var_uninit (mgv);
1122 *mgv = mg->vars[--mg->n_vars];
1131 measure_guesser_destroy (struct measure_guesser *mg)
1136 for (size_t i = 0; i < mg->n_vars; i++)
1138 struct mg_var *mgv = &mg->vars[i];
1139 var_set_measure (mgv->var, mg_var_interpret (mgv));
1140 mg_var_uninit (mgv);
1146 /* Adds final measurement levels based on MG, after all the cases have been
1149 measure_guesser_commit (struct measure_guesser *mg)
1151 for (size_t i = 0; i < mg->n_vars; i++)
1153 struct mg_var *mgv = &mg->vars[i];
1154 var_set_measure (mgv->var, mg_var_interpret (mgv));
1158 /* Passes the cases in READER through MG and uses the data in the cases to set
1159 measurement levels for the variables where they were still unknown. */
1161 measure_guesser_run (struct measure_guesser *mg,
1162 const struct casereader *reader)
1164 struct casereader *r = casereader_clone (reader);
1165 while (mg->n_vars > 0)
1167 struct ccase *c = casereader_read (r);
1170 measure_guesser_add_case (mg, c);
1173 casereader_destroy (r);
1175 measure_guesser_commit (mg);
1178 /* A transformation for guessing measurement levels. */
1180 static enum trns_result
1181 mg_trns_proc (void *mg_, struct ccase **c, casenumber case_nr UNUSED)
1183 struct measure_guesser *mg = mg_;
1184 measure_guesser_add_case (mg, *c);
1185 return TRNS_CONTINUE;
1189 mg_trns_free (void *mg_)
1191 struct measure_guesser *mg = mg_;
1192 measure_guesser_commit (mg);
1193 measure_guesser_destroy (mg);
1197 static const struct trns_class mg_trns_class = {
1198 .name = "add measurement level",
1199 .execute = mg_trns_proc,
1200 .destroy = mg_trns_free,
1204 add_measurement_level_trns (struct dataset *ds, struct dictionary *dict)
1206 struct measure_guesser *mg = measure_guesser_create__ (dict);
1208 add_transformation (ds, &mg_trns_class, mg);
1212 cancel_measurement_level_trns (struct trns_chain *chain)
1217 struct transformation *trns = &chain->xforms[chain->n - 1];
1218 if (trns->class != &mg_trns_class)
1221 struct measure_guesser *mg = trns->aux;
1222 measure_guesser_destroy (mg);
1227 dataset_changed__ (struct dataset *ds)
1229 if (ds->callbacks != NULL && ds->callbacks->changed != NULL)
1230 ds->callbacks->changed (ds->cb_data);
1234 dataset_transformations_changed__ (struct dataset *ds, bool non_empty)
1236 if (ds->callbacks != NULL && ds->callbacks->transformations_changed != NULL)
1237 ds->callbacks->transformations_changed (non_empty, ds->cb_data);
1240 /* Private interface for use by session code. */
1243 dataset_set_session__ (struct dataset *ds, struct session *session)
1245 ds->session = session;