8d8e47067eedd7ad5a3dbb70917ea4e00a3ed646
[pspp-builds.git] / src / data / vector.c
1 /* PSPP - computes sample statistics.
2    Copyright (C) 2006  Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or
5    modify it under the terms of the GNU General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful, but
10    WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    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, write to the Free Software
16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17    02110-1301, USA. */
18
19 #include <config.h>
20 #include "vector.h"
21
22 #include "dictionary.h"
23
24 #include <libpspp/assertion.h>
25 #include <libpspp/str.h>
26
27 #include "xalloc.h"
28
29 /* Vector of variables. */
30 struct vector
31   {
32     char name[LONG_NAME_LEN + 1];       /* Name. */
33     struct variable **vars;             /* Set of variables. */
34     size_t var_cnt;                     /* Number of variables. */
35   };
36
37 /* Checks that all the variables in VECTOR have consistent
38    width. */
39 static void
40 check_widths (const struct vector *vector)
41 {
42   int width = var_get_width (vector->vars[0]);
43   size_t i;
44
45   for (i = 1; i < vector->var_cnt; i++)
46     assert (width == var_get_width (vector->vars[i]));
47 }
48
49 /* Creates and returns a new vector with the given NAME
50    that contains the VAR_CNT variables in VARS.
51    All variables in VARS must have the same type and width. */
52 struct vector *
53 vector_create (const char *name,
54                struct variable **vars, size_t var_cnt)
55 {
56   struct vector *vector = xmalloc (sizeof *vector);
57
58   assert (var_cnt > 0);
59   assert (var_is_plausible_name (name, false));
60   str_copy_trunc (vector->name, sizeof vector->name, name);
61
62   vector->vars = xmemdup (vars, var_cnt * sizeof *vector->vars);
63   vector->var_cnt = var_cnt;
64   check_widths (vector);
65
66   return vector;
67 }
68
69 /* Creates and returns a new vector as a clone of OLD, but that
70    contains variables from NEW_DICT that are in the same position
71    as those in OLD are in OLD_DICT.
72    All variables in the new vector must have the same type and
73    width. */
74 struct vector *
75 vector_clone (const struct vector *old,
76               const struct dictionary *old_dict,
77               const struct dictionary *new_dict)
78 {
79   struct vector *new = xmalloc (sizeof *new);
80   size_t i;
81
82   strcpy (new->name, old->name);
83
84   new->vars = xnmalloc (old->var_cnt, sizeof *new->vars);
85   new->var_cnt = old->var_cnt;
86   for (i = 0; i < new->var_cnt; i++)
87     {
88       assert (dict_contains_var (old_dict, old->vars[i]));
89       new->vars[i] = dict_get_var (new_dict,
90                                    var_get_dict_index (old->vars[i]));
91     }
92   check_widths (new);
93
94   return new;
95 }
96
97 /* Destroys VECTOR. */
98 void
99 vector_destroy (struct vector *vector)
100 {
101   free (vector->vars);
102   free (vector);
103 }
104
105 /* Returns VECTOR's name. */
106 const char *
107 vector_get_name (const struct vector *vector)
108 {
109   return vector->name;
110 }
111
112 /* Returns the type of the variables in VECTOR. */
113 enum var_type vector_get_type (const struct vector *vector)
114 {
115   return var_get_type (vector->vars[0]);
116 }
117
118 /* Returns the variable in VECTOR with the given INDEX. */
119 struct variable *
120 vector_get_var (const struct vector *vector, size_t index)
121 {
122   assert (index < vector->var_cnt);
123   return vector->vars[index];
124 }
125
126 /* Returns the number of variables in VECTOR. */
127 size_t
128 vector_get_var_cnt (const struct vector *vector)
129 {
130   return vector->var_cnt;
131 }
132
133 /* Compares two pointers to vectors represented by A and B and
134    returns a strcmp()-type result. */
135 int
136 compare_vector_ptrs_by_name (const void *a_, const void *b_)
137 {
138   struct vector *const *pa = a_;
139   struct vector *const *pb = b_;
140   struct vector *a = *pa;
141   struct vector *b = *pb;
142
143   return strcasecmp (a->name, b->name);
144 }
145