1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2005, 2009, 2013-2015 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/>. */
17 /* User-missing values.
19 struct missing_values is an opaque type that represents a set
20 of user-missing values associated with a variable. Valid sets
21 of missing values depend on variable width:
23 - Numeric variables may have up to 3 discrete numeric
24 user-missing values, or a range of numeric values, or a
25 range plus one discrete value.
27 - String variables may have up to 3 discrete string
28 user-missing values. (However, for long string
29 variables all bytes after the first MV_MAX_STRING must
33 #ifndef DATA_MISSING_VALUES_H
34 #define DATA_MISSING_VALUES_H 1
37 #include "data/value.h"
42 /* Missing values for long string variables after the first
43 MV_MAX_STRING bytes must be all spaces. */
44 #define MV_MAX_STRING 8
47 Opaque--use access functions defined below. */
50 int type; /* Types of missing values, one of MVT_*. */
51 int width; /* 0=numeric, otherwise string width. */
52 union value values[3]; /* Missing values. [1], [2] are the range. */
55 /* Classes of missing values. */
58 MV_NEVER = 0, /* Never considered missing. */
59 MV_USER = 1, /* Missing if value is user-missing. */
60 MV_SYSTEM = 2, /* Missing if value is system-missing. */
61 MV_ANY = MV_USER | MV_SYSTEM /* Missing if it is user or system-missing. */
64 /* Is a value missing? */
65 bool mv_is_value_missing (const struct missing_values *, const union value *,
67 bool mv_is_num_missing (const struct missing_values *, double, enum mv_class);
68 bool mv_is_str_missing (const struct missing_values *, const uint8_t[],
71 /* Initializing missing value sets. */
72 void mv_init (struct missing_values *, int width);
73 void mv_init_pool (struct pool *pool, struct missing_values *, int width);
74 void mv_destroy (struct missing_values *);
75 void mv_copy (struct missing_values *, const struct missing_values *);
76 void mv_clear (struct missing_values *);
78 /* Changing width of a missing value set. */
79 bool mv_is_resizable (const struct missing_values *, int width);
80 void mv_resize (struct missing_values *, int width);
82 /* Basic property inspection. */
83 bool mv_is_acceptable (const union value *, int width);
84 bool mv_is_empty (const struct missing_values *);
85 int mv_get_width (const struct missing_values *);
87 /* Inspecting discrete values. */
88 int mv_n_values (const struct missing_values *);
89 bool mv_has_value (const struct missing_values *);
90 const union value *mv_get_value (const struct missing_values *, int idx);
92 /* Inspecting ranges. */
93 bool mv_has_range (const struct missing_values *);
94 void mv_get_range (const struct missing_values *, double *low, double *high);
96 /* Adding and modifying discrete values. */
97 bool mv_add_value (struct missing_values *, const union value *);
98 bool mv_add_str (struct missing_values *, const uint8_t[], size_t len);
99 bool mv_add_num (struct missing_values *, double);
100 void mv_pop_value (struct missing_values *, union value *);
101 bool mv_replace_value (struct missing_values *, const union value *, int idx);
103 /* Adding and modifying ranges. */
104 bool mv_add_range (struct missing_values *, double low, double high);
105 void mv_pop_range (struct missing_values *, double *low, double *high);
107 /* Saving and loading. */
108 struct pxd_object *mv_save (const struct missing_values *, struct pxd *);
109 void mv_load (struct missing_values *,
110 struct pxd_object *, const struct pxd *);
112 #endif /* data/missing-values.h */