File: Searching-histogram-ranges.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 (93 lines) | stat: -rw-r--r-- 4,712 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
<!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: Searching histogram ranges</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Searching histogram ranges">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Searching histogram ranges">
<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="Histogram-Statistics.html#Histogram-Statistics" rel="next" title="Histogram Statistics">
<link href="Updating-and-accessing-histogram-elements.html#Updating-and-accessing-histogram-elements" rel="previous" title="Updating and accessing histogram elements">
<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="Searching-histogram-ranges"></a>
<div class="header">
<p>
Next: <a href="Histogram-Statistics.html#Histogram-Statistics" accesskey="n" rel="next">Histogram Statistics</a>, Previous: <a href="Updating-and-accessing-histogram-elements.html#Updating-and-accessing-histogram-elements" accesskey="p" rel="previous">Updating and accessing histogram elements</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="Searching-histogram-ranges-1"></a>
<h3 class="section">23.5 Searching histogram ranges</h3>

<p>The following functions are used by the access and update routines to
locate the bin which corresponds to a given <em>x</em> coordinate.
</p>
<dl>
<dt><a name="index-gsl_005fhistogram_005ffind"></a>Function: <em>int</em> <strong>gsl_histogram_find</strong> <em>(const gsl_histogram * <var>h</var>, double <var>x</var>, size_t * <var>i</var>)</em></dt>
<dd><p>This function finds and sets the index <var>i</var> to the bin number which
covers the coordinate <var>x</var> in the histogram <var>h</var>.  The bin is
located using a binary search. The search includes an optimization for
histograms with uniform range, and will return the correct bin
immediately in this case.  If <var>x</var> is found in the range of the
histogram then the function sets the index <var>i</var> and returns
<code>GSL_SUCCESS</code>.  If <var>x</var> lies outside the valid range of the
histogram then the function returns <code>GSL_EDOM</code> and the error
handler is invoked.
</p></dd></dl>




</body>
</html>