summaryrefslogtreecommitdiff
path: root/gsl-1.9/histogram/gsl_histogram2d.h
blob: b4628aa37956685a08d568c3690da6c11ebbb516 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/* histogram/gsl_histogram2d.h
 * 
 * Copyright (C) 1996, 1997, 1998, 1999, 2000 Brian Gough
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef __GSL_HISTOGRAM2D_H__
#define __GSL_HISTOGRAM2D_H__

#include <stdlib.h>
#include <stdio.h>

#undef __BEGIN_DECLS
#undef __END_DECLS
#ifdef __cplusplus
# define __BEGIN_DECLS extern "C" {
# define __END_DECLS }
#else
# define __BEGIN_DECLS /* empty */
# define __END_DECLS /* empty */
#endif

__BEGIN_DECLS

typedef struct {
  size_t nx, ny ;
  double * xrange ;
  double * yrange ;
  double * bin ;
} gsl_histogram2d ;

typedef struct {
  size_t nx, ny ;
  double * xrange ;
  double * yrange ;
  double * sum ;
} gsl_histogram2d_pdf ;

gsl_histogram2d * gsl_histogram2d_alloc (const size_t nx, const size_t ny);
gsl_histogram2d * gsl_histogram2d_calloc (const size_t nx, const size_t ny);
gsl_histogram2d * gsl_histogram2d_calloc_uniform (const size_t nx, const size_t ny,
                                             const double xmin, const double xmax,
                                             const double ymin, const double ymax);

void gsl_histogram2d_free (gsl_histogram2d * h);

int gsl_histogram2d_increment (gsl_histogram2d * h, double x, double y);
int gsl_histogram2d_accumulate (gsl_histogram2d * h, 
                                double x, double y, double weight);
int gsl_histogram2d_find (const gsl_histogram2d * h, 
                          const double x, const double y, size_t * i, size_t * j);

double gsl_histogram2d_get (const gsl_histogram2d * h, const size_t i, const size_t j);
int gsl_histogram2d_get_xrange (const gsl_histogram2d * h, const size_t i,
                                double * xlower, double * xupper);
int gsl_histogram2d_get_yrange (const gsl_histogram2d * h, const size_t j,
                                double * ylower, double * yupper);

                                     
double gsl_histogram2d_xmax (const gsl_histogram2d * h);
double gsl_histogram2d_xmin (const gsl_histogram2d * h);
size_t gsl_histogram2d_nx (const gsl_histogram2d * h);

double gsl_histogram2d_ymax (const gsl_histogram2d * h);
double gsl_histogram2d_ymin (const gsl_histogram2d * h);
size_t gsl_histogram2d_ny (const gsl_histogram2d * h);

void gsl_histogram2d_reset (gsl_histogram2d * h);

gsl_histogram2d * 
gsl_histogram2d_calloc_range(size_t nx, size_t ny, 
                             double *xrange, double *yrange);

int 
gsl_histogram2d_set_ranges_uniform (gsl_histogram2d * h, 
                                    double xmin, double xmax,
                                    double ymin, double ymax);

int 
gsl_histogram2d_set_ranges (gsl_histogram2d * h, 
                            const double xrange[], size_t xsize,
                            const double yrange[], size_t ysize);

int 
gsl_histogram2d_memcpy(gsl_histogram2d *dest, const gsl_histogram2d *source);

gsl_histogram2d *
gsl_histogram2d_clone(const gsl_histogram2d * source);

double
gsl_histogram2d_max_val(const gsl_histogram2d *h);

void
gsl_histogram2d_max_bin (const gsl_histogram2d *h, size_t *i, size_t *j);

double
gsl_histogram2d_min_val(const gsl_histogram2d *h);

void
gsl_histogram2d_min_bin (const gsl_histogram2d *h, size_t *i, size_t *j);

double
gsl_histogram2d_xmean (const gsl_histogram2d * h);

double
gsl_histogram2d_ymean (const gsl_histogram2d * h);

double
gsl_histogram2d_xsigma (const gsl_histogram2d * h);

double
gsl_histogram2d_ysigma (const gsl_histogram2d * h);

double
gsl_histogram2d_cov (const gsl_histogram2d * h);

double
gsl_histogram2d_sum (const gsl_histogram2d *h);

int 
gsl_histogram2d_equal_bins_p(const gsl_histogram2d *h1,
                             const gsl_histogram2d *h2) ;

int
gsl_histogram2d_add(gsl_histogram2d *h1, const gsl_histogram2d *h2);

int
gsl_histogram2d_sub(gsl_histogram2d *h1, const gsl_histogram2d *h2);

int
gsl_histogram2d_mul(gsl_histogram2d *h1, const gsl_histogram2d *h2);

int
gsl_histogram2d_div(gsl_histogram2d *h1, const gsl_histogram2d *h2);

int
gsl_histogram2d_scale(gsl_histogram2d *h, double scale);

int
gsl_histogram2d_shift(gsl_histogram2d *h, double shift);

int gsl_histogram2d_fwrite (FILE * stream, const gsl_histogram2d * h) ;
int gsl_histogram2d_fread (FILE * stream, gsl_histogram2d * h);
int gsl_histogram2d_fprintf (FILE * stream, const gsl_histogram2d * h, 
                             const char * range_format,
                             const char * bin_format);
int gsl_histogram2d_fscanf (FILE * stream, gsl_histogram2d * h);

gsl_histogram2d_pdf * gsl_histogram2d_pdf_alloc (const size_t nx, const size_t ny);
int gsl_histogram2d_pdf_init (gsl_histogram2d_pdf * p, const gsl_histogram2d * h);
void gsl_histogram2d_pdf_free (gsl_histogram2d_pdf * p);
int gsl_histogram2d_pdf_sample (const gsl_histogram2d_pdf * p, 
                                   double r1, double r2, 
                                   double * x, double * y);

__END_DECLS

#endif /* __GSL_HISTOGRAM2D_H__ */