src/math/percentiles.h

   1 /* PSPP - A program for statistical analysis . -*-c-*-
   2
   3 Copyright (C) 2004 Free Software Foundation, Inc.
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License as
   7 published by the Free Software Foundation; either version 2 of the
   8 License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful, but
  11 WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18 02110-1301, USA. */
  19
  20 #ifndef PERCENTILES_H
  21 #define PERCENTILES_H
  22
  23
  24 #include <libpspp/hash.h>
  25
  26 struct weighted_value ;
  27
  28 /* The algorithm used to calculate percentiles */
  29 enum pc_alg {
  30   PC_NONE=0,
  31   PC_HAVERAGE,
  32   PC_WAVERAGE,
  33   PC_ROUND,
  34   PC_EMPIRICAL,
  35   PC_AEMPIRICAL
  36 } ;
  37
  38
  39
  40 extern  const char *const ptile_alg_desc[];
  41
  42
  43
  44
  45 struct percentile {
  46
  47   /* The break point of the percentile */
  48   double p;
  49
  50   /* The value of the percentile */
  51   double v;
  52 };
  53
  54
  55 /* Calculate the percentiles of the break points in pc_bp,
  56    placing the values in pc_val.
  57    wv is  a sorted array of weighted values of the data set.
  58 */
  59 void ptiles(struct hsh_table *pc_hash,
  60             const struct weighted_value **wv,
  61             int n_data,
  62             double w,
  63             enum pc_alg algorithm);
  64
  65
  66 /* Calculate Tukey's Hinges and the Whiskers for the box plot*/
  67 void tukey_hinges(const struct weighted_value **wv,
  68                   int n_data,
  69                   double w,
  70                   double hinges[3]);
  71
  72
  73
  74 /* Hash utility functions */
  75 int ptile_compare(const struct percentile *p1,
  76                    const struct percentile *p2,
  77                    void *aux);
  78
  79 unsigned ptile_hash(const struct percentile *p, void *aux);
  80
  81
  82 #endif