TheAlgorithms-C/d6/d7b/jump__search_8c.html
2020-08-26 16:14:44 +00:00

268 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.19"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C: searching/jump_search.c File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Algorithms_in_C
&#160;<span id="projectnumber">1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.19 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d6/d7b/jump__search_8c.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">jump_search.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of <a href="https://en.wikipedia.org/wiki/Jump_search">jump search</a> algorithm.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;math.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for jump_search.c:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/ddb/jump__search_8c__incl.svg" width="254" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8195a86b6d75b9a3939505e8bb50021e"><td class="memItemLeft" align="right" valign="top"><a id="a8195a86b6d75b9a3939505e8bb50021e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d7b/jump__search_8c.html#a8195a86b6d75b9a3939505e8bb50021e">min</a>(X, Y)&#160;&#160;&#160;((X) &lt; (Y) ? (X) : (Y))</td></tr>
<tr class="memdesc:a8195a86b6d75b9a3939505e8bb50021e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to return the minimum of two values. <br /></td></tr>
<tr class="separator:a8195a86b6d75b9a3939505e8bb50021e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aff36d719e6fca6aea4377a089580c603"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d7b/jump__search_8c.html#aff36d719e6fca6aea4377a089580c603">jump_search</a> (const int *arr, int x, size_t n)</td></tr>
<tr class="memdesc:aff36d719e6fca6aea4377a089580c603"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implement Jump-search algorithm. <a href="../../d6/d7b/jump__search_8c.html#aff36d719e6fca6aea4377a089580c603">More...</a><br /></td></tr>
<tr class="separator:aff36d719e6fca6aea4377a089580c603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1a3968e7947464bee7714f6d43b7002"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d7b/jump__search_8c.html#ae1a3968e7947464bee7714f6d43b7002">test</a> ()</td></tr>
<tr class="memdesc:ae1a3968e7947464bee7714f6d43b7002"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test implementation of the function. <a href="../../d6/d7b/jump__search_8c.html#ae1a3968e7947464bee7714f6d43b7002">More...</a><br /></td></tr>
<tr class="separator:ae1a3968e7947464bee7714f6d43b7002"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top"><a id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d7b/jump__search_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of <a href="https://en.wikipedia.org/wiki/Jump_search">jump search</a> algorithm. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aff36d719e6fca6aea4377a089580c603"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff36d719e6fca6aea4377a089580c603">&#9670;&nbsp;</a></span>jump_search()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jump_search </td>
<td>(</td>
<td class="paramtype">const int *&#160;</td>
<td class="paramname"><em>arr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>n</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implement Jump-search algorithm. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">arr</td><td>Array to search within </td></tr>
<tr><td class="paramdir"></td><td class="paramname">x</td><td>value to search for </td></tr>
<tr><td class="paramdir"></td><td class="paramname">n</td><td>length of array </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>index where the value was found </dd>
<dd>
-1 if value not found </dd></dl>
<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">int</span> step = floor(sqrt(n));</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">int</span> prev = 0;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">while</span> (arr[<a class="code" href="../../d6/d7b/jump__search_8c.html#a8195a86b6d75b9a3939505e8bb50021e">min</a>(step, n) - 1] &lt; x)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; prev = step;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; step += floor(sqrt(n));</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">if</span> (prev &gt;= n)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">while</span> (arr[prev] &lt; x)</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; prev = prev + 1;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span> (prev == <a class="code" href="../../d6/d7b/jump__search_8c.html#a8195a86b6d75b9a3939505e8bb50021e">min</a>(step, n))</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span> (arr[prev] == x)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> prev;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ae1a3968e7947464bee7714f6d43b7002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1a3968e7947464bee7714f6d43b7002">&#9670;&nbsp;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void test </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test implementation of the function. </p>
<div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;{</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">int</span> arr[] = {0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610};</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">size_t</span> n = <span class="keyword">sizeof</span>(arr) / <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">int</span> x = 55;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; printf(<span class="stringliteral">&quot;Test 1.... &quot;</span>);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">int</span> index = <a class="code" href="../../d6/d7b/jump__search_8c.html#aff36d719e6fca6aea4377a089580c603">jump_search</a>(arr, x, n);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; assert(index == 10);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; printf(<span class="stringliteral">&quot;passed\nTest 2.... &quot;</span>);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; x = 56;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; index = <a class="code" href="../../d6/d7b/jump__search_8c.html#aff36d719e6fca6aea4377a089580c603">jump_search</a>(arr, x, n);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; assert(index == -1);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; printf(<span class="stringliteral">&quot;passed\nTest 3.... &quot;</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; x = 13;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; index = <a class="code" href="../../d6/d7b/jump__search_8c.html#aff36d719e6fca6aea4377a089580c603">jump_search</a>(arr, x, n);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; assert(index == 7);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; printf(<span class="stringliteral">&quot;passed\n&quot;</span>);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/d7b/jump__search_8c_ae1a3968e7947464bee7714f6d43b7002_cgraph.svg" width="199" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="ajump__search_8c_html_aff36d719e6fca6aea4377a089580c603"><div class="ttname"><a href="../../d6/d7b/jump__search_8c.html#aff36d719e6fca6aea4377a089580c603">jump_search</a></div><div class="ttdeci">int jump_search(const int *arr, int x, size_t n)</div><div class="ttdoc">Implement Jump-search algorithm.</div><div class="ttdef"><b>Definition:</b> jump_search.c:24</div></div>
<div class="ttc" id="ajump__search_8c_html_a8195a86b6d75b9a3939505e8bb50021e"><div class="ttname"><a href="../../d6/d7b/jump__search_8c.html#a8195a86b6d75b9a3939505e8bb50021e">min</a></div><div class="ttdeci">#define min(X, Y)</div><div class="ttdoc">Macro to return the minimum of two values.</div><div class="ttdef"><b>Definition:</b> jump_search.c:13</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_da574daf9ce9c05b45556bdc871ed1e3.html">searching</a></li><li class="navelem"><a class="el" href="../../d6/d7b/jump__search_8c.html">jump_search.c</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.19 </li>
</ul>
</div>
</body>
</html>