File: Updating-and-accessing-histogram-elements.html

package info (click to toggle)
gsl-ref-html 2.3-1
  • links: PTS
  • area: non-free
  • in suites: bullseye, buster, sid
  • size: 6,876 kB
  • ctags: 4,574
  • sloc: makefile: 35
file content (147 lines) | stat: -rw-r--r-- 8,344 bytes parent folder | download
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
<!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, 2014, 2015, 2016 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 the
Invariant Sections being "GNU General Public License" and "Free Software
Needs Free Documentation", the Front-Cover text being "A GNU Manual",
and with the Back-Cover Text being (a) (see below). A copy of the
license is included in the section entitled "GNU Free Documentation
License".

(a) The Back-Cover Text is: "You have the freedom to copy and modify this
GNU Manual." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Updating and accessing histogram elements</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Updating and accessing histogram elements">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Updating and accessing histogram elements">
<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="Searching-histogram-ranges.html#Searching-histogram-ranges" rel="next" title="Searching histogram ranges">
<link href="Copying-Histograms.html#Copying-Histograms" rel="previous" title="Copying Histograms">
<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="Updating-and-accessing-histogram-elements"></a>
<div class="header">
<p>
Next: <a href="Searching-histogram-ranges.html#Searching-histogram-ranges" accesskey="n" rel="next">Searching histogram ranges</a>, Previous: <a href="Copying-Histograms.html#Copying-Histograms" accesskey="p" rel="previous">Copying Histograms</a>, Up: <a href="Histograms.html#Histograms" accesskey="u" rel="up">Histograms</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Updating-and-accessing-histogram-elements-1"></a>
<h3 class="section">23.4 Updating and accessing histogram elements</h3>

<p>There are two ways to access histogram bins, either by specifying an
<em>x</em> coordinate or by using the bin-index directly.  The functions
for accessing the histogram through <em>x</em> coordinates use a binary
search to identify the bin which covers the appropriate range.
</p>
<dl>
<dt><a name="index-gsl_005fhistogram_005fincrement"></a>Function: <em>int</em> <strong>gsl_histogram_increment</strong> <em>(gsl_histogram * <var>h</var>, double <var>x</var>)</em></dt>
<dd><p>This function updates the histogram <var>h</var> by adding one (1.0) to the
bin whose range contains the coordinate <var>x</var>. 
</p>
<p>If <var>x</var> lies in the valid range of the histogram then the function
returns zero to indicate success.  If <var>x</var> is less than the lower
limit of the histogram then the function returns <code>GSL_EDOM</code>, and
none of bins are modified.  Similarly, if the value of <var>x</var> is greater
than or equal to the upper limit of the histogram then the function
returns <code>GSL_EDOM</code>, and none of the bins are modified.  The error
handler is not called, however, since it is often necessary to compute
histograms for a small range of a larger dataset, ignoring the values
outside the range of interest.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fhistogram_005faccumulate"></a>Function: <em>int</em> <strong>gsl_histogram_accumulate</strong> <em>(gsl_histogram * <var>h</var>, double <var>x</var>, double <var>weight</var>)</em></dt>
<dd><p>This function is similar to <code>gsl_histogram_increment</code> but increases
the value of the appropriate bin in the histogram <var>h</var> by the
floating-point number <var>weight</var>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fhistogram_005fget"></a>Function: <em>double</em> <strong>gsl_histogram_get</strong> <em>(const gsl_histogram * <var>h</var>, size_t <var>i</var>)</em></dt>
<dd><p>This function returns the contents of the <var>i</var>-th bin of the histogram
<var>h</var>.  If <var>i</var> lies outside the valid range of indices for the
histogram then the error handler is called with an error code of
<code>GSL_EDOM</code> and the function returns 0.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fhistogram_005fget_005frange"></a>Function: <em>int</em> <strong>gsl_histogram_get_range</strong> <em>(const gsl_histogram * <var>h</var>, size_t <var>i</var>, double * <var>lower</var>, double * <var>upper</var>)</em></dt>
<dd><p>This function finds the upper and lower range limits of the <var>i</var>-th
bin of the histogram <var>h</var>.  If the index <var>i</var> is valid then the
corresponding range limits are stored in <var>lower</var> and <var>upper</var>.
The lower limit is inclusive (i.e. events with this coordinate are
included in the bin) and the upper limit is exclusive (i.e. events with
the coordinate of the upper limit are excluded and fall in the
neighboring higher bin, if it exists).  The function returns 0 to
indicate success.  If <var>i</var> lies outside the valid range of indices for
the histogram then the error handler is called and the function returns
an error code of <code>GSL_EDOM</code>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fhistogram_005fmax"></a>Function: <em>double</em> <strong>gsl_histogram_max</strong> <em>(const gsl_histogram * <var>h</var>)</em></dt>
<dt><a name="index-gsl_005fhistogram_005fmin"></a>Function: <em>double</em> <strong>gsl_histogram_min</strong> <em>(const gsl_histogram * <var>h</var>)</em></dt>
<dt><a name="index-gsl_005fhistogram_005fbins"></a>Function: <em>size_t</em> <strong>gsl_histogram_bins</strong> <em>(const gsl_histogram * <var>h</var>)</em></dt>
<dd><p>These functions return the maximum upper and minimum lower range limits
and the number of bins of the histogram <var>h</var>.  They provide a way of
determining these values without accessing the <code>gsl_histogram</code>
struct directly.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fhistogram_005freset"></a>Function: <em>void</em> <strong>gsl_histogram_reset</strong> <em>(gsl_histogram * <var>h</var>)</em></dt>
<dd><p>This function resets all the bins in the histogram <var>h</var> to zero.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Searching-histogram-ranges.html#Searching-histogram-ranges" accesskey="n" rel="next">Searching histogram ranges</a>, Previous: <a href="Copying-Histograms.html#Copying-Histograms" accesskey="p" rel="previous">Copying Histograms</a>, Up: <a href="Histograms.html#Histograms" accesskey="u" rel="up">Histograms</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>