Patch #6262. New developers guide and resulting fixes and cleanups.

[pspp-builds.git] / src / data / missing-values.h

diff --git a/src/data/missing-values.h b/src/data/missing-values.h
index 4f87f54360ff3aa19616489ef1c9a0848a219620..b504f8c769a928be238ce8d161a8cf577dbee051 100644 (file)
--- a/src/data/missing-values.h
+++ b/src/data/missing-values.h
@@ -14,11 +14,27 @@
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
-#if !missing_values_h
-#define missing_values_h 1
+/* User-missing values.
+
+   struct missing_values is an opaque type that represents a set
+   of user-missing values associated with a variable.  Valid sets
+   of missing values depend on variable width:
+
+        - Numeric variables may have up to 3 discrete numeric
+          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. */
+
+#ifndef DATA_MISSING_VALUES_H
+#define DATA_MISSING_VALUES_H 1
 
 #include <stdbool.h>
-#include "value.h"
+#include "data/value.h"
 
 /* Missing values.
    Opaque--use access functions defined below. */
@@ -26,7 +42,7 @@ struct missing_values
   {
     int type;                   /* Types of missing values, one of MVT_*. */
     int width;                  /* 0=numeric, otherwise string width. */
-    union value values[3];      /* Missing values.  [y,z] are the range. */
+    union value values[3];      /* Missing values.  [1], [2] are the range. */
   };
 
 /* Classes of missing values. */
@@ -38,41 +54,44 @@ enum mv_class
     MV_ANY = MV_USER | MV_SYSTEM /* Missing if it is user or system-missing. */
   };
 
+/* 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);
+
+/* Initializing missing value sets. */
 void mv_init (struct missing_values *, int width);
+void mv_copy (struct missing_values *, const struct missing_values *);
 void mv_clear (struct missing_values *);
 
-void mv_copy (struct missing_values *, const struct missing_values *);
+/* Changing width of a missing value set. */
+bool mv_is_resizable (const struct missing_values *, int width);
+void mv_resize (struct missing_values *, int width);
+
+/* Basic property inspection. */
 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);
+
+/* Inspecting ranges. */
+bool mv_has_range (const struct missing_values *);
+void mv_get_range (const struct missing_values *, double *low, double *high);
+
+/* 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_num (struct missing_values *, double);
-bool mv_add_num_range (struct missing_values *, double low, double high);
-
-bool mv_has_value (const struct missing_values *);
 void mv_pop_value (struct missing_values *, union value *);
-void mv_peek_value (const struct missing_values *mv, union value *v, int idx);
-void mv_replace_value (struct missing_values *mv, const union value *v, int idx);
-
-int  mv_n_values (const struct missing_values *mv);
+void mv_replace_value (struct missing_values *, const union value *, int idx);
 
-
-bool mv_has_range (const struct missing_values *);
+/* 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);
-void mv_peek_range (const struct missing_values *, double *low, double *high);
-
-bool mv_is_resizable (const struct missing_values *, int width);
-void mv_resize (struct missing_values *, int width);
-
-typedef bool mv_is_missing_func (const struct missing_values *,
-                                 const union value *);
-
-/* 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);
 
-#endif /* missing-values.h */
+#endif /* data/missing-values.h */