src/data/subcase.h

   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 #ifndef DATA_SUBCASE_H
  18 #define DATA_SUBCASE_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22
  23 struct ccase;
  24 union value;
  25 struct variable;
  26
  27 /* Sort order. */
  28 enum subcase_direction
  29   {
  30     SC_ASCEND,                  /* A, B, C, ..., X, Y, Z. */
  31     SC_DESCEND                  /* Z, Y, X, ..., C, B, A. */
  32   };
  33
  34 /* A value within a case. */
  35 struct subcase_field
  36   {
  37     size_t case_index;          /* Starting position in the case. */
  38     int width;                  /* 0=numeric, otherwise string width. */
  39     enum subcase_direction direction; /* Sort order. */
  40   };
  41
  42 /* A subcase specifies how to draw values from a case. */
  43 struct subcase
  44   {
  45     struct subcase_field *fields;
  46     size_t n_fields;
  47
  48     struct caseproto *proto;    /* Created lazily. */
  49   };
  50
  51 void subcase_init_empty (struct subcase *);
  52 void subcase_init_vars (struct subcase *,
  53                         const struct variable *const *, size_t n_vars);
  54 void subcase_init_var (struct subcase *,
  55                        const struct variable *, enum subcase_direction);
  56 void subcase_init (struct subcase *, int index, int width,
  57                    enum subcase_direction);
  58
  59 void subcase_clone (struct subcase *, const struct subcase *);
  60 void subcase_clear (struct subcase *);
  61 void subcase_destroy (struct subcase *);
  62
  63 bool subcase_contains (const struct subcase *, int case_index);
  64 bool subcase_contains_var (const struct subcase *, const struct variable *);
  65
  66 bool subcase_add (struct subcase *, int case_index, int width,
  67                   enum subcase_direction direction);
  68 bool subcase_add_var (struct subcase *, const struct variable *,
  69                       enum subcase_direction);
  70
  71 void subcase_add_always (struct subcase *sc, int case_index, int width,
  72                          enum subcase_direction direction);
  73 void subcase_add_var_always (struct subcase *, const struct variable *,
  74                              enum subcase_direction);
  75 void subcase_add_vars_always (struct subcase *,
  76                               const struct variable *const *, size_t n_vars);
  77 void subcase_add_proto_always (struct subcase *, const struct caseproto *);
  78
  79 const struct caseproto *subcase_get_proto (const struct subcase *);
  80
  81 static inline bool subcase_is_empty (const struct subcase *);
  82 static inline size_t subcase_get_n_fields (const struct subcase *);
  83
  84 static inline size_t subcase_get_case_index (const struct subcase *,
  85                                              size_t idx);
  86 static inline enum subcase_direction subcase_get_direction (
  87   const struct subcase *, size_t idx);
  88
  89 bool subcase_conformable (const struct subcase *, const struct subcase *);
  90
  91 void subcase_extract (const struct subcase *, const struct ccase *,
  92                       union value *values);
  93 void subcase_inject (const struct subcase *,
  94                      const union value *values, struct ccase *);
  95 void subcase_copy (const struct subcase *src_sc, const struct ccase *src,
  96                    const struct subcase *dst_sc, struct ccase *dst);
  97
  98 int subcase_compare_3way (const struct subcase *a_sc, const struct ccase *a,
  99                           const struct subcase *b_sc, const struct ccase *b);
 100 int subcase_compare_3way_xc (const struct subcase *,
 101                              const union value *a, const struct ccase *b);
 102 int subcase_compare_3way_cx (const struct subcase *,
 103                              const struct ccase *a, const union value *b);
 104 int subcase_compare_3way_xx (const struct subcase *,
 105                              const union value *a, const union value *b);
 106 bool subcase_equal (const struct subcase *a_sc, const struct ccase *a,
 107                     const struct subcase *b_sc, const struct ccase *b);
 108 bool subcase_equal_xc (const struct subcase *,
 109                        const union value *a, const struct ccase *b);
 110 bool subcase_equal_cx (const struct subcase *,
 111                        const struct ccase *a, const union value *b);
 112 bool subcase_equal_xx (const struct subcase *,
 113                        const union value *a, const union value *b);
 114
 115 static inline size_t
 116 subcase_get_case_index (const struct subcase *sc, size_t idx)
 117 {
 118   return sc->fields[idx].case_index;
 119 }
 120
 121 static inline enum subcase_direction
 122 subcase_get_direction (const struct subcase *sc, size_t idx)
 123 {
 124   return sc->fields[idx].direction;
 125 }
 126
 127 static inline bool
 128 subcase_is_empty (const struct subcase *sc)
 129 {
 130   return sc->n_fields == 0;
 131 }
 132
 133 static inline size_t
 134 subcase_get_n_fields (const struct subcase *sc)
 135 {
 136   return sc->n_fields;
 137 }
 138
 139 #endif /* data/subcase.h */