basis/math/statistics/statistics.factor

   1 ! Copyright (C) 2008 Doug Coleman, Michael Judge.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: assocs combinators generalizations kernel locals math
   4 math.functions math.order math.vectors sequences
   5 sequences.private sorting fry arrays grouping sets ;
   6 IN: math.statistics
   7
   8 : mean ( seq -- x )
   9     [ sum ] [ length ] bi / ;
  10
  11 : geometric-mean ( seq -- x )
  12     [ length ] [ product ] bi nth-root ;
  13
  14 : harmonic-mean ( seq -- x )
  15     [ recip ] map-sum recip ;
  16
  17 : contraharmonic-mean ( seq -- x )
  18     [ [ sq ] map-sum ] [ sum ] bi / ;
  19
  20 <PRIVATE
  21
  22 :: ((kth-object)) ( seq k nth-quot exchange-quot quot: ( x y -- ? ) -- elt )
  23     #! Wirth's method, Algorithm's + Data structues = Programs p. 84
  24     #! The algorithm modifiers seq, so we clone it
  25     k seq bounds-check 2drop
  26     0 :> i!
  27     0 :> j!
  28     0 :> l!
  29     0 :> x!
  30     seq length 1 - :> m!
  31     [ l m < ]
  32     [
  33         k seq nth x!
  34         l i!
  35         m j!
  36         [ i j <= ]
  37         [
  38             [ i seq nth-quot call x quot call ] [ i 1 + i! ] while
  39             [ x j seq nth-quot call quot call ] [ j 1 - j! ] while
  40             i j <= [
  41                 i j seq exchange-quot call
  42                 i 1 + i!
  43                 j 1 - j!
  44             ] when
  45         ] do while
  46
  47         j k < [ i l! ] when
  48         k i < [ j m! ] when
  49     ] while
  50     k seq nth ; inline
  51
  52 : (kth-object) ( seq k nth-quot exchange-quot quot: ( x y -- ? ) -- elt )
  53     [ clone ] 4dip ((kth-object)) ; inline
  54
  55 : kth-object-unsafe ( seq k quot: ( x y -- ? ) -- elt )
  56     [ [ nth-unsafe ] [ exchange-unsafe ] ] dip (kth-object) ; inline
  57
  58 : kth-objects-unsafe ( seq kths quot: ( x y -- ? ) -- elts )
  59     [ clone ] 2dip
  60     '[ [ nth-unsafe ] [ exchange-unsafe ]  _ ((kth-object)) ] with map ; inline
  61
  62 PRIVATE>
  63
  64 : kth-object ( seq k quot: ( x y -- ? ) -- elt )
  65     [ [ nth ] [ exchange ] ] dip (kth-object) ; inline
  66
  67 : kth-objects ( seq kths quot: ( x y -- ? ) -- elts )
  68     [ clone ] 2dip
  69     '[ [ nth ] [ exchange ]  _ ((kth-object)) ] with map ; inline
  70
  71 : kth-smallests ( seq kths -- elts ) [ < ] kth-objects-unsafe ;
  72
  73 : kth-smallest ( seq k -- elt ) [ < ] kth-object-unsafe ;
  74
  75 : kth-largests ( seq kths -- elts ) [ > ] kth-objects-unsafe ;
  76
  77 : kth-largest ( seq k -- elt ) [ > ] kth-object-unsafe ;
  78
  79 : count-relative ( seq k -- lt eq gt )
  80     [ 0 0 0 ] 2dip '[
  81         _ <=> {
  82             { +lt+ [ [ 1 + ] 2dip ] }
  83             { +gt+ [ 1 + ] }
  84             { +eq+ [ [ 1 + ] dip ] }
  85         } case
  86     ] each ;
  87
  88 : minmax-relative ( seq k -- lt eq gt lt-max gt-min )
  89     [ 0 0 0 -1/0. 1/0. ] 2dip '[
  90         dup _ <=> {
  91             { +lt+ [ [ 1 + ] 5 ndip '[ _ max ] dip ] }
  92             { +gt+ [ [ 1 + ] 3dip min ] }
  93             { +eq+ [ [ 1 + ] 4dip drop ] }
  94         } case
  95     ] each ;
  96
  97 : lower-median-index ( seq -- n )
  98     [ midpoint@ ]
  99     [ length odd? [ 1 - ] unless ] bi ;
 100
 101 : lower-median ( seq -- elt )
 102     [ ] [ lower-median-index ] bi kth-smallest ;
 103
 104 : upper-median ( seq -- elt )
 105     dup midpoint@ kth-smallest ;
 106
 107 : medians ( seq -- lower upper )
 108     [ ]
 109     [ [ lower-median-index ] [ midpoint@ ] bi 2array ]
 110     bi kth-smallests first2 ;
 111
 112 : median ( seq -- x )
 113     dup length odd?
 114     [ lower-median ] [ medians + 2 / ] if ;
 115
 116 ! quantile can be any n-tile. quartile is n = 4, percentile is n = 100
 117 ! a,b,c,d parameters, N - number of samples, q is quantile (1/2 for median, 1/4 for 1st quartile)
 118 ! http://mathworld.wolfram.com/Quantile.html
 119 ! a + (N + b) q - 1
 120 ! could subtract 1 from a
 121
 122 : quantile-x ( a b N q -- x )
 123     [ + ] dip * + 1 - ; inline
 124
 125 ! 2+1/4 frac is 1/4
 126 : frac ( x -- x' )
 127     >fraction [ /mod nip ] keep / ; inline
 128
 129 :: quantile-indices ( seq qs a b c d -- seq )
 130     qs [ [ a b seq length ] dip quantile-x ] map ;
 131
 132 :: qabcd ( y-floor y-ceiling x c d -- qabcd )
 133     y-floor y-ceiling y-floor - c d x frac * + * + ;
 134
 135 :: quantile-abcd ( seq qs a b c d -- quantile )
 136     seq qs a b c d quantile-indices :> indices
 137     indices [ [ floor ] [ ceiling ] bi 2array ] map
 138     concat :> index-pairs
 139
 140     seq index-pairs kth-smallests
 141     2 group indices [ [ first2 ] dip c d qabcd ] 2map ;
 142
 143 : quantile1 ( seq qs -- seq' )
 144     0 0 1 0 quantile-abcd ;
 145
 146 : quantile3 ( seq qs -- seq' )
 147     1/2 0 0 0 quantile-abcd ;
 148
 149 : quantile4 ( seq qs -- seq' )
 150     0 0 0 1 quantile-abcd ;
 151
 152 : quantile5 ( seq qs -- seq' )
 153     1/2 0 0 1 quantile-abcd ;
 154
 155 : quantile6 ( seq qs -- seq' )
 156     0 1 0 1 quantile-abcd ;
 157
 158 : quantile7 ( seq qs -- seq' )
 159     1 -1 0 1 quantile-abcd ;
 160
 161 : quantile8 ( seq qs -- seq' )
 162     1/3 1/3 0 1 quantile-abcd ;
 163
 164 : quantile9 ( seq qs -- seq' )
 165     3/8 1/4 0 1 quantile-abcd ;
 166
 167 : quartile ( seq -- seq' )
 168     { 1/4 1/2 3/4 } quantile5 ;
 169
 170 <PRIVATE
 171
 172 : (sequence>assoc) ( seq map-quot: ( x -- ..y ) insert-quot: ( ..y assoc -- ) assoc -- assoc )
 173     [ swap curry compose each ] keep ; inline
 174
 175 PRIVATE>
 176
 177 : sequence>assoc! ( assoc seq map-quot: ( x -- ..y ) insert-quot: ( ..y assoc -- ) -- assoc )
 178     4 nrot (sequence>assoc) ; inline
 179
 180 : sequence>assoc ( seq map-quot: ( x -- ..y ) insert-quot: ( ..y assoc -- ) exemplar -- assoc )
 181     clone (sequence>assoc) ; inline
 182
 183 : sequence>hashtable ( seq map-quot: ( x -- ..y ) insert-quot: ( ..y assoc -- ) -- hashtable )
 184     H{ } sequence>assoc ; inline
 185
 186 : histogram! ( hashtable seq -- hashtable )
 187     [ ] [ inc-at ] sequence>assoc! ;
 188
 189 : histogram-by ( seq quot: ( x -- bin ) -- hashtable )
 190     [ inc-at ] sequence>hashtable ; inline
 191
 192 : histogram ( seq -- hashtable )
 193     [ ] histogram-by ;
 194
 195 : sorted-histogram ( seq -- alist )
 196     histogram sort-values ;
 197
 198 : collect-pairs ( seq quot: ( x -- v k ) -- hashtable )
 199     [ push-at ] sequence>hashtable ; inline
 200
 201 : collect-by ( seq quot: ( x -- x' ) -- hashtable )
 202     [ dup ] prepose collect-pairs ; inline
 203
 204 : mode ( seq -- x )
 205     histogram >alist
 206     [ ] [ [ [ second ] bi@ > ] most ] map-reduce first ;
 207
 208 ERROR: empty-sequence ;
 209
 210 : minmax ( seq -- min max )
 211     [
 212         empty-sequence
 213     ] [
 214         [ first dup ] keep [ [ min ] [ max ] bi-curry bi* ] each
 215     ] if-empty ;
 216
 217 : range ( seq -- x )
 218     minmax swap - ;
 219
 220 : sample-var ( seq -- x )
 221     #! normalize by N-1
 222     dup length 1 <= [
 223         drop 0
 224     ] [
 225         [ [ mean ] keep [ - sq ] with map-sum ]
 226         [ length 1 - ] bi /
 227     ] if ;
 228
 229 : full-var ( seq -- x )
 230     dup length 1 <= [
 231         drop 0
 232     ] [
 233         [ [ mean ] keep [ - sq ] with map-sum ]
 234         [ length ] bi /
 235     ] if ;
 236
 237 ALIAS: var sample-var
 238
 239 : sample-std ( seq -- x ) sample-var sqrt ;
 240
 241 : full-std ( seq -- x ) full-var sqrt ;
 242
 243 ALIAS: std sample-std
 244
 245 : mean-dev ( seq -- x ) dup mean v-n vabs mean ;
 246
 247 : median-dev ( seq -- x ) dup median v-n vabs mean ;
 248
 249 : sample-ste ( seq -- x ) [ sample-std ] [ length ] bi sqrt / ;
 250
 251 : full-ste ( seq -- x ) [ full-std ] [ length ] bi sqrt / ;
 252
 253 ALIAS: ste sample-ste
 254
 255 : ((r)) ( mean(x) mean(y) {x} {y} -- (r) )
 256     ! finds sigma((xi-mean(x))(yi-mean(y))
 257     0 [ [ [ pick ] dip swap - ] bi@ * + ] 2reduce 2nip ;
 258
 259 : (r) ( mean(x) mean(y) {x} {y} sx sy -- r )
 260     * recip [ [ ((r)) ] keep length 1 - / ] dip * ;
 261
 262 : [r] ( {{x,y}...} -- mean(x) mean(y) {x} {y} sx sy )
 263     first2 [ [ [ mean ] bi@ ] 2keep ] 2keep [ std ] bi@ ;
 264
 265 : r ( {{x,y}...} -- r )
 266     [r] (r) ;
 267
 268 : r^2 ( {{x,y}...} -- r )
 269     r sq ;
 270
 271 : least-squares ( {{x,y}...} -- alpha beta )
 272     [r] { [ 2dup ] [ ] [ ] [ ] [ ] } spread
 273     ! stack is mean(x) mean(y) mean(x) mean(y) {x} {y} sx sy
 274     [ (r) ] 2keep ! stack is mean(x) mean(y) r sx sy
 275     swap / * ! stack is mean(x) mean(y) beta
 276     [ swapd * - ] keep ;
 277
 278 : cov ( {x} {y} -- cov )
 279     [ dup mean v-n ] bi@ v* mean ;
 280
 281 : sample-corr ( {x} {y} -- corr )
 282      [ cov ] [ [ sample-var ] bi@ * sqrt ] 2bi / ;
 283
 284 : full-corr ( {x} {y} -- corr )
 285      [ cov ] [ [ full-var ] bi@ * sqrt ] 2bi / ;
 286
 287 ALIAS: corr sample-corr
 288
 289 : cum-sum ( seq -- seq' )
 290     0 swap [ + dup ] map nip ;
 291
 292 : cum-product ( seq -- seq' )
 293     1 swap [ * dup ] map nip ;
 294
 295 : cum-min ( seq -- seq' )
 296     [ ?first ] keep [ min dup ] map nip ;
 297
 298 : cum-max ( seq -- seq' )
 299     [ ?first ] keep [ max dup ] map nip ;
 300
 301 : entropy ( seq -- n )
 302     dup members [ [ = ] curry count ] with map
 303     dup sum v/n dup [ log ] map v* sum neg ;
 304
 305 : binary-entropy ( p -- h )
 306     [ dup log * ] [ 1 swap - dup log * ] bi + neg 2 log / ;
 307
 308 : standardize ( u -- v )
 309     [ dup mean v-n ] [ std ] bi v/n ;
 310
 311 : differences ( u -- v )
 312     [ 1 tail-slice ] keep [ - ] 2map ;
 313
 314 : rescale ( u -- v )
 315     [ ] [ infimum ] [ supremum over - ] tri
 316     [ v-n ] [ v/n ] bi* ;