X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fmath%2Fcategoricals.h;h=cd887f096e06646596c25dc2be75aa8ffcbacdff;hb=fd67f363f5d62b390abe6817b629e8505b8bd709;hp=044722eed61cdfb96fac4eeb177982baeef24658;hpb=2a02ce128ba2c77fd003e81195730de4f82d3baa;p=pspp

diff --git a/src/math/categoricals.h b/src/math/categoricals.h
index 044722eed6..cd887f096e 100644
--- a/src/math/categoricals.h
+++ b/src/math/categoricals.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+   Copyright (C) 2009, 2010, 2011 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
@@ -19,7 +19,7 @@
 #define _CATEGORICALS__
 
 #include <stddef.h>
-#include <data/missing-values.h>
+#include "data/missing-values.h"
 
 struct categoricals;
 struct variable;
@@ -61,11 +61,21 @@ size_t categoricals_total (const struct categoricals *cat);
 */
 size_t categoricals_get_n_variables (const struct categoricals *cat);
 
+
+/*
+  Must be called (once) before any call to the *_by_subscript or *_by_category
+  functions, but AFTER any calls to categoricals_update 
+*/
 void categoricals_done (const struct categoricals *cat);
 
-const struct variable * categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript);
 
-const union value * categoricals_get_value_by_subscript (const struct categoricals *cat, int subscript);
+/*
+  The *_by_subscript functions use the short map.
+  Their intended use is by covariance matrix routines, where normally 1 less than 
+  the total number of distinct values of each categorical variable should
+  be considered.
+ */
+const struct variable * categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript);
 
 double categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript);
 
@@ -74,9 +84,13 @@ double categoricals_get_sum_by_subscript (const struct categoricals *cat, int su
 double categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
 					     const struct ccase *c);
 
-void * categoricals_get_user_data_by_subscript (const struct categoricals *cat, int subscript);
 
+/* These use the long map.  Useful for descriptive statistics. */
+
+/* Return the value corresponding to the N'th category */
+const union value * categoricals_get_value_by_category (const struct categoricals *cat, int n);
 
+void * categoricals_get_user_data_by_category (const struct categoricals *cat, int category);