src/factor_stats.h

   1 /* PSPP - A program for statistical analysis . -*-c-*-
   2
   3 Copyright (C) 2004 Free Software Foundation, Inc.
   4 Author: John Darrington 2004
   5
   6 This program is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU General Public License as
   8 published by the Free Software Foundation; either version 2 of the
   9 License, or (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA. */
  20
  21 #ifndef FACTOR_STATS
  22 #define FACTOR_STATS
  23
  24
  25 /* FIXME: These things should probably be amalgamated with the
  26    group_statistics struct */
  27
  28 #include "hash.h"
  29 #include "val.h"
  30 #include <gsl/gsl_histogram.h>
  31 #include "subclist.h"
  32 #include "percentiles.h"
  33
  34 struct moments1;
  35
  36 struct metrics
  37 {
  38   double n;
  39
  40   double n_missing;
  41
  42   double min;
  43
  44   double max;
  45
  46   double mean;
  47
  48   double se_mean;
  49
  50   double var;
  51
  52   double stddev;
  53
  54   struct moments1 *moments;
  55
  56   gsl_histogram *histogram;
  57
  58   double skewness;
  59   double kurtosis;
  60
  61   double trimmed_mean;
  62
  63   /* A hash of data for this factor. */
  64   struct hsh_table *ordered_data;
  65
  66   /* A Pointer to this hash table AFTER it has been SORTED and crunched */
  67   struct weighted_value **wvp;
  68
  69   /* The number of values in the above array
  70      (if all the weights are 1, then this will
  71      be the same as n) */
  72   int n_data;
  73
  74   /* Percentile stuff */
  75
  76   /* A hash of struct percentiles */
  77   struct hsh_table *ptile_hash;
  78
  79   /* Algorithm to be used for calculating percentiles */
  80   enum pc_alg ptile_alg;
  81
  82   /* Tukey's Hinges */
  83   double hinges[3];
  84
  85 };
  86
  87
  88
  89
  90 void metrics_precalc(struct metrics *m);
  91
  92 void metrics_calc(struct metrics *m, const union value *f, double weight,
  93                   int case_no);
  94
  95 void metrics_postcalc(struct metrics *m);
  96
  97
  98 /* Linked list of case nos */
  99 struct case_node
 100 {
 101   int num;
 102   struct case_node *next;
 103 };
 104
 105 struct weighted_value
 106 {
 107   union value v;
 108
 109   /* The weight */
 110   double w;
 111
 112   /* The cumulative weight */
 113   double cc;
 114
 115   /* The rank */
 116   double rank;
 117
 118   /* Linked list of cases nos which have this value */
 119   struct case_node *case_nos;
 120
 121 };
 122
 123
 124 struct weighted_value *weighted_value_create(void);
 125
 126 void weighted_value_free(struct weighted_value *wv);
 127
 128
 129
 130 struct factor_statistics {
 131
 132   /* The values of the independent variables */
 133   union value id[2];
 134
 135   /* The an array stats for this factor, one for each dependent var */
 136   struct metrics *m;
 137
 138 };
 139
 140
 141 /* Create a factor statistics object with for N dependent vars
 142    and ID as the value of the independent variable */
 143 struct factor_statistics *
 144 create_factor_statistics (int n, union value *id0, union value *id1);
 145
 146
 147 void factor_statistics_free(struct factor_statistics *f);
 148
 149
 150 /* Compare f0 and f1.
 151    width is the width of the independent variable */
 152 int
 153 factor_statistics_compare(const struct factor_statistics *f0,
 154                           const struct factor_statistics *f1, int width);
 155
 156
 157
 158 unsigned int
 159 factor_statistics_hash(const struct factor_statistics *f, int width);
 160
 161 #endif