/* PSPP - a program for statistical analysis.
- Copyright (C) 2005 Free Software Foundation, Inc.
+ Copyright (C) 2005, 2009, 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
user-missing values, or a range of numeric values, or a
range plus one discrete value.
- - Short string variables may have up to 3 discrete string
- user-missing values.
-
- - Long string variables may not have user-missing
- values. */
+ - String variables may have up to 3 discrete string
+ user-missing values. (However, for long string
+ variables all bytes after the first MV_MAX_STRING must
+ be spaces.)
+*/
#ifndef DATA_MISSING_VALUES_H
#define DATA_MISSING_VALUES_H 1
#include <stdbool.h>
#include "data/value.h"
+struct pool;
+
+/* Missing values for long string variables after the first
+ MV_MAX_STRING bytes must be all spaces. */
+#define MV_MAX_STRING 8
+
/* Missing values.
Opaque--use access functions defined below. */
struct missing_values
union value values[3]; /* Missing values. [1], [2] are the range. */
};
-/* Classes of missing values. */
+/* Classes of missing values.
+
+ These are useful as individual values and as masks, and they are used both
+ ways. */
enum mv_class
{
- MV_NEVER = 0, /* Never considered missing. */
- MV_USER = 1, /* Missing if value is user-missing. */
- MV_SYSTEM = 2, /* Missing if value is system-missing. */
- MV_ANY = MV_USER | MV_SYSTEM /* Missing if it is user or system-missing. */
+ MV_USER = 1, /* User-missing. */
+ MV_SYSTEM = 2 /* System-missing. */
+#define MV_ANY (MV_USER | MV_SYSTEM)
};
/* Is a value missing? */
-bool mv_is_value_missing (const struct missing_values *, const union value *,
- enum mv_class);
-bool mv_is_num_missing (const struct missing_values *, double, enum mv_class);
-bool mv_is_str_missing (const struct missing_values *, const char[],
- enum mv_class);
+enum mv_class mv_is_value_missing (const struct missing_values *,
+ const union value *);
+enum mv_class mv_is_num_missing (const struct missing_values *, double);
+enum mv_class mv_is_str_missing (const struct missing_values *,
+ const uint8_t[]);
+enum mv_class mv_is_value_missing_varwidth (const struct missing_values *,
+ const union value *,
+ int value_width);
/* Initializing missing value sets. */
void mv_init (struct missing_values *, int width);
+void mv_init_pool (struct pool *pool, struct missing_values *, int width);
+void mv_destroy (struct missing_values *);
void mv_copy (struct missing_values *, const struct missing_values *);
void mv_clear (struct missing_values *);
void mv_resize (struct missing_values *, int width);
/* Basic property inspection. */
+bool mv_is_acceptable (const union value *, int width);
bool mv_is_empty (const struct missing_values *);
int mv_get_width (const struct missing_values *);
/* Inspecting discrete values. */
int mv_n_values (const struct missing_values *);
bool mv_has_value (const struct missing_values *);
-void mv_get_value (const struct missing_values *, union value *, int idx);
+const union value *mv_get_value (const struct missing_values *, int idx);
/* Inspecting ranges. */
bool mv_has_range (const struct missing_values *);
/* Adding and modifying discrete values. */
bool mv_add_value (struct missing_values *, const union value *);
-bool mv_add_str (struct missing_values *, const char[]);
+bool mv_add_str (struct missing_values *, const uint8_t[], size_t len);
bool mv_add_num (struct missing_values *, double);
void mv_pop_value (struct missing_values *, union value *);
-void mv_replace_value (struct missing_values *, const union value *, int idx);
+bool mv_replace_value (struct missing_values *, const union value *, int idx);
/* Adding and modifying ranges. */
bool mv_add_range (struct missing_values *, double low, double high);
void mv_pop_range (struct missing_values *, double *low, double *high);
+/* Formatting. */
+char *mv_to_string (const struct missing_values *, const char *encoding);
+
#endif /* data/missing-values.h */