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
  32 struct moments1;
  33
  34 struct metrics
  35 {
  36   double n;
  37
  38   double n_missing;
  39
  40   double min;
  41
  42   double max;
  43
  44   double mean;
  45
  46   double se_mean;
  47
  48   double var;
  49
  50   double stddev;
  51
  52   struct moments1 *moments;
  53
  54   gsl_histogram *histogram;
  55
  56   double skewness;
  57   double kurtosis;
  58
  59   double trimmed_mean;
  60
  61   /* A hash of data for this factor.
  62    */
  63   struct hsh_table *ordered_data;
  64
  65   /* A Pointer to this hash table AFTER it has been SORTED and crunched */
  66   struct weighted_value **wvp;
  67
  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
  75
  76
  77
  78 void metrics_precalc(struct metrics *m);
  79
  80 void metrics_calc(struct metrics *m, const union value *f, double weight,
  81                   int case_no);
  82
  83 void metrics_postcalc(struct metrics *m);
  84
  85
  86 /* Linked list of case nos */
  87 struct case_node
  88 {
  89   int num;
  90   struct case_node *next;
  91 };
  92
  93 struct weighted_value
  94 {
  95   union value v;
  96
  97   /* The weight */
  98   double w;
  99
 100   /* The cumulative weight */
 101   double cc;
 102
 103   /* The rank */
 104   double rank;
 105
 106   /* Linked list of cases nos which have this value */
 107   struct case_node *case_nos;
 108
 109 };
 110
 111
 112 struct weighted_value *weighted_value_create(void);
 113
 114 void weighted_value_free(struct weighted_value *wv);
 115
 116
 117
 118 struct factor_statistics {
 119
 120   /* The values of the independent variables */
 121   union value id[2];
 122
 123   /* The an array stats for this factor, one for each dependent var */
 124   struct metrics *m;
 125
 126 };
 127
 128
 129 /* Create a factor statistics object with for N dependent vars
 130    and ID as the value of the independent variable */
 131 struct factor_statistics *
 132 create_factor_statistics (int n, union value *id0, union value *id1);
 133
 134
 135 void factor_statistics_free(struct factor_statistics *f);
 136
 137
 138 /* Compare f0 and f1.
 139    width is the width of the independent variable */
 140 int
 141 factor_statistics_compare(const struct factor_statistics *f0,
 142                           const struct factor_statistics *f1, int width);
 143
 144
 145
 146 unsigned int
 147 factor_statistics_hash(const struct factor_statistics *f, int width);
 148
 149 #endif