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