Change license from GPLv2+ to GPLv3+.
[pspp-builds.git] / src / data / variable.h
index 0cb20b8fec3dd9204f3281e012462aa17335391b..9cc2b844c9698e08d8ecea96f059cc11fcf332a3 100644 (file)
@@ -1,28 +1,25 @@
-/* PSPP - computes sample statistics.
+/* PSPP - a program for statistical analysis.
    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
 
-   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 <http://www.gnu.org/licenses/>. */
 
 #if !variable_h
 #define variable_h 1
 
 #include <stddef.h>
-#include "config.h"
 #include <stdbool.h>
+#include <data/missing-values.h>
 
 union value;
 
@@ -62,6 +59,9 @@ unsigned hash_var_ptr_by_name (const void *, const void *);
 enum var_type var_get_type (const struct variable *);
 int var_get_width (const struct variable *);
 void var_set_width (struct variable *, int width);
+
+typedef bool var_predicate_func (const struct variable *);
+
 bool var_is_numeric (const struct variable *);
 bool var_is_alpha (const struct variable *);
 bool var_is_short_string (const struct variable *);
@@ -74,17 +74,10 @@ void var_set_missing_values (struct variable *, const struct missing_values *);
 void var_clear_missing_values (struct variable *);
 bool var_has_missing_values (const struct variable *);
 
-typedef bool var_is_missing_func (const struct variable *,
-                                  const union value *);
-bool var_is_value_missing (const struct variable *, const union value *);
-bool var_is_num_missing (const struct variable *, double);
-bool var_is_str_missing (const struct variable *, const char[]);
-bool var_is_value_user_missing (const struct variable *,
-                                const union value *);
-bool var_is_num_user_missing (const struct variable *, double);
-bool var_is_str_user_missing (const struct variable *, const char[]);
-bool var_is_value_system_missing (const struct variable *,
-                                  const union value *);
+bool var_is_value_missing (const struct variable *, const union value *,
+                           enum mv_class);
+bool var_is_num_missing (const struct variable *, double, enum mv_class);
+bool var_is_str_missing (const struct variable *, const char[], enum mv_class);
 
 /* Value labels. */
 const struct val_labs *var_get_value_labels (const struct variable *);
@@ -116,9 +109,9 @@ bool var_has_label (const struct variable *);
 /* How data is measured. */
 enum measure
   {
-    MEASURE_NOMINAL = 1,
-    MEASURE_ORDINAL = 2,
-    MEASURE_SCALE = 3,
+    MEASURE_NOMINAL = 0,
+    MEASURE_ORDINAL = 1,
+    MEASURE_SCALE = 2,
     n_MEASURES
   };
 
@@ -131,7 +124,7 @@ int var_get_display_width (const struct variable *);
 void var_set_display_width (struct variable *, int display_width);
 
 /* Alignment of data for display. */
-enum alignment 
+enum alignment
   {
     ALIGN_LEFT = 0,
     ALIGN_RIGHT = 1,
@@ -160,7 +153,7 @@ size_t var_get_case_index (const struct variable *);
 
 /* Variable auxiliary data. */
 void *var_get_aux (const struct variable *);
-void *var_attach_aux (struct variable *,
+void *var_attach_aux (const struct variable *,
                       void *aux, void (*aux_dtor) (struct variable *));
 void var_clear_aux (struct variable *);
 void *var_detach_aux (struct variable *);
@@ -168,11 +161,11 @@ void var_dtor_free (struct variable *);
 
 /* Observed categorical values. */
 struct cat_vals *var_get_obs_vals (const struct variable *);
-void var_set_obs_vals (struct variable *, struct cat_vals *);
+void var_set_obs_vals (const struct variable *, struct cat_vals *);
 bool var_has_obs_vals (const struct variable *);
 
 /* Classes of variables. */
-enum dict_class 
+enum dict_class
   {
     DC_ORDINARY,                /* Ordinary identifier. */
     DC_SYSTEM,                  /* System variable. */