src/data/dictionary.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2004 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    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, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17    02110-1301, USA. */
  18
  19 #ifndef DICTIONARY_H
  20 #define DICTIONARY_H
  21
  22 #include <stdbool.h>
  23 #include <stddef.h>
  24
  25 /* Dictionary. */
  26
  27 struct variable;
  28 struct dictionary;
  29
  30 struct dict_callbacks
  31  {
  32   void (*var_added) (struct dictionary *, int, void *);
  33   void (*var_deleted) (struct dictionary *, int, void *);
  34   void (*var_changed) (struct dictionary *, int, void *);
  35  };
  36
  37
  38 struct dictionary *dict_create (void);
  39 struct dictionary *dict_clone (const struct dictionary *);
  40 void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *,
  41                          void *);
  42
  43 void dict_clear (struct dictionary *);
  44 void dict_clear_aux (struct dictionary *);
  45 void dict_destroy (struct dictionary *);
  46
  47 size_t dict_get_var_cnt (const struct dictionary *);
  48 struct variable *dict_get_var (const struct dictionary *, size_t idx);
  49 void dict_get_vars (const struct dictionary *,
  50                     struct variable ***vars, size_t *cnt,
  51                     unsigned exclude_classes);
  52
  53 struct variable *dict_create_var (struct dictionary *, const char *,
  54                                   int width);
  55
  56 struct variable *dict_create_var_assert (struct dictionary *, const char *,
  57                                   int width);
  58 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
  59                                  const char *);
  60 struct variable *dict_clone_var_assert (struct dictionary *,
  61                                         const struct variable *, const char *);
  62
  63 struct variable *dict_lookup_var (const struct dictionary *, const char *);
  64 struct variable *dict_lookup_var_assert (const struct dictionary *,
  65                                          const char *);
  66 bool dict_contains_var (const struct dictionary *, const struct variable *);
  67 void dict_delete_var (struct dictionary *, struct variable *);
  68 void dict_delete_vars (struct dictionary *,
  69                        struct variable *const *, size_t count);
  70 void dict_delete_consecutive_vars (struct dictionary *d,
  71                                    size_t idx, size_t count);
  72 void dict_delete_scratch_vars (struct dictionary *);
  73 void dict_reorder_var (struct dictionary *d, struct variable *v,
  74                        size_t new_index);
  75 void dict_reorder_vars (struct dictionary *,
  76                         struct variable *const *, size_t count);
  77 void dict_rename_var (struct dictionary *, struct variable *, const char *);
  78 bool dict_rename_vars (struct dictionary *,
  79                        struct variable **, char **new_names,
  80                        size_t count, char **err_name);
  81
  82 struct ccase;
  83 struct variable *dict_get_weight (const struct dictionary *);
  84 double dict_get_case_weight (const struct dictionary *,
  85                              const struct ccase *, bool *);
  86 void dict_set_weight (struct dictionary *, struct variable *);
  87
  88 struct variable *dict_get_filter (const struct dictionary *);
  89 void dict_set_filter (struct dictionary *, struct variable *);
  90
  91 size_t dict_get_case_limit (const struct dictionary *);
  92 void dict_set_case_limit (struct dictionary *, size_t);
  93
  94 int dict_get_next_value_idx (const struct dictionary *);
  95 size_t dict_get_case_size (const struct dictionary *);
  96
  97 void dict_compact_values (struct dictionary *);
  98 size_t dict_get_compacted_value_cnt (const struct dictionary *);
  99 int *dict_get_compacted_dict_index_to_case_index (const struct dictionary *);
 100 bool dict_compacting_would_shrink (const struct dictionary *);
 101 bool dict_compacting_would_change (const struct dictionary *);
 102
 103 struct dict_compactor *dict_make_compactor (const struct dictionary *);
 104 void dict_compactor_compact (const struct dict_compactor *,
 105                              struct ccase *, const struct ccase *);
 106 void dict_compactor_destroy (struct dict_compactor *);
 107
 108 struct variable *const *dict_get_split_vars (const struct dictionary *);
 109 size_t dict_get_split_cnt (const struct dictionary *);
 110 void dict_set_split_vars (struct dictionary *,
 111                           struct variable *const *, size_t cnt);
 112
 113 const char *dict_get_label (const struct dictionary *);
 114 void dict_set_label (struct dictionary *, const char *);
 115
 116 const char *dict_get_documents (const struct dictionary *);
 117 void dict_set_documents (struct dictionary *, const char *);
 118
 119 bool dict_create_vector (struct dictionary *,
 120                          const char *name,
 121                          struct variable **, size_t cnt);
 122 const struct vector *dict_get_vector (const struct dictionary *,
 123                                       size_t idx);
 124 size_t dict_get_vector_cnt (const struct dictionary *);
 125 const struct vector *dict_lookup_vector (const struct dictionary *,
 126                                          const char *name);
 127 void dict_clear_vectors (struct dictionary *);
 128
 129 void dict_assign_short_names (struct dictionary *);
 130
 131 /* Called only from variable.c */
 132 void dict_var_changed (const struct variable *v);
 133
 134
 135 #endif /* dictionary.h */