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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The GSL Team.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections and no cover texts. A copy of the license is
included in the section entitled "GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library – Reference Manual: 2D Histogram allocation</title>
<meta name="description" content="GNU Scientific Library – Reference Manual: 2D Histogram allocation">
<meta name="keywords" content="GNU Scientific Library – Reference Manual: 2D Histogram allocation">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Histograms.html#Histograms" rel="up" title="Histograms">
<link href="Copying-2D-Histograms.html#Copying-2D-Histograms" rel="next" title="Copying 2D Histograms">
<link href="The-2D-histogram-struct.html#The-2D-histogram-struct" rel="previous" title="The 2D histogram struct">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="g_t2D-Histogram-allocation"></a>
<div class="header">
<p>
Next: <a href="Copying-2D-Histograms.html#Copying-2D-Histograms" accesskey="n" rel="next">Copying 2D Histograms</a>, Previous: <a href="The-2D-histogram-struct.html#The-2D-histogram-struct" accesskey="p" rel="previous">The 2D histogram struct</a>, Up: <a href="Histograms.html#Histograms" accesskey="u" rel="up">Histograms</a> [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="g_t2D-Histogram-allocation-1"></a>
<h3 class="section">22.14 2D Histogram allocation</h3>
<p>The functions for allocating memory to a 2D histogram follow the style
of <code>malloc</code> and <code>free</code>. In addition they also perform their
own error checking. If there is insufficient memory available to
allocate a histogram then the functions call the error handler (with
an error number of <code>GSL_ENOMEM</code>) in addition to returning a null
pointer. Thus if you use the library error handler to abort your program
then it isn’t necessary to check every 2D histogram <code>alloc</code>.
</p>
<dl>
<dt><a name="index-gsl_005fhistogram2d_005falloc"></a>Function: <em>gsl_histogram2d *</em> <strong>gsl_histogram2d_alloc</strong> <em>(size_t <var>nx</var>, size_t <var>ny</var>)</em></dt>
<dd><p>This function allocates memory for a two-dimensional histogram with
<var>nx</var> bins in the x direction and <var>ny</var> bins in the y direction.
The function returns a pointer to a newly created <code>gsl_histogram2d</code>
struct. If insufficient memory is available a null pointer is returned
and the error handler is invoked with an error code of
<code>GSL_ENOMEM</code>. The bins and ranges must be initialized with one of
the functions below before the histogram is ready for use.
</p></dd></dl>
<dl>
<dt><a name="index-gsl_005fhistogram2d_005fset_005franges"></a>Function: <em>int</em> <strong>gsl_histogram2d_set_ranges</strong> <em>(gsl_histogram2d * <var>h</var>, const double <var>xrange</var>[], size_t <var>xsize</var>, const double <var>yrange</var>[], size_t <var>ysize</var>)</em></dt>
<dd><p>This function sets the ranges of the existing histogram <var>h</var> using
the arrays <var>xrange</var> and <var>yrange</var> of size <var>xsize</var> and
<var>ysize</var> respectively. The values of the histogram bins are reset to
zero.
</p></dd></dl>
<dl>
<dt><a name="index-gsl_005fhistogram2d_005fset_005franges_005funiform"></a>Function: <em>int</em> <strong>gsl_histogram2d_set_ranges_uniform</strong> <em>(gsl_histogram2d * <var>h</var>, double <var>xmin</var>, double <var>xmax</var>, double <var>ymin</var>, double <var>ymax</var>)</em></dt>
<dd><p>This function sets the ranges of the existing histogram <var>h</var> to cover
the ranges <var>xmin</var> to <var>xmax</var> and <var>ymin</var> to <var>ymax</var>
uniformly. The values of the histogram bins are reset to zero.
</p></dd></dl>
<dl>
<dt><a name="index-gsl_005fhistogram2d_005ffree"></a>Function: <em>void</em> <strong>gsl_histogram2d_free</strong> <em>(gsl_histogram2d * <var>h</var>)</em></dt>
<dd><p>This function frees the 2D histogram <var>h</var> and all of the memory
associated with it.
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Copying-2D-Histograms.html#Copying-2D-Histograms" accesskey="n" rel="next">Copying 2D Histograms</a>, Previous: <a href="The-2D-histogram-struct.html#The-2D-histogram-struct" accesskey="p" rel="previous">The 2D histogram struct</a>, Up: <a href="Histograms.html#Histograms" accesskey="u" rel="up">Histograms</a> [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
