Change license from GPLv2+ to GPLv3+.
[pspp-builds.git] / src / data / case.h
index bdb68dc65b55617a463fe0ca6ab10a9892d9327b..10963a6e7bbe8cd211843e5b00e12d4e0f22c228 100644 (file)
-/* PSPP - computes sample statistics.
-   Copyright (C) 2004 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2004, 2007 Free Software Foundation, Inc.
 
-   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/>. */
 
 #ifndef HEADER_CASE
 #define HEADER_CASE
 
+#include <limits.h>
 #include <stddef.h>
 #include <stdbool.h>
 #include "value.h"
 
+struct variable;
+
+/* A count of cases or the index of a case within a collection of
+   them. */
+#define CASENUMBER_MAX LONG_MAX
+typedef long int casenumber;
+
 /* Opaque structure that represents a case.  Use accessor
    functions instead of accessing any members directly.  Use
    case_move() or case_clone() instead of copying.  */
-struct ccase 
+struct ccase
   {
     struct case_data *case_data;        /* Actual data. */
-#if DEBUGGING
-    struct ccase *this;                 /* Detects unauthorized move/copy. */
-#endif
-  };
-
-/* Invisible to user code. */
-struct case_data
-  {
-    size_t value_cnt;                   /* Number of values. */
-    unsigned ref_cnt;                   /* Reference count. */
-    union value values[1];              /* Values. */
   };
 
-#ifdef DEBUGGING
-#define CASE_INLINE
-#else
-#define CASE_INLINE static
-#endif
-
-CASE_INLINE void case_nullify (struct ccase *);
-CASE_INLINE int case_is_null (const struct ccase *);
+void case_nullify (struct ccase *);
+bool case_is_null (const struct ccase *);
 
 void case_create (struct ccase *, size_t value_cnt);
-CASE_INLINE void case_clone (struct ccase *, const struct ccase *);
-CASE_INLINE void case_move (struct ccase *, struct ccase *);
-CASE_INLINE void case_destroy (struct ccase *);
+void case_clone (struct ccase *, const struct ccase *);
+void case_move (struct ccase *, struct ccase *);
+void case_destroy (struct ccase *);
+
+size_t case_get_value_cnt (const struct ccase *);
 
-void case_resize (struct ccase *, size_t old_cnt, size_t new_cnt);
+void case_resize (struct ccase *, size_t new_cnt);
 void case_swap (struct ccase *, struct ccase *);
 
-int case_try_create (struct ccase *, size_t value_cnt);
-int case_try_clone (struct ccase *, const struct ccase *);
+bool case_try_create (struct ccase *, size_t value_cnt);
+bool case_try_clone (struct ccase *, const struct ccase *);
 
-CASE_INLINE void case_copy (struct ccase *dst, size_t dst_idx,
-                            const struct ccase *src, size_t src_idx,
-                            size_t cnt);
+void case_copy (struct ccase *dst, size_t dst_idx,
+                const struct ccase *src, size_t src_idx,
+                size_t cnt);
 
-CASE_INLINE void case_to_values (const struct ccase *, union value *, size_t);
-CASE_INLINE void case_from_values (struct ccase *,
-                                   const union value *, size_t);
+void case_copy_out (const struct ccase *,
+                       size_t start_idx, union value *, size_t value_cnt);
+void case_copy_in (struct ccase *,
+                       size_t start_idx, const union value *, size_t value_cnt);
 
-CASE_INLINE const union value *case_data (const struct ccase *, size_t idx);
-CASE_INLINE double case_num (const struct ccase *, size_t idx);
-CASE_INLINE const char *case_str (const struct ccase *, size_t idx);
+const union value *case_data (const struct ccase *, const struct variable *);
+double case_num (const struct ccase *, const struct variable *);
+const char *case_str (const struct ccase *, const struct variable *);
+union value *case_data_rw (struct ccase *, const struct variable *);
 
-CASE_INLINE union value *case_data_rw (struct ccase *, size_t idx);
+const union value *case_data_idx (const struct ccase *, size_t idx);
+double case_num_idx (const struct ccase *, size_t idx);
+const char *case_str_idx (const struct ccase *, size_t idx);
+union value *case_data_rw_idx (struct ccase *, size_t idx);
 
-struct variable;
 int case_compare (const struct ccase *, const struct ccase *,
-                  struct variable *const *, size_t var_cnt);
+                  const struct variable *const *, size_t var_cnt);
 int case_compare_2dict (const struct ccase *, const struct ccase *,
-                        struct variable *const *, struct variable *const *,
+                        const struct variable *const *,
+                       const struct variable *const *,
                         size_t var_cnt);
 
 const union value *case_data_all (const struct ccase *);
 union value *case_data_all_rw (struct ccase *);
 
-void case_unshare (struct ccase *);
-
-#ifndef DEBUGGING
-#include <stdlib.h>
-#include <libpspp/str.h>
-
-static inline void
-case_nullify (struct ccase *c) 
-{
-  c->case_data = NULL;
-}
-
-static inline int
-case_is_null (const struct ccase *c) 
-{
-  return c->case_data == NULL;
-}
-
-static inline void
-case_clone (struct ccase *clone, const struct ccase *orig)
-{
-  *clone = *orig;
-  orig->case_data->ref_cnt++;
-}
-
-static inline void
-case_move (struct ccase *dst, struct ccase *src) 
-{
-  *dst = *src;
-  src->case_data = NULL;
-}
-
-static inline void
-case_destroy (struct ccase *c) 
-{
-  struct case_data *cd = c->case_data;
-  if (cd != NULL && --cd->ref_cnt == 0)
-    free (cd);
-}
-
-static inline void
-case_copy (struct ccase *dst, size_t dst_idx,
-           const struct ccase *src, size_t src_idx,
-           size_t value_cnt) 
-{
-  if (dst->case_data->ref_cnt > 1)
-    case_unshare (dst);
-  if (dst->case_data != src->case_data || dst_idx != src_idx) 
-    memmove (dst->case_data->values + dst_idx,
-             src->case_data->values + src_idx,
-             sizeof *dst->case_data->values * value_cnt); 
-}
-
-static inline void
-case_to_values (const struct ccase *c, union value *output,
-                size_t output_size ) 
-{
-  memcpy (output, c->case_data->values,
-          output_size * sizeof *output);
-}
-
-static inline void
-case_from_values (struct ccase *c, const union value *input,
-                  size_t input_size UNUSED) 
-{
-  if (c->case_data->ref_cnt > 1)
-    case_unshare (c);
-  memcpy (c->case_data->values, input,
-          c->case_data->value_cnt * sizeof *input);
-}
-
-static inline const union value *
-case_data (const struct ccase *c, size_t idx) 
-{
-  return &c->case_data->values[idx];
-}
-
-static inline double
-case_num (const struct ccase *c, size_t idx) 
-{
-  return c->case_data->values[idx].f;
-}
-
-static inline const char *
-case_str (const struct ccase *c, size_t idx)
-{
-  return c->case_data->values[idx].s;
-}
-
-static inline union value *
-case_data_rw (struct ccase *c, size_t idx)
-{
-  if (c->case_data->ref_cnt > 1)
-    case_unshare (c);
-  return &c->case_data->values[idx];
-}
-#endif /* !DEBUGGING */
-
 #endif /* case.h */