Basic Histogram POD.
[Math-GSL.git] / Histogram.i
blob546e3c7873219a23790a397d4793c602d0e8d9bb
1 %module "Math::GSL::Histogram"
2 %include "typemaps.i"
3 %include "gsl_typemaps.i"
5 %{
6 #include "gsl/gsl_histogram.h"
7 %}
9 %include "gsl/gsl_histogram.h"
12 %perlcode %{
13 @EXPORT_OK = qw/
14 gsl_histogram_alloc
15 gsl_histogram_calloc
16 gsl_histogram_calloc_uniform
17 gsl_histogram_free
18 gsl_histogram_increment
19 gsl_histogram_accumulate
20 gsl_histogram_find
21 gsl_histogram_get
22 gsl_histogram_get_range
23 gsl_histogram_max
24 gsl_histogram_min
25 gsl_histogram_bins
26 gsl_histogram_reset
27 gsl_histogram_calloc_range
28 gsl_histogram_set_ranges
29 gsl_histogram_set_ranges_uniform
30 gsl_histogram_memcpy
31 gsl_histogram_clone
32 gsl_histogram_max_val
33 gsl_histogram_max_bin
34 gsl_histogram_min_val
35 gsl_histogram_min_bin
36 gsl_histogram_equal_bins_p
37 gsl_histogram_add
38 gsl_histogram_sub
39 gsl_histogram_mul
40 gsl_histogram_div
41 gsl_histogram_scale
42 gsl_histogram_shift
43 gsl_histogram_sigma
44 gsl_histogram_mean
45 gsl_histogram_sum
46 gsl_histogram_fwrite
47 gsl_histogram_fread
48 gsl_histogram_fprintf
49 gsl_histogram_fscanf
50 gsl_histogram_pdf_alloc
51 gsl_histogram_pdf_init
52 gsl_histogram_pdf_free
53 gsl_histogram_pdf_sample
55 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
57 =head1 NAME
59 Math::GSL::Histogram - Create and manipulate histograms of data
61 =head1 SYNOPSIS
63 use Math::GSL::Histogram qw/:all/;
65 my $H = gsl_histogram_alloc(100);
66 gsl_histogram_set_ranges_uniform($H,0,101);
67 gsl_histogram_increment($H, -50 ); # ignored
68 gsl_histogram_increment($H, 70 );
69 gsl_histogram_increment($H, 85.2 );
71 my $G = gsl_histogram_clone($H);
72 my $value = gsl_histogram_get($G, 70);
73 my ($max,$min) = (gsl_histogram_min_val($H), gsl_histogram_max_val($H) );
74 my $sum = gsl_histogram_sum($H);
76 =cut
78 =head1 AUTHORS
80 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
82 =head1 COPYRIGHT AND LICENSE
84 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
86 This program is free software; you can redistribute it and/or modify it
87 under the same terms as Perl itself.
89 =cut