src/data/subcase.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2008, 2009 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 static void invalidate_proto (struct subcase *sc);
  27
  28 /* Initializes SC as a subcase that contains no fields. */
  29 void
  30 subcase_init_empty (struct subcase *sc)
  31 {
  32   sc->fields = NULL;
  33   sc->n_fields = 0;
  34   sc->proto = NULL;
  35 }
  36
  37 /* Initializes SC as a subcase with fields extracted from the
  38    N_VARS variables in VARS, with ascending sort order. */
  39 void
  40 subcase_init_vars (struct subcase *sc,
  41                    const struct variable *const *vars, size_t n_vars)
  42 {
  43   size_t i;
  44
  45   sc->fields = xnmalloc (n_vars, sizeof *sc->fields);
  46   sc->n_fields = n_vars;
  47   sc->proto = NULL;
  48   for (i = 0; i < n_vars; i++)
  49     {
  50       struct subcase_field *field = &sc->fields[i];
  51       field->case_index = var_get_case_index (vars[i]);
  52       field->width = var_get_width (vars[i]);
  53       field->direction = SC_ASCEND;
  54     }
  55 }
  56
  57 /* Initializes SC as a subcase with a single field extracted
  58    from VAR, with the sort order specified by DIRECTION.  */
  59 void
  60 subcase_init_var (struct subcase *sc, const struct variable *var,
  61                   enum subcase_direction direction)
  62 {
  63   subcase_init_empty (sc);
  64   subcase_add_var (sc, var, direction);
  65 }
  66
  67
  68 void
  69 subcase_init (struct subcase *sc, int index, int width,
  70                   enum subcase_direction direction)
  71 {
  72   subcase_init_empty (sc);
  73   subcase_add (sc, index, width, direction);
  74 }
  75
  76
  77 /* Removes all the fields from SC. */
  78 void
  79 subcase_clear (struct subcase *sc)
  80 {
  81   sc->n_fields = 0;
  82   invalidate_proto (sc);
  83 }
  84
  85 /* Initializes SC with the same fields as ORIG. */
  86 void
  87 subcase_clone (struct subcase *sc, const struct subcase *orig)
  88 {
  89   sc->fields = xmemdup (orig->fields, orig->n_fields * sizeof *orig->fields);
  90   sc->n_fields = orig->n_fields;
  91   sc->proto = orig->proto ? caseproto_ref (orig->proto) : NULL;
  92 }
  93
  94 /* Frees the memory owned by SC (but not SC itself). */
  95 void
  96 subcase_destroy (struct subcase *sc)
  97 {
  98   free (sc->fields);
  99   caseproto_unref (sc->proto);
 100 }
 101
 102 /* Returns true if VAR already has a field in SC,
 103    false otherwise. */
 104 bool
 105 subcase_contains_var (const struct subcase *sc, const struct variable *var)
 106 {
 107   return subcase_contains (sc, var_get_case_index (var));
 108 }
 109
 110 /* Returns true if CASE_INDEX already has a field in SC,
 111    false otherwise. */
 112 bool
 113 subcase_contains (const struct subcase *sc, int case_index)
 114 {
 115   size_t i;
 116
 117   for (i = 0; i < sc->n_fields; i++)
 118     if (sc->fields[i].case_index == case_index)
 119       return true;
 120
 121   return false;
 122 }
 123
 124 /* Add a field for VAR to SC, with DIRECTION as the sort order.
 125    Returns true if successful, false if VAR already has a field
 126    in SC. */
 127 bool
 128 subcase_add_var (struct subcase *sc, const struct variable *var,
 129                  enum subcase_direction direction)
 130 {
 131   if (!subcase_contains_var (sc, var))
 132     {
 133       subcase_add_var_always (sc, var, direction);
 134       return true;
 135     }
 136   else
 137     return false;
 138 }
 139
 140 /* Add a field for CASE_INDEX, WIDTH to SC, with DIRECTION as the sort order.
 141    Returns true if successful, false if CASE_INDEX already has a field
 142    in SC. */
 143 bool
 144 subcase_add (struct subcase *sc, int case_index, int width,
 145              enum subcase_direction direction)
 146 {
 147   if (!subcase_contains (sc, case_index))
 148     {
 149       subcase_add_always (sc, case_index, width, direction);
 150       return true;
 151     }
 152   else
 153     return false;
 154 }
 155
 156 /* Add a field for VAR to SC, with DIRECTION as the sort order,
 157    regardless of whether VAR already has a field in SC. */
 158 void
 159 subcase_add_var_always (struct subcase *sc, const struct variable *var,
 160                         enum subcase_direction direction)
 161 {
 162   return subcase_add_always (sc, var_get_case_index (var),
 163                              var_get_width (var), direction);
 164 }
 165
 166 /* Add a field for CASE_INDEX, WIDTH to SC, with DIRECTION as the
 167    sort order, regardless of whether CASE_INDEX already has a
 168    field in SC. */
 169 void
 170 subcase_add_always (struct subcase *sc, int case_index, int width,
 171                     enum subcase_direction direction)
 172 {
 173   struct subcase_field *field;
 174
 175   sc->fields = xnrealloc (sc->fields, sc->n_fields + 1, sizeof *sc->fields);
 176   field = &sc->fields[sc->n_fields++];
 177   field->case_index = case_index;
 178   field->width = width;
 179   field->direction = direction;
 180   invalidate_proto (sc);
 181 }
 182
 183 /* Adds a field to SC for each column in PROTO, so that SC
 184    contains all of the columns in PROTO in the same order as a
 185    case conforming to PROTO.  The fields are added with
 186    ascending direction. */
 187 void
 188 subcase_add_proto_always (struct subcase *sc, const struct caseproto *proto)
 189 {
 190   size_t n = caseproto_get_n_widths (proto);
 191   size_t i;
 192
 193   sc->fields = xnrealloc (sc->fields, sc->n_fields + n, sizeof *sc->fields);
 194   for (i = 0; i < n; i++)
 195     {
 196       struct subcase_field *field = &sc->fields[sc->n_fields++];
 197       field->case_index = i;
 198       field->width = caseproto_get_width (proto, i);
 199       field->direction = SC_ASCEND;
 200     }
 201   invalidate_proto (sc);
 202 }
 203
 204 /* Obtains a caseproto for a case described by SC.  The caller
 205    must not modify or unref the returned case prototype. */
 206 const struct caseproto *
 207 subcase_get_proto (const struct subcase *sc_)
 208 {
 209   struct subcase *sc = CONST_CAST (struct subcase *, sc_);
 210
 211   if (sc->proto == NULL)
 212     {
 213       size_t i;
 214
 215       sc->proto = caseproto_create ();
 216       for (i = 0; i < sc->n_fields; i++)
 217         sc->proto = caseproto_add_width (sc->proto, sc->fields[i].width);
 218     }
 219   return sc->proto;
 220 }
 221
 222 /* Returns true if and only if A and B are conformable, which
 223    means that they have the same number of fields and that each
 224    corresponding field in A and B have the same width. */
 225 bool
 226 subcase_conformable (const struct subcase *a, const struct subcase *b)
 227 {
 228   size_t i;
 229
 230   if (a == b)
 231     return true;
 232   if (a->n_fields != b->n_fields)
 233     return false;
 234   for (i = 0; i < a->n_fields; i++)
 235     if (a->fields[i].width != b->fields[i].width)
 236       return false;
 237   return true;
 238 }
 239
 240 /* Copies the fields represented by SC from C into VALUES.
 241    VALUES must have space for at least subcase_get_n_fields(SC)
 242    array elements. */
 243 void
 244 subcase_extract (const struct subcase *sc, const struct ccase *c,
 245                  union value values[])
 246 {
 247   size_t i;
 248
 249   for (i = 0; i < sc->n_fields; i++)
 250     {
 251       const struct subcase_field *field = &sc->fields[i];
 252       union value *value = &values[i];
 253       value_copy (value, case_data_idx (c, field->case_index), field->width);
 254     }
 255 }
 256
 257 /* Copies the data in VALUES into the fields in C represented by
 258    SC.  VALUES must have at least subcase_get_n_fields(SC) array
 259    elements, and C must be large enough to contain all the fields
 260    in SC. */
 261 void
 262 subcase_inject (const struct subcase *sc,
 263                 const union value values[], struct ccase *c)
 264 {
 265   size_t i;
 266
 267   for (i = 0; i < sc->n_fields; i++)
 268     {
 269       const struct subcase_field *field = &sc->fields[i];
 270       const union value *value = &values[i];
 271       value_copy (case_data_rw_idx (c, field->case_index), value,
 272                   field->width);
 273     }
 274 }
 275
 276 /* Copies the fields in SRC represented by SRC_SC into the
 277    corresponding fields in DST respresented by DST_SC.  SRC_SC
 278    and DST_SC must be conformable (as tested by
 279    subcase_conformable()).
 280
 281    DST must not be shared. */
 282 void
 283 subcase_copy (const struct subcase *src_sc, const struct ccase *src,
 284               const struct subcase *dst_sc, struct ccase *dst)
 285 {
 286   size_t i;
 287
 288   expensive_assert (subcase_conformable (src_sc, dst_sc));
 289   for (i = 0; i < src_sc->n_fields; i++)
 290     {
 291       const struct subcase_field *src_field = &src_sc->fields[i];
 292       const struct subcase_field *dst_field = &dst_sc->fields[i];
 293       value_copy (case_data_rw_idx (dst, dst_field->case_index),
 294                   case_data_idx (src, src_field->case_index),
 295                   src_field->width);
 296     }
 297 }
 298
 299 /* Compares the fields in A specified in A_SC against the fields
 300    in B specified in B_SC.  Returns -1, 0, or 1 if A's fields are
 301    lexicographically less than, equal to, or greater than B's
 302    fields, respectively.
 303
 304    A_SC and B_SC must be conformable (as tested by
 305    subcase_conformable()). */
 306 int
 307 subcase_compare_3way (const struct subcase *a_sc, const struct ccase *a,
 308                       const struct subcase *b_sc, const struct ccase *b)
 309 {
 310   size_t i;
 311
 312   expensive_assert (subcase_conformable (a_sc, b_sc));
 313   for (i = 0; i < a_sc->n_fields; i++)
 314     {
 315       const struct subcase_field *a_field = &a_sc->fields[i];
 316       const struct subcase_field *b_field = &b_sc->fields[i];
 317       int cmp = value_compare_3way (case_data_idx (a, a_field->case_index),
 318                                     case_data_idx (b, b_field->case_index),
 319                                     a_field->width);
 320       if (cmp != 0)
 321         return a_field->direction == SC_ASCEND ? cmp : -cmp;
 322     }
 323   return 0;
 324 }
 325
 326 /* Compares the values in A against the values in B specified by
 327    SC's fields.  Returns -1, 0, or 1 if A's values are
 328    lexicographically less than, equal to, or greater than B's
 329    values, respectively. */
 330 int
 331 subcase_compare_3way_xc (const struct subcase *sc,
 332                          const union value a[], const struct ccase *b)
 333 {
 334   size_t i;
 335
 336   for (i = 0; i < sc->n_fields; i++)
 337     {
 338       const struct subcase_field *field = &sc->fields[i];
 339       int cmp = value_compare_3way (&a[i],
 340                                     case_data_idx (b, field->case_index),
 341                                     field->width);
 342       if (cmp != 0)
 343         return field->direction == SC_ASCEND ? cmp : -cmp;
 344     }
 345   return 0;
 346 }
 347
 348 /* Compares the values in A specified by SC's fields against the
 349    values in B.  Returns -1, 0, or 1 if A's values are
 350    lexicographically less than, equal to, or greater than B's
 351    values, respectively. */
 352 int
 353 subcase_compare_3way_cx (const struct subcase *sc,
 354                          const struct ccase *a, const union value b[])
 355 {
 356   return -subcase_compare_3way_xc (sc, b, a);
 357 }
 358
 359 /* Compares the values in A against the values in B, using SC to
 360    obtain the number and width of each value.  Returns -1, 0, or
 361    1 if A's values are lexicographically less than, equal to, or
 362    greater than B's values, respectively. */
 363 int
 364 subcase_compare_3way_xx (const struct subcase *sc,
 365                          const union value a[], const union value b[])
 366 {
 367   size_t i;
 368
 369   for (i = 0; i < sc->n_fields; i++)
 370     {
 371       const struct subcase_field *field = &sc->fields[i];
 372       int cmp = value_compare_3way (a++, b++, field->width);
 373       if (cmp != 0)
 374         return field->direction == SC_ASCEND ? cmp : -cmp;
 375     }
 376   return 0;
 377 }
 378
 379 /* Compares the fields in A specified in A_SC against the fields
 380    in B specified in B_SC.  Returns true if the fields' values
 381    are equal, false otherwise.
 382
 383    A_SC and B_SC must be conformable (as tested by
 384    subcase_conformable()). */
 385 bool
 386 subcase_equal (const struct subcase *a_sc, const struct ccase *a,
 387                const struct subcase *b_sc, const struct ccase *b)
 388 {
 389   return subcase_compare_3way (a_sc, a, b_sc, b) == 0;
 390 }
 391
 392 /* Compares the values in A against the values in B specified by
 393    SC's fields.  Returns true if A's values are equal to B's
 394    values, otherwise false. */
 395 bool
 396 subcase_equal_xc (const struct subcase *sc,
 397                   const union value a[], const struct ccase *b)
 398 {
 399   return subcase_compare_3way_xc (sc, a, b) == 0;
 400 }
 401
 402 /* Compares the values in A specified by SC's fields against the
 403    values in B.  Returns true if A's values are equal to B's
 404    values, otherwise false. */
 405 bool
 406 subcase_equal_cx (const struct subcase *sc,
 407                   const struct ccase *a, const union value b[])
 408 {
 409   return subcase_compare_3way_cx (sc, a, b) == 0;
 410 }
 411
 412 /* Compares the values in A against the values in B, using SC to
 413    obtain the number and width of each value.  Returns true if
 414    A's values are equal to B's values, otherwise false. */
 415 bool
 416 subcase_equal_xx (const struct subcase *sc,
 417                   const union value a[], const union value b[])
 418 {
 419   return subcase_compare_3way_xx (sc, a, b) == 0;
 420 }
 421
 422 /* Discards SC's case prototype.  (It will be recreated if needed
 423    again later.) */
 424 static void
 425 invalidate_proto (struct subcase *sc)
 426 {
 427   caseproto_unref (sc->proto);
 428   sc->proto = NULL;
 429 }