src/data/subcase.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2008 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 #include <config.h>
  18 #include <data/subcase.h>
  19 #include <stdlib.h>
  20 #include <data/case.h>
  21 #include <data/variable.h>
  22 #include <libpspp/assertion.h>
  23
  24 #include "xalloc.h"
  25
  26 /* Initializes SC as a subcase that contains no fields. */
  27 void
  28 subcase_init_empty (struct subcase *sc)
  29 {
  30   sc->fields = NULL;
  31   sc->n_fields = 0;
  32   sc->n_values = 0;
  33 }
  34
  35 /* Initializes SC as a subcase with fields extracted from the
  36    N_VARS variables in VARS, with ascending sort order. */
  37 void
  38 subcase_init_vars (struct subcase *sc,
  39                    const struct variable *const *vars, size_t n_vars)
  40 {
  41   size_t i;
  42
  43   sc->fields = xnmalloc (n_vars, sizeof *sc->fields);
  44   sc->n_fields = n_vars;
  45   sc->n_values = 0;
  46   for (i = 0; i < n_vars; i++)
  47     {
  48       struct subcase_field *field = &sc->fields[i];
  49       field->case_index = var_get_case_index (vars[i]);
  50       field->width = var_get_width (vars[i]);
  51       field->direction = SC_ASCEND;
  52       sc->n_values += value_cnt_from_width (field->width);
  53     }
  54 }
  55
  56 /* Initializes SC as a subcase with a single field extracted
  57    from VAR, with the sort order specified by DIRECTION.  */
  58 void
  59 subcase_init_var (struct subcase *sc, const struct variable *var,
  60                   enum subcase_direction direction)
  61 {
  62   subcase_init_empty (sc);
  63   subcase_add_var (sc, var, direction);
  64 }
  65
  66 /* Removes all the fields from SC. */
  67 void
  68 subcase_clear (struct subcase *sc)
  69 {
  70   sc->n_fields = 0;
  71   sc->n_values = 0;
  72 }
  73
  74 /* Initializes SC with the same fields as ORIG. */
  75 void
  76 subcase_clone (struct subcase *sc, const struct subcase *orig)
  77 {
  78   sc->fields = xmemdup (orig->fields, orig->n_fields * sizeof *orig->fields);
  79   sc->n_fields = orig->n_fields;
  80   sc->n_values = orig->n_values;
  81 }
  82
  83 /* Frees the memory owned by SC (but not SC itself). */
  84 void
  85 subcase_destroy (struct subcase *sc)
  86 {
  87   free (sc->fields);
  88 }
  89
  90 /* Add a field for VAR to SC, with DIRECTION as the sort order.
  91    Returns true if successful, false if VAR already has a field
  92    in SC. */
  93 bool
  94 subcase_add_var (struct subcase *sc, const struct variable *var,
  95                  enum subcase_direction direction)
  96 {
  97   size_t case_index = var_get_case_index (var);
  98   struct subcase_field *field;
  99   size_t i;
 100
 101   for (i = 0; i < sc->n_fields; i++)
 102     if (sc->fields[i].case_index == case_index)
 103       return false;
 104
 105   sc->fields = xnrealloc (sc->fields, sc->n_fields + 1, sizeof *sc->fields);
 106   field = &sc->fields[sc->n_fields++];
 107   field->case_index = case_index;
 108   field->width = var_get_width (var);
 109   field->direction = direction;
 110   sc->n_values += value_cnt_from_width (field->width);
 111   return true;
 112 }
 113
 114 /* Returns true if and only if A and B are conformable, which
 115    means that they have the same number of fields and that each
 116    corresponding field in A and B have the same width. */
 117 bool
 118 subcase_conformable (const struct subcase *a, const struct subcase *b)
 119 {
 120   size_t i;
 121
 122   if (a == b)
 123     return true;
 124   if (a->n_values != b->n_values || a->n_fields != b->n_fields)
 125     return false;
 126   for (i = 0; i < a->n_fields; i++)
 127     if (a->fields[i].width != b->fields[i].width)
 128       return false;
 129   return true;
 130 }
 131
 132 /* Copies the fields represented by SC from C into VALUES.
 133    VALUES must have space for at least subcase_get_n_values(SC)
 134    array elements. */
 135 void
 136 subcase_extract (const struct subcase *sc, const struct ccase *c,
 137                  union value values[])
 138 {
 139   size_t i;
 140
 141   for (i = 0; i < sc->n_fields; i++)
 142     {
 143       const struct subcase_field *field = &sc->fields[i];
 144       value_copy (values, case_data_idx (c, field->case_index), field->width);
 145       values += value_cnt_from_width (field->width);
 146     }
 147 }
 148
 149 /* Copies the data in VALUES into the fields in C represented by
 150    SC.  VALUES must have at least subcase_get_n_values(SC) array
 151    elements, and C must be large enough to contain all the fields
 152    in SC. */
 153 void
 154 subcase_inject (const struct subcase *sc,
 155                 const union value values[], struct ccase *c)
 156 {
 157   size_t i;
 158
 159   for (i = 0; i < sc->n_fields; i++)
 160     {
 161       const struct subcase_field *field = &sc->fields[i];
 162       value_copy (case_data_rw_idx (c, field->case_index), values,
 163                   field->width);
 164       values += value_cnt_from_width (field->width);
 165     }
 166 }
 167
 168 /* Copies the fields in SRC represented by SRC_SC into the
 169    corresponding fields in DST respresented by DST_SC.  SRC_SC
 170    and DST_SC must be conformable (as tested by
 171    subcase_conformable()). */
 172 void
 173 subcase_copy (const struct subcase *src_sc, const struct ccase *src,
 174               const struct subcase *dst_sc, struct ccase *dst)
 175 {
 176   size_t i;
 177
 178   expensive_assert (subcase_conformable (src_sc, dst_sc));
 179   for (i = 0; i < src_sc->n_fields; i++)
 180     {
 181       const struct subcase_field *src_field = &src_sc->fields[i];
 182       const struct subcase_field *dst_field = &dst_sc->fields[i];
 183       value_copy (case_data_rw_idx (dst, dst_field->case_index),
 184                   case_data_idx (src, src_field->case_index),
 185                   src_field->width);
 186     }
 187 }
 188
 189 /* Compares the fields in A specified in A_SC against the fields
 190    in B specified in B_SC.  Returns -1, 0, or 1 if A's fields are
 191    lexicographically less than, equal to, or greater than B's
 192    fields, respectively.
 193
 194    A_SC and B_SC must be conformable (as tested by
 195    subcase_conformable()). */
 196 int
 197 subcase_compare_3way (const struct subcase *a_sc, const struct ccase *a,
 198                       const struct subcase *b_sc, const struct ccase *b)
 199 {
 200   size_t i;
 201
 202   expensive_assert (subcase_conformable (a_sc, b_sc));
 203   for (i = 0; i < a_sc->n_fields; i++)
 204     {
 205       const struct subcase_field *a_field = &a_sc->fields[i];
 206       const struct subcase_field *b_field = &b_sc->fields[i];
 207       int cmp = value_compare_3way (case_data_idx (a, a_field->case_index),
 208                                     case_data_idx (b, b_field->case_index),
 209                                     a_field->width);
 210       if (cmp != 0)
 211         return a_field->direction == SC_ASCEND ? cmp : -cmp;
 212     }
 213   return 0;
 214 }
 215
 216 /* Compares the values in A against the values in B specified by
 217    SC's fields.  Returns -1, 0, or 1 if A's values are
 218    lexicographically less than, equal to, or greater than B's
 219    values, respectively. */
 220 int
 221 subcase_compare_3way_xc (const struct subcase *sc,
 222                          const union value a[], const struct ccase *b)
 223 {
 224   size_t i;
 225
 226   for (i = 0; i < sc->n_fields; i++)
 227     {
 228       const struct subcase_field *field = &sc->fields[i];
 229       int cmp = value_compare_3way (a, case_data_idx (b, field->case_index),
 230                                     field->width);
 231       if (cmp != 0)
 232         return field->direction == SC_ASCEND ? cmp : -cmp;
 233       a += value_cnt_from_width (field->width);
 234     }
 235   return 0;
 236 }
 237
 238 /* Compares the values in A specified by SC's fields against the
 239    values in B.  Returns -1, 0, or 1 if A's values are
 240    lexicographically less than, equal to, or greater than B's
 241    values, respectively. */
 242 int
 243 subcase_compare_3way_cx (const struct subcase *sc,
 244                          const struct ccase *a, const union value b[])
 245 {
 246   return -subcase_compare_3way_xc (sc, b, a);
 247 }
 248
 249 /* Compares the values in A against the values in B, using SC to
 250    obtain the number and width of each value.  Returns -1, 0, or
 251    1 if A's values are lexicographically less than, equal to, or
 252    greater than B's values, respectively. */
 253 int
 254 subcase_compare_3way_xx (const struct subcase *sc,
 255                          const union value a[], const union value b[])
 256 {
 257   size_t i;
 258
 259   for (i = 0; i < sc->n_fields; i++)
 260     {
 261       const struct subcase_field *field = &sc->fields[i];
 262       size_t n_values;
 263       int cmp;
 264
 265       cmp = value_compare_3way (a, b, field->width);
 266       if (cmp != 0)
 267         return field->direction == SC_ASCEND ? cmp : -cmp;
 268
 269       n_values = value_cnt_from_width (field->width);
 270       a += n_values;
 271       b += n_values;
 272     }
 273   return 0;
 274 }
 275
 276 /* Compares the fields in A specified in A_SC against the fields
 277    in B specified in B_SC.  Returns true if the fields' values
 278    are equal, false otherwise.
 279
 280    A_SC and B_SC must be conformable (as tested by
 281    subcase_conformable()). */
 282 bool
 283 subcase_equal (const struct subcase *a_sc, const struct ccase *a,
 284                const struct subcase *b_sc, const struct ccase *b)
 285 {
 286   return subcase_compare_3way (a_sc, a, b_sc, b) == 0;
 287 }
 288
 289 /* Compares the values in A against the values in B specified by
 290    SC's fields.  Returns true if A's values are equal to B's
 291    values, otherwise false. */
 292 bool
 293 subcase_equal_xc (const struct subcase *sc,
 294                   const union value a[], const struct ccase *b)
 295 {
 296   return subcase_compare_3way_xc (sc, a, b) == 0;
 297 }
 298
 299 /* Compares the values in A specified by SC's fields against the
 300    values in B.  Returns true if A's values are equal to B's
 301    values, otherwise false. */
 302 bool
 303 subcase_equal_cx (const struct subcase *sc,
 304                   const struct ccase *a, const union value b[])
 305 {
 306   return subcase_compare_3way_cx (sc, a, b) == 0;
 307 }
 308
 309 /* Compares the values in A against the values in B, using SC to
 310    obtain the number and width of each value.  Returns true if
 311    A's values are equal to B's values, otherwise false. */
 312 bool
 313 subcase_equal_xx (const struct subcase *sc,
 314                   const union value a[], const union value b[])
 315 {
 316   return subcase_compare_3way_xx (sc, a, b) == 0;
 317 }
 318