X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fdata%2Fdictionary.h;h=1166fcd280b04ec05dda3ac7dc7033d41133f666;hb=7bf210c4fd179a22dd8c6a071f0b23f7ae4e14c2;hp=1a7e8de059df4844a34d34ff05290c6b0d19a789;hpb=c489ad9041918ca8c80dadceade988daab1d25f8;p=pspp diff --git a/src/data/dictionary.h b/src/data/dictionary.h index 1a7e8de059..1166fcd280 100644 --- a/src/data/dictionary.h +++ b/src/data/dictionary.h @@ -1,117 +1,204 @@ -/* PSPP - computes sample statistics. - Copyright (C) 2004 Free Software Foundation, Inc. - Written by Ben Pfaff . +/* PSPP - a program for statistical analysis. + Copyright (C) 2004, 2007, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc. - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - 02110-1301, USA. */ + along with this program. If not, see . */ -#ifndef DICTIONARY_H -#define DICTIONARY_H +#ifndef DATA_DICTIONARY_H +#define DATA_DICTIONARY_H 1 #include #include +#include "data/case.h" +#include "data/dict-class.h" -/* Dictionary. */ +struct string; +struct ccase; -struct variable; -struct dictionary *dict_create (void); +/* Creating dictionaries. */ +struct dictionary *dict_create (const char *encoding); struct dictionary *dict_clone (const struct dictionary *); + + +/* Clearing and destroying dictionaries. */ void dict_clear (struct dictionary *); -void dict_clear_aux (struct dictionary *); void dict_destroy (struct dictionary *); +/* Common ways to access variables. */ +struct variable *dict_lookup_var (const struct dictionary *, const char *); +struct variable *dict_lookup_var_assert (const struct dictionary *, + const char *); +struct variable *dict_get_var (const struct dictionary *, size_t position); size_t dict_get_var_cnt (const struct dictionary *); -struct variable *dict_get_var (const struct dictionary *, size_t idx); + +/* Other access to variables. */ +bool dict_contains_var (const struct dictionary *, const struct variable *); void dict_get_vars (const struct dictionary *, - struct variable ***vars, size_t *cnt, - unsigned exclude_classes); + const struct variable ***vars, size_t *cnt, + enum dict_class exclude); +void dict_get_vars_mutable (const struct dictionary *, + struct variable ***vars, size_t *cnt, + enum dict_class exclude); +/* Creating variables. */ struct variable *dict_create_var (struct dictionary *, const char *, int width); - struct variable *dict_create_var_assert (struct dictionary *, const char *, - int width); -struct variable *dict_clone_var (struct dictionary *, const struct variable *, - const char *); + int width); +struct variable *dict_clone_var (struct dictionary *, const struct variable *); struct variable *dict_clone_var_assert (struct dictionary *, - const struct variable *, const char *); + const struct variable *); +struct variable *dict_clone_var_as (struct dictionary *, + const struct variable *, const char *); +struct variable *dict_clone_var_as_assert (struct dictionary *, + const struct variable *, + const char *); -struct variable *dict_lookup_var (const struct dictionary *, const char *); -struct variable *dict_lookup_var_assert (const struct dictionary *, - const char *); -bool dict_contains_var (const struct dictionary *, const struct variable *); +struct variable *dict_clone_var_in_place_assert (struct dictionary *, + const struct variable *); + +/* Deleting variables. */ void dict_delete_var (struct dictionary *, struct variable *); void dict_delete_vars (struct dictionary *, struct variable *const *, size_t count); +void dict_delete_consecutive_vars (struct dictionary *, + size_t idx, size_t count); void dict_delete_scratch_vars (struct dictionary *); -void dict_reorder_var (struct dictionary *d, struct variable *v, + +/* Changing the order of variables. */ +void dict_reorder_var (struct dictionary *, struct variable *, size_t new_index); void dict_reorder_vars (struct dictionary *, struct variable *const *, size_t count); + +/* Variable names. */ +bool dict_try_rename_var (struct dictionary *, + struct variable *, const char *); void dict_rename_var (struct dictionary *, struct variable *, const char *); bool dict_rename_vars (struct dictionary *, struct variable **, char **new_names, size_t count, char **err_name); +char *dict_make_unique_var_name (const struct dictionary *, const char *hint, + unsigned long int *num_start); -struct ccase; +/* Weight variable. */ +double dict_get_case_weight (const struct dictionary *, + const struct ccase *, bool *); struct variable *dict_get_weight (const struct dictionary *); -double dict_get_case_weight (const struct dictionary *, - const struct ccase *, int *); void dict_set_weight (struct dictionary *, struct variable *); +/* Filter variable. */ struct variable *dict_get_filter (const struct dictionary *); void dict_set_filter (struct dictionary *, struct variable *); -size_t dict_get_case_limit (const struct dictionary *); -void dict_set_case_limit (struct dictionary *, size_t); +/* Case limit (N OF CASES). */ +casenumber dict_get_case_limit (const struct dictionary *); +void dict_set_case_limit (struct dictionary *, casenumber); +/* Size of cases for this dictionary. */ +const struct caseproto *dict_get_proto (const struct dictionary *); int dict_get_next_value_idx (const struct dictionary *); size_t dict_get_case_size (const struct dictionary *); +/* Making this dictionary's cases smaller (if some variables were + deleted). */ +size_t dict_count_values (const struct dictionary *, + unsigned int exclude_classes); void dict_compact_values (struct dictionary *); -size_t dict_get_compacted_value_cnt (const struct dictionary *); -int *dict_get_compacted_idx_to_fv (const struct dictionary *); -bool dict_compacting_would_shrink (const struct dictionary *); -bool dict_compacting_would_change (const struct dictionary *); +struct caseproto *dict_get_compacted_proto (const struct dictionary *, + unsigned int exclude_classes); -struct dict_compactor *dict_make_compactor (const struct dictionary *); -void dict_compactor_compact (const struct dict_compactor *, - struct ccase *, const struct ccase *); -void dict_compactor_destroy (struct dict_compactor *); - -struct variable *const *dict_get_split_vars (const struct dictionary *); +/* SPLIT FILE variables. */ +const struct variable *const *dict_get_split_vars (const struct dictionary *); size_t dict_get_split_cnt (const struct dictionary *); void dict_set_split_vars (struct dictionary *, struct variable *const *, size_t cnt); +/* File label. */ const char *dict_get_label (const struct dictionary *); void dict_set_label (struct dictionary *, const char *); -const char *dict_get_documents (const struct dictionary *); -void dict_set_documents (struct dictionary *, const char *); +/* Documents. */ +#define DOC_LINE_LENGTH 80 /* Fixed length of document lines. */ + +const struct string_array *dict_get_documents (const struct dictionary *); +void dict_set_documents (struct dictionary *, const struct string_array *); +void dict_set_documents_string (struct dictionary *, const char *); +void dict_clear_documents (struct dictionary *); -bool dict_create_vector (struct dictionary *, - const char *name, +bool dict_add_document_line (struct dictionary *, const char *, + bool issue_warning); +size_t dict_get_document_line_cnt (const struct dictionary *); +const char *dict_get_document_line (const struct dictionary *, size_t); + +/* Vectors. */ +bool dict_create_vector (struct dictionary *, const char *name, struct variable **, size_t cnt); -const struct vector *dict_get_vector (const struct dictionary *, - size_t idx); +void dict_create_vector_assert (struct dictionary *, const char *name, + struct variable **, size_t cnt); +const struct vector *dict_get_vector (const struct dictionary *, size_t idx); size_t dict_get_vector_cnt (const struct dictionary *); const struct vector *dict_lookup_vector (const struct dictionary *, const char *name); void dict_clear_vectors (struct dictionary *); -void dict_assign_short_names (struct dictionary *); +/* Multiple response sets. */ +const struct mrset *dict_get_mrset (const struct dictionary *, size_t idx); +size_t dict_get_n_mrsets (const struct dictionary *); +const struct mrset *dict_lookup_mrset (const struct dictionary *, + const char *name); + +bool dict_add_mrset (struct dictionary *, struct mrset *); +bool dict_delete_mrset (struct dictionary *, const char *name); +void dict_clear_mrsets (struct dictionary *); + +/* Attributes. */ +struct attrset *dict_get_attributes (const struct dictionary *); +void dict_set_attributes (struct dictionary *, const struct attrset *); +bool dict_has_attributes (const struct dictionary *); + +/* Data encoding. */ +const char *dict_get_encoding (const struct dictionary *d); + +bool dict_id_is_valid (const struct dictionary *, const char *id, + bool issue_error); + +/* Internal variables. */ +struct variable *dict_create_internal_var (int case_idx, int width); +void dict_destroy_internal_var (struct variable *); + +/* Functions to be called upon dictionary changes. */ +struct dict_callbacks + { + void (*var_added) (struct dictionary *, int, void *); + void (*var_deleted) (struct dictionary *, const struct variable *, + int dict_index, int case_index, void *); + void (*var_changed) (struct dictionary *, int, unsigned int, const struct variable *, void *); + void (*weight_changed) (struct dictionary *, int, void *); + void (*filter_changed) (struct dictionary *, int, void *); + void (*split_changed) (struct dictionary *, void *); + }; + +void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *, + void *); +void dict_copy_callbacks (struct dictionary *, const struct dictionary *); + +void dict_set_change_callback (struct dictionary *d, + void (*changed) (struct dictionary *, void*), + void *data); + + +/* Debug use only. */ +void dict_dump (const struct dictionary *); -#endif /* dictionary.h */ +#endif /* data/dictionary.h */