#include <data/value.h>
#include <libpspp/hmap.h>
#include <libpspp/pool.h>
+#include <libpspp/array.h>
#include <libpspp/str.h>
struct hmap_node node; /* Node in hash map. */
union value value; /* The value being labeled. */
double cc; /* The total of the weights of cases with this value */
+
+ void *user_data; /* A pointer to data which the caller can store stuff */
+
int subscript; /* A zero based integer, unique within the variable.
Can be used as an index into an array */
};
-
struct var_params
{
/* A map indexed by a union values */
};
+/* Comparison function to sort the reverse_value_map in ascending order */
+static int
+compare_value_node (const void *vn1_, const void *vn2_, const void *aux)
+{
+ const struct value_node * const *vn1 = vn1_;
+ const struct value_node * const *vn2 = vn2_;
+ const struct var_params *vp = aux;
+
+ return value_compare_3way (&(*vn1)->value, &(*vn2)->value, var_get_width (vp->var));
+}
+
+
struct categoricals
{
+ /* The weight variable */
const struct variable *wv;
- size_t n_vars;
/* An array of var_params */
struct var_params *vp;
+ /* The size of VP. (ie, the number of variables involved.) */
+ size_t n_vp;
+
+ /* The number of categorical variables which contain entries.
+ In the absence of missing values, this will be equal to N_VP */
+ size_t n_vars;
+
/* A map to enable the lookup of variables indexed by subscript */
int *reverse_variable_map;
/* Missing values to be excluded */
enum mv_class exclude;
+
+ /* Function to be called on each update */
+ update_func *update;
+
+ /* Function specified by the caller to create user_data */
+ user_data_create_func *user_data_create;
+
+ /* Auxilliary data to be passed to update and user_data_create_func*/
+ void *aux1;
+ void *aux2;
};
categoricals_destroy ( struct categoricals *cat)
{
int i;
- for (i = 0 ; i < cat->n_vars; ++i)
- hmap_destroy (&cat->vp[i].map);
-
- pool_destroy (cat->pool);
- free (cat);
+ if (cat != NULL)
+ {
+ for (i = 0 ; i < cat->n_vp; ++i)
+ hmap_destroy (&cat->vp[i].map);
+
+ pool_destroy (cat->pool);
+ free (cat);
+ }
}
+#if 0
void
categoricals_dump (const struct categoricals *cat)
{
int v;
- for (v = 0 ; v < cat->n_vars; ++v)
+ for (v = 0 ; v < cat->n_vp; ++v)
{
const struct var_params *vp = &cat->vp[v];
const struct hmap *m = &vp->map;
struct hmap_node *node ;
int x;
- printf ("\n%s (%d) CC=%g n_cats=%d:\n", var_get_name (vp->var), vp->base_subscript, vp->cc, vp->n_cats);
+ printf ("\n%s (%d) CC=%g n_cats=%d:\n",
+ var_get_name (vp->var), vp->base_subscript, vp->cc, vp->n_cats);
printf ("Reverse map\n");
for (x = 0 ; x < vp->n_cats; ++x)
for (node = hmap_first (m); node; node = hmap_next (m, node))
{
struct string s;
- ds_init_empty (&s);
const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
+ ds_init_empty (&s);
var_append_value_name (vp->var, &vn->value, &s);
printf ("Value: %s; Index %d; CC %g\n",
ds_cstr (&s),
ds_destroy (&s);
}
}
+
+ assert (cat->n_vars <= cat->n_vp);
+
+ printf ("\n");
+ printf ("Number of categorical variables: %d\n", cat->n_vp);
+ printf ("Number of non-empty categorical variables: %d\n", cat->n_vars);
+ printf ("Total number of categories: %d\n", cat->n_cats_total);
+
+ printf ("\nReverse variable map:\n");
+
+ for (v = 0 ; v < cat->n_cats_total; ++v)
+ printf ("%d ", cat->reverse_variable_map[v]);
+ printf ("\n");
}
+#endif
}
-
struct categoricals *
-categoricals_create (const struct variable **v, size_t n_vars,
- const struct variable *wv, enum mv_class exclude)
+categoricals_create (const struct variable *const *v, size_t n_vars,
+ const struct variable *wv, enum mv_class exclude,
+ user_data_create_func *udf,
+ update_func *update, void *aux1, void *aux2
+ )
{
size_t i;
struct categoricals *cat = xmalloc (sizeof *cat);
- cat->n_vars = n_vars;
+ cat->n_vp = n_vars;
cat->wv = wv;
cat->n_cats_total = 0;
+ cat->n_vars = 0;
cat->reverse_variable_map = NULL;
cat->pool = pool_create ();
cat->exclude = exclude;
+ cat->update = update;
+ cat->user_data_create = udf;
+
+ cat->aux1 = aux1;
+ cat->aux2 = aux2;
- cat->vp = pool_calloc (cat->pool, n_vars, sizeof *cat->vp);
- for (i = 0 ; i < cat->n_vars; ++i)
+ cat->vp = pool_calloc (cat->pool, cat->n_vp, sizeof *cat->vp);
+
+ for (i = 0 ; i < cat->n_vp; ++i)
{
hmap_init (&cat->vp[i].map);
cat->vp[i].var = v[i];
assert (NULL == cat->reverse_variable_map);
- for (i = 0 ; i < cat->n_vars; ++i)
+ for (i = 0 ; i < cat->n_vp; ++i)
{
const struct variable *var = cat->vp[i].var;
unsigned int width = var_get_width (var);
hmap_insert (&cat->vp[i].map, &node->node, hash);
cat->n_cats_total++;
+
+ if ( 0 == cat->vp[i].n_cats)
+ cat->n_vars++;
+
node->subscript = cat->vp[i].n_cats++ ;
+
+ if (cat->user_data_create)
+ node->user_data = cat->user_data_create (cat->aux1, cat->aux2);
}
node->cc += weight;
cat->vp[i].cc += weight;
+
+ if (cat->update)
+ cat->update (node->user_data, cat->exclude, cat->wv, var, c, cat->aux1, cat->aux2);
}
}
}
-/* Return the index for value VAL in the Nth variable */
-int
-categoricals_index (const struct categoricals *cat, size_t n, const union value *val)
-{
- struct value_node *vn = lookup_value (&cat->vp[n].map, cat->vp[n].var, val);
-
- if ( vn == NULL)
- return -1;
-
- return vn->subscript;
-}
-
-
/* Return the total number of categories */
size_t
categoricals_total (const struct categoricals *cat)
*/
int v;
int idx = 0;
- cat->reverse_variable_map = pool_calloc (cat->pool, cat->n_cats_total, sizeof *cat->reverse_variable_map);
+ cat->reverse_variable_map = pool_calloc (cat->pool,
+ cat->n_cats_total,
+ sizeof *cat->reverse_variable_map);
- for (v = 0 ; v < cat->n_vars; ++v)
+ for (v = 0 ; v < cat->n_vp; ++v)
{
int i;
struct var_params *vp = &cat->vp[v];
vp->reverse_value_map[vn->subscript] = vn;
}
+ /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
+ sort (vp->reverse_value_map, vp->n_cats, sizeof (const struct value_node *),
+ compare_value_node, vp);
+
+ /* Populate the reverse variable map.
+ */
for (i = 0; i < vp->n_cats; ++i)
cat->reverse_variable_map[idx++] = v;
}
+
+ assert (cat->n_vars <= cat->n_vp);
+
}
+static int
+reverse_variable_lookup (const struct categoricals *cat, int subscript)
+{
+ assert (cat->reverse_variable_map);
+ assert (subscript >= 0);
+ assert (subscript < cat->n_cats_total);
+
+ return cat->reverse_variable_map[subscript];
+}
+
/* Return the categorical variable corresponding to SUBSCRIPT */
const struct variable *
categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript)
{
- int index;
-
- assert (cat->reverse_variable_map);
-
- index = cat->reverse_variable_map[subscript];
+ int index = reverse_variable_lookup (cat, subscript);
return cat->vp[index].var;
}
-
/* Return the value corresponding to SUBSCRIPT */
const union value *
categoricals_get_value_by_subscript (const struct categoricals *cat, int subscript)
{
- int vindex = cat->reverse_variable_map[subscript];
+ int vindex = reverse_variable_lookup (cat, subscript);
const struct var_params *vp = &cat->vp[vindex];
const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
double
categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
{
- int vindex = cat->reverse_variable_map[subscript];
+ int vindex = reverse_variable_lookup (cat, subscript);
const struct var_params *vp = &cat->vp[vindex];
return vp->cc;
double
categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
{
- int vindex = cat->reverse_variable_map[subscript];
+ int vindex = reverse_variable_lookup (cat, subscript);
const struct var_params *vp = &cat->vp[vindex];
const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
return value_equal (val, categoricals_get_value_by_subscript (cat, subscript), width);
}
+
+
+size_t
+categoricals_get_n_variables (const struct categoricals *cat)
+{
+ return cat->n_vars;
+}
+
+
+
+void *
+categoricals_get_user_data_by_subscript (const struct categoricals *cat, int subscript)
+{
+ int vindex = reverse_variable_lookup (cat, subscript);
+ const struct var_params *vp = &cat->vp[vindex];
+
+ const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
+ return vn->user_data;
+}