1 /* PSPP - computes sample statistics.
2 Copyright (C) 2004, 2007 Free Software Foundation, Inc.
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.
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.
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
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 void (*weight_changed) (struct dictionary *, int, void *);
36 void (*filter_changed) (struct dictionary *, int, void *);
37 void (*split_changed) (struct dictionary *, void *);
41 struct dictionary *dict_create (void);
42 struct dictionary *dict_clone (const struct dictionary *);
43 void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *,
45 void dict_copy_callbacks (struct dictionary *, const struct dictionary *);
48 void dict_clear (struct dictionary *);
49 void dict_clear_aux (struct dictionary *);
50 void dict_destroy (struct dictionary *);
52 size_t dict_get_var_cnt (const struct dictionary *);
53 struct variable *dict_get_var (const struct dictionary *, size_t idx);
54 inline void dict_get_vars (const struct dictionary *,
55 const struct variable ***vars, size_t *cnt,
56 unsigned exclude_classes);
57 void dict_get_vars_mutable (const struct dictionary *,
58 struct variable ***vars, size_t *cnt,
59 unsigned exclude_classes);
61 struct variable *dict_create_var (struct dictionary *, const char *,
64 struct variable *dict_create_var_assert (struct dictionary *, const char *,
66 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
68 struct variable *dict_clone_var_assert (struct dictionary *,
69 const struct variable *, const char *);
71 struct variable *dict_lookup_var (const struct dictionary *, const char *);
72 struct variable *dict_lookup_var_assert (const struct dictionary *,
74 bool dict_contains_var (const struct dictionary *, const struct variable *);
75 void dict_delete_var (struct dictionary *, struct variable *);
76 void dict_delete_vars (struct dictionary *,
77 struct variable *const *, size_t count);
78 void dict_delete_consecutive_vars (struct dictionary *d,
79 size_t idx, size_t count);
80 void dict_delete_scratch_vars (struct dictionary *);
81 void dict_reorder_var (struct dictionary *d, struct variable *v,
83 void dict_reorder_vars (struct dictionary *,
84 struct variable *const *, size_t count);
85 void dict_rename_var (struct dictionary *, struct variable *, const char *);
86 bool dict_rename_vars (struct dictionary *,
87 struct variable **, char **new_names,
88 size_t count, char **err_name);
91 struct variable *dict_get_weight (const struct dictionary *);
92 double dict_get_case_weight (const struct dictionary *,
93 const struct ccase *, bool *);
94 void dict_set_weight (struct dictionary *, struct variable *);
96 struct variable *dict_get_filter (const struct dictionary *);
97 void dict_set_filter (struct dictionary *, struct variable *);
99 size_t dict_get_case_limit (const struct dictionary *);
100 void dict_set_case_limit (struct dictionary *, size_t);
102 int dict_get_next_value_idx (const struct dictionary *);
103 size_t dict_get_case_size (const struct dictionary *);
105 void dict_compact_values (struct dictionary *);
106 size_t dict_get_compacted_value_cnt (const struct dictionary *);
107 int *dict_get_compacted_dict_index_to_case_index (const struct dictionary *);
108 bool dict_compacting_would_shrink (const struct dictionary *);
109 bool dict_compacting_would_change (const struct dictionary *);
111 struct dict_compactor *dict_make_compactor (const struct dictionary *);
112 void dict_compactor_compact (const struct dict_compactor *,
113 struct ccase *, const struct ccase *);
114 void dict_compactor_destroy (struct dict_compactor *);
116 const struct variable *const *dict_get_split_vars (const struct dictionary *);
117 size_t dict_get_split_cnt (const struct dictionary *);
118 void dict_set_split_vars (struct dictionary *,
119 struct variable *const *, size_t cnt);
120 void dict_unset_split_var (struct dictionary *d,
123 const char *dict_get_label (const struct dictionary *);
124 void dict_set_label (struct dictionary *, const char *);
126 const char *dict_get_documents (const struct dictionary *);
127 void dict_set_documents (struct dictionary *, const char *);
129 bool dict_create_vector (struct dictionary *,
131 struct variable **, size_t cnt);
132 void dict_create_vector_assert (struct dictionary *,
134 struct variable **, size_t cnt);
135 const struct vector *dict_get_vector (const struct dictionary *,
137 size_t dict_get_vector_cnt (const struct dictionary *);
138 const struct vector *dict_lookup_vector (const struct dictionary *,
140 void dict_clear_vectors (struct dictionary *);
142 void dict_assign_short_names (struct dictionary *);
144 /* Called only from variable.c */
145 void dict_var_changed (const struct variable *v);
147 #endif /* dictionary.h */