Statistics.i

   1 %module "Math::GSL::Statistics"
   2
   3 %include "typemaps.i"
   4 %include "gsl_typemaps.i"
   5
   6 %{
   7     #include "gsl/gsl_statistics_double.h"
   8     #include "gsl/gsl_statistics_int.h"
   9     #include "gsl/gsl_statistics_char.h"
  10 %}
  11
  12 %include "gsl/gsl_statistics_double.h"
  13 %include "gsl/gsl_statistics_int.h"
  14 %include "gsl/gsl_statistics_char.h"
  15
  16
  17 %perlcode %{
  18 @EXPORT_OK = qw/
  19                gsl_stats_mean
  20                gsl_stats_variance
  21                gsl_stats_sd
  22                gsl_stats_variance_with_fixed_mean
  23                gsl_stats_sd_with_fixed_mean
  24                gsl_stats_tss
  25                gsl_stats_tss_m
  26                gsl_stats_absdev
  27                gsl_stats_skew
  28                gsl_stats_kurtosis
  29                gsl_stats_lag1_autocorrelation
  30                gsl_stats_covariance
  31                gsl_stats_correlation
  32                gsl_stats_variance_m
  33                gsl_stats_sd_m
  34                gsl_stats_absdev_m
  35                gsl_stats_skew_m_sd
  36                gsl_stats_kurtosis_m_sd
  37                gsl_stats_lag1_autocorrelation_m
  38                gsl_stats_covariance_m
  39                gsl_stats_wmean
  40                gsl_stats_wvariance
  41                gsl_stats_wsd
  42                gsl_stats_wvariance_with_fixed_mean
  43                gsl_stats_wsd_with_fixed_mean
  44                gsl_stats_wtss
  45                gsl_stats_wtss_m
  46                gsl_stats_wabsdev
  47                gsl_stats_wskew
  48                gsl_stats_wkurtosis
  49                gsl_stats_wvariance_m
  50                gsl_stats_wsd_m
  51                gsl_stats_wabsdev_m
  52                gsl_stats_wskew_m_sd
  53                gsl_stats_wkurtosis_m_sd
  54                gsl_stats_pvariance
  55                gsl_stats_ttest
  56                gsl_stats_max
  57                gsl_stats_min
  58                gsl_stats_minmax
  59                gsl_stats_max_index
  60                gsl_stats_min_index
  61                gsl_stats_minmax_index
  62                gsl_stats_median_from_sorted_data
  63                gsl_stats_quantile_from_sorted_data
  64                /;
  65 our @EXPORT_int = qw/
  66                gsl_stats_int_mean
  67                gsl_stats_int_variance
  68                gsl_stats_int_sd
  69                gsl_stats_int_variance_with_fixed_mean
  70                gsl_stats_int_sd_with_fixed_mean
  71                gsl_stats_int_tss
  72                gsl_stats_int_tss_m
  73                gsl_stats_int_absdev
  74                gsl_stats_int_skew
  75                gsl_stats_int_kurtosis
  76                gsl_stats_int_lag1_autocorrelation
  77                gsl_stats_int_covariance
  78                gsl_stats_int_correlation
  79                gsl_stats_int_variance_m
  80                gsl_stats_int_sd_m
  81                gsl_stats_int_absdev_m
  82                gsl_stats_int_skew_m_sd
  83                gsl_stats_int_kurtosis_m_sd
  84                gsl_stats_int_lag1_autocorrelation_m
  85                gsl_stats_int_covariance_m
  86                gsl_stats_int_pvariance
  87                gsl_stats_int_ttest
  88                gsl_stats_int_max
  89                gsl_stats_int_min
  90                gsl_stats_int_minmax
  91                gsl_stats_int_max_index
  92                gsl_stats_int_min_index
  93                gsl_stats_int_minmax_index
  94                gsl_stats_int_median_from_sorted_data
  95                gsl_stats_int_quantile_from_sorted_data
  96                /;
  97 our @EXPORT_char = qw/
  98                gsl_stats_char_mean
  99                gsl_stats_char_variance
 100                gsl_stats_char_sd
 101                gsl_stats_char_variance_with_fixed_mean
 102                gsl_stats_char_sd_with_fixed_mean
 103                gsl_stats_char_tss
 104                gsl_stats_char_tss_m
 105                gsl_stats_char_absdev
 106                gsl_stats_char_skew
 107                gsl_stats_char_kurtosis
 108                gsl_stats_char_lag1_autocorrelation
 109                gsl_stats_char_covariance
 110                gsl_stats_char_correlation
 111                gsl_stats_char_variance_m
 112                gsl_stats_char_sd_m
 113                gsl_stats_char_absdev_m
 114                gsl_stats_char_skew_m_sd
 115                gsl_stats_char_kurtosis_m_sd
 116                gsl_stats_char_lag1_autocorrelation_m
 117                gsl_stats_char_covariance_m
 118                gsl_stats_char_pvariance
 119                gsl_stats_char_ttest
 120                gsl_stats_char_max
 121                gsl_stats_char_min
 122                gsl_stats_char_minmax
 123                gsl_stats_char_max_index
 124                gsl_stats_char_min_index
 125                gsl_stats_char_minmax_index
 126                gsl_stats_char_median_from_sorted_data
 127                gsl_stats_char_quantile_from_sorted_data
 128              /;
 129 push @EXPORT_OK, @EXPORT_int, @EXPORT_char;
 130 %EXPORT_TAGS = (
 131                 all => \@EXPORT_OK,
 132                 int => \@EXPORT_int,
 133                 char => \@EXPORT_char
 134                );
 135 __END__
 136
 137 =head1 NAME
 138
 139 Math::GSL::Statistics - Statistical functions
 140
 141 =head1 SYNOPSIS
 142
 143 use Math::GSL::Statistics qw /:all/;
 144
 145 =head1 DESCRIPTION
 146
 147 Here is a list of all the functions in this module :
 148
 149 =over 2
 150
 151 =item * C<gsl_stats_mean($data, $stride, $n)> - This function returns the arithmetic mean of the array reference $data, a dataset of length $n with stride $stride. The arithmetic mean, or sample mean, is denoted by \Hat\mu and defined as, \Hat\mu = (1/N) \sum x_i where x_i are the elements of the dataset $data. For samples drawn from a gaussian distribution the variance of \Hat\mu is \sigma^2 / N.
 152
 153 =item * C<gsl_stats_variance($data, $stride, $n)>
 154
 155 =item * C<gsl_stats_sd >
 156
 157 =item * C<gsl_stats_sd_m >
 158
 159 =item * C<gsl_stats_variance_with_fixed_mean >
 160
 161 =item * C<gsl_stats_sd_with_fixed_mean >
 162
 163 =item * C<gsl_stats_tss >
 164
 165 =item * C<gsl_stats_tss_m >
 166
 167 =item * C<gsl_stats_absdev >
 168
 169 =item * C<gsl_stats_skew >
 170
 171 =item * C<gsl_stats_kurtosis >
 172
 173 =item * C<gsl_stats_lag1_autocorrelation >
 174
 175 =item * C<gsl_stats_covariance >
 176
 177 =item * C<gsl_stats_correlation >
 178
 179 =item * C<gsl_stats_variance_m($data, $stride, $n, $mean)>
 180
 181 =item * C<gsl_stats_absdev_m >
 182
 183 =item * C<gsl_stats_skew_m_sd >
 184
 185 =item * C<gsl_stats_kurtosis_m_sd >
 186
 187 =item * C<gsl_stats_lag1_autocorrelation_m >
 188
 189 =item * C<gsl_stats_covariance_m >
 190
 191 =item * C<gsl_stats_wmean >
 192
 193 =item * C<gsl_stats_wvariance >
 194
 195 =item * C<gsl_stats_wsd >
 196
 197 =item * C<gsl_stats_wvariance_with_fixed_mean >
 198
 199 =item * C<gsl_stats_wsd_with_fixed_mean >
 200
 201 =item * C<gsl_stats_wtss >
 202
 203 =item * C<gsl_stats_wtss_m >
 204
 205 =item * C<gsl_stats_wabsdev >
 206
 207 =item * C<gsl_stats_wskew >
 208
 209 =item * C<gsl_stats_wkurtosis >
 210
 211 =item * C<gsl_stats_wvariance_m >
 212
 213 =item * C<gsl_stats_wsd_m >
 214
 215 =item * C<gsl_stats_wabsdev_m >
 216
 217 =item * C<gsl_stats_wskew_m_sd >
 218
 219 =item * C<gsl_stats_wkurtosis_m_sd >
 220
 221 =item * C<gsl_stats_pvariance >
 222
 223 =item * C<gsl_stats_ttest >
 224
 225 =item * C<gsl_stats_max >
 226
 227 =item * C<gsl_stats_min >
 228
 229 =item * C<gsl_stats_minmax >
 230
 231 =item * C<gsl_stats_max_index >
 232
 233 =item * C<gsl_stats_min_index >
 234
 235 =item * C<gsl_stats_minmax_index >
 236
 237 =item * C<gsl_stats_median_from_sorted_data >
 238
 239 =item * C<gsl_stats_quantile_from_sorted_data >
 240
 241 =back
 242
 243 The following function are simply variants for int and char of the last functions:
 244
 245 =over 4
 246
 247 =item * C<gsl_stats_int_mean >
 248
 249 =item * C<gsl_stats_int_variance >
 250
 251 =item * C<gsl_stats_int_sd >
 252
 253 =item * C<gsl_stats_int_variance_with_fixed_mean >
 254
 255 =item * C<gsl_stats_int_sd_with_fixed_mean >
 256
 257 =item * C<gsl_stats_int_tss >
 258
 259 =item * C<gsl_stats_int_tss_m >
 260
 261 =item * C<gsl_stats_int_absdev >
 262
 263 =item * C<gsl_stats_int_skew >
 264
 265 =item * C<gsl_stats_int_kurtosis >
 266
 267 =item * C<gsl_stats_int_lag1_autocorrelation >
 268
 269 =item * C<gsl_stats_int_covariance >
 270
 271 =item * C<gsl_stats_int_correlation >
 272
 273 =item * C<gsl_stats_int_variance_m >
 274
 275 =item * C<gsl_stats_int_sd_m >
 276
 277 =item * C<gsl_stats_int_absdev_m >
 278
 279 =item * C<gsl_stats_int_skew_m_sd >
 280
 281 =item * C<gsl_stats_int_kurtosis_m_sd >
 282
 283 =item * C<gsl_stats_int_lag1_autocorrelation_m >
 284
 285 =item * C<gsl_stats_int_covariance_m >
 286
 287 =item * C<gsl_stats_int_pvariance >
 288
 289 =item * C<gsl_stats_int_ttest >
 290
 291 =item * C<gsl_stats_int_max >
 292
 293 =item * C<gsl_stats_int_min >
 294
 295 =item * C<gsl_stats_int_minmax >
 296
 297 =item * C<gsl_stats_int_max_index >
 298
 299 =item * C<gsl_stats_int_min_index >
 300
 301 =item * C<gsl_stats_int_minmax_index >
 302
 303 =item * C<gsl_stats_int_median_from_sorted_data >
 304
 305 =item * C<gsl_stats_int_quantile_from_sorted_data >
 306
 307 =item * C<gsl_stats_char_mean >
 308
 309 =item * C<gsl_stats_char_variance >
 310
 311 =item * C<gsl_stats_char_sd >
 312
 313 =item * C<gsl_stats_char_variance_with_fixed_mean >
 314
 315 =item * C<gsl_stats_char_sd_with_fixed_mean >
 316
 317 =item * C<gsl_stats_char_tss >
 318
 319 =item * C<gsl_stats_char_tss_m >
 320
 321 =item * C<gsl_stats_char_absdev >
 322
 323 =item * C<gsl_stats_char_skew >
 324
 325 =item * C<gsl_stats_char_kurtosis >
 326
 327 =item * C<gsl_stats_char_lag1_autocorrelation >
 328
 329 =item * C<gsl_stats_char_covariance >
 330
 331 =item * C<gsl_stats_char_correlation >
 332
 333 =item * C<gsl_stats_char_variance_m >
 334
 335 =item * C<gsl_stats_char_sd_m >
 336
 337 =item * C<gsl_stats_char_absdev_m >
 338
 339 =item * C<gsl_stats_char_skew_m_sd >
 340
 341 =item * C<gsl_stats_char_kurtosis_m_sd >
 342
 343 =item * C<gsl_stats_char_lag1_autocorrelation_m >
 344
 345 =item * C<gsl_stats_char_covariance_m >
 346
 347 =item * C<gsl_stats_char_pvariance >
 348
 349 =item * C<gsl_stats_char_ttest >
 350
 351 =item * C<gsl_stats_char_max >
 352
 353 =item * C<gsl_stats_char_min >
 354
 355 =item * C<gsl_stats_char_minmax >
 356
 357 =item * C<gsl_stats_char_max_index >
 358
 359 =item * C<gsl_stats_char_min_index >
 360
 361 =item * C<gsl_stats_char_minmax_index >
 362
 363 =item * C<gsl_stats_char_median_from_sorted_data >
 364
 365 =item * C<gsl_stats_char_quantile_from_sorted_data >
 366
 367 =back
 368
 369 You have to add the functions you want to use inside the qw /put_funtion_here /.
 370 You can also write use Math::GSL::Randist qw/:all/; to use all avaible functions of the module.
 371 Other tags are also avaible, here is a complete list of all tags for this module :
 372
 373 =over
 374
 375 =item all
 376
 377 =item int
 378
 379 =item char
 380
 381 =back
 382
 383 For more informations on the functions, we refer you to the GSL offcial
 384 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 385
 386  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 387
 388
 389 =head1 AUTHORS
 390
 391 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 392
 393 =head1 COPYRIGHT AND LICENSE
 394
 395 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 396
 397 This program is free software; you can redistribute it and/or modify it
 398 under the same terms as Perl itself.
 399
 400 =cut
 401
 402
 403 %}