src/dictionary.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2004 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 #ifndef DICTIONARY_H
  21 #define DICTIONARY_H
  22
  23 #include <stddef.h>
  24
  25 /* Dictionary. */
  26
  27 struct variable;
  28 struct dictionary *dict_create (void);
  29 struct dictionary *dict_clone (const struct dictionary *);
  30 void dict_clear (struct dictionary *);
  31 void dict_clear_aux (struct dictionary *);
  32 void dict_destroy (struct dictionary *);
  33
  34 size_t dict_get_var_cnt (const struct dictionary *);
  35 struct variable *dict_get_var (const struct dictionary *, size_t idx);
  36 void dict_get_vars (const struct dictionary *,
  37                     struct variable ***vars, size_t *cnt,
  38                     unsigned exclude_classes);
  39
  40 struct variable *dict_create_var (struct dictionary *, const char *,
  41                                   int width);
  42
  43 struct variable *dict_create_var_from_short (struct dictionary *d,
  44                                              const char *shortname,
  45                                              int width);
  46
  47 struct variable *dict_create_var_assert (struct dictionary *, const char *,
  48                                   int width);
  49 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
  50                                  const char *shortname, const char *longname);
  51 void dict_rename_var (struct dictionary *, struct variable *, const char *);
  52
  53 struct variable *dict_lookup_var (const struct dictionary *, const char *);
  54 struct variable *dict_lookup_var_assert (const struct dictionary *,
  55                                          const char *);
  56 int dict_contains_var (const struct dictionary *, const struct variable *);
  57 void dict_delete_var (struct dictionary *, struct variable *);
  58 void dict_delete_vars (struct dictionary *,
  59                        struct variable *const *, size_t count);
  60 void dict_reorder_vars (struct dictionary *,
  61                         struct variable *const *, size_t count);
  62 int dict_rename_vars (struct dictionary *,
  63                       struct variable **, char **new_names,
  64                       size_t count, char **err_name);
  65
  66 struct ccase;
  67 struct variable *dict_get_weight (const struct dictionary *);
  68 double dict_get_case_weight (const struct dictionary *,
  69                              const struct ccase *, int *);
  70 void dict_set_weight (struct dictionary *, struct variable *);
  71
  72 struct variable *dict_get_filter (const struct dictionary *);
  73 void dict_set_filter (struct dictionary *, struct variable *);
  74
  75 int dict_get_case_limit (const struct dictionary *);
  76 void dict_set_case_limit (struct dictionary *, int);
  77
  78 int dict_get_next_value_idx (const struct dictionary *);
  79 size_t dict_get_case_size (const struct dictionary *);
  80
  81 void dict_compact_values (struct dictionary *);
  82 void dict_compact_case (const struct dictionary *,
  83                         struct ccase *, const struct ccase *);
  84 size_t dict_get_compacted_value_cnt (const struct dictionary *);
  85 int *dict_get_compacted_idx_to_fv (const struct dictionary *);
  86
  87 struct variable *const *dict_get_split_vars (const struct dictionary *);
  88 size_t dict_get_split_cnt (const struct dictionary *);
  89 void dict_set_split_vars (struct dictionary *,
  90                           struct variable *const *, size_t cnt);
  91
  92 const char *dict_get_label (const struct dictionary *);
  93 void dict_set_label (struct dictionary *, const char *);
  94
  95 const char *dict_get_documents (const struct dictionary *);
  96 void dict_set_documents (struct dictionary *, const char *);
  97
  98 int dict_create_vector (struct dictionary *,
  99                         const char *name,
 100                         struct variable **, size_t cnt);
 101 const struct vector *dict_get_vector (const struct dictionary *,
 102                                       size_t idx);
 103 size_t dict_get_vector_cnt (const struct dictionary *);
 104 const struct vector *dict_lookup_vector (const struct dictionary *,
 105                                          const char *name);
 106 void dict_clear_vectors (struct dictionary *);
 107
 108 void dict_get_varname_block(const struct dictionary *dict, char **buf, int *size);
 109
 110 void dict_add_longvar_entry(struct dictionary *d, const char *name,
 111                             const char *longname);
 112
 113
 114
 115
 116 #endif /* dictionary.h */