src/data/value.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>. */
  16
  17 #ifndef DATA_VALUE_H
  18 #define DATA_VALUE_H 1
  19
  20 #include <libpspp/misc.h>
  21 #include <stdbool.h>
  22 #include "minmax.h"
  23
  24 /* "Short" strings, which are generally those no more than 8
  25    characters wide, can participate in more operations than
  26    longer strings. */
  27 #define MAX_SHORT_STRING (MAX (ROUND_UP (SIZEOF_DOUBLE, 2), 8))
  28 #define MIN_LONG_STRING (MAX_SHORT_STRING + 1)
  29
  30 /* A numeric or short string value.
  31    Multiple consecutive values represent a long string. */
  32 union value
  33   {
  34     double f;
  35     char s[MAX_SHORT_STRING];
  36   };
  37
  38 union value *value_dup (const union value *, int width);
  39 union value *value_create (int width);
  40
  41 int compare_values (const union value *, const union value *, int width);
  42 unsigned hash_value (const union value  *, int width);
  43
  44 static inline size_t value_cnt_from_width (int width);
  45 void value_copy (union value *, const union value *, int width);
  46 void value_set_missing (union value *, int width);
  47 bool value_is_resizable (const union value *, int old_width, int new_width);
  48 void value_resize (union value *, int old_width, int new_width);
  49
  50 /* Number of "union value"s required for a variable of the given
  51    WIDTH. */
  52 static inline size_t
  53 value_cnt_from_width (int width)
  54 {
  55   return width == 0 ? 1 : DIV_RND_UP (width, MAX_SHORT_STRING);
  56 }
  57
  58 #endif /* data/value.h */