<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>The MRPT project: pr_queue_k.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>pr_queue_k.h</h1> </div>
</div>
<div class="contents">
<a href="pr__queue__k_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00002"></a>00002 <span class="comment">// File: pr_queue_k.h</span>
<a name="l00003"></a>00003 <span class="comment">// Programmer: Sunil Arya and David Mount</span>
<a name="l00004"></a>00004 <span class="comment">// Description: Include file for priority queue with k items.</span>
<a name="l00005"></a>00005 <span class="comment">// Last modified: 01/04/05 (Version 1.0)</span>
<a name="l00006"></a>00006 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00007"></a>00007 <span class="comment">// Copyright (c) 1997-2005 University of Maryland and Sunil Arya and</span>
<a name="l00008"></a>00008 <span class="comment">// David Mount. All Rights Reserved.</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// This software and related documentation is part of the Approximate</span>
<a name="l00011"></a>00011 <span class="comment">// Nearest Neighbor Library (ANN). This software is provided under</span>
<a name="l00012"></a>00012 <span class="comment">// the provisions of the Lesser GNU Public License (LGPL). See the</span>
<a name="l00013"></a>00013 <span class="comment">// file ../ReadMe.txt for further information.</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015 <span class="comment">// The University of Maryland (U.M.) and the authors make no</span>
<a name="l00016"></a>00016 <span class="comment">// representations about the suitability or fitness of this software for</span>
<a name="l00017"></a>00017 <span class="comment">// any purpose. It is provided "as is" without express or implied</span>
<a name="l00018"></a>00018 <span class="comment">// warranty.</span>
<a name="l00019"></a>00019 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00020"></a>00020 <span class="comment">// History:</span>
<a name="l00021"></a>00021 <span class="comment">// Revision 0.1 03/04/98</span>
<a name="l00022"></a>00022 <span class="comment">// Initial release</span>
<a name="l00023"></a>00023 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef PR_QUEUE_K_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define PR_QUEUE_K_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="_a_n_nx_8h.html">ann/ANNx.h</a>></span> <span class="comment">// all ANN includes</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <<a class="code" href="_a_n_nperf_8h.html">ann/ANNperf.h</a>></span> <span class="comment">// performance evaluation</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00032"></a>00032 <span class="comment">// Basic types</span>
<a name="l00033"></a>00033 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00034"></a><a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">00034</a> <span class="keyword">typedef</span> <a class="code" href="_a_n_n_8h.html#a8bc37b58295dfdffc8f9171f0a2a1965">ANNdist</a> <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a>; <span class="comment">// key field is distance</span>
<a name="l00035"></a><a class="code" href="pr__queue__k_8h.html#ab20931c673111c83de5b3f096cea7b35">00035</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="pr__queue__k_8h.html#ab20931c673111c83de5b3f096cea7b35">PQKinfo</a>; <span class="comment">// info field is int</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00038"></a>00038 <span class="comment">// Constants</span>
<a name="l00039"></a>00039 <span class="comment">// The NULL key value is used to initialize the priority queue, and</span>
<a name="l00040"></a>00040 <span class="comment">// so it should be larger than any valid distance, so that it will</span>
<a name="l00041"></a>00041 <span class="comment">// be replaced as legal distance values are inserted. The NULL</span>
<a name="l00042"></a>00042 <span class="comment">// info value must be a nonvalid array index, we use ANN_NULL_IDX,</span>
<a name="l00043"></a>00043 <span class="comment">// which is guaranteed to be negative.</span>
<a name="l00044"></a>00044 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="pr__queue__k_8h.html#a6d22ac93de0b840f2b39f3d7bf62324c">00046</a> <span class="keyword">const</span> <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a> <a class="code" href="pr__queue__k_8h.html#a6d22ac93de0b840f2b39f3d7bf62324c">PQ_NULL_KEY</a> = <a class="code" href="_a_n_n_8h.html#a8a36a08c888181744ed16309e29f48ac">ANN_DIST_INF</a>; <span class="comment">// nonexistent key value</span>
<a name="l00047"></a><a class="code" href="pr__queue__k_8h.html#a2de9476a9fbdd1e8fd20e217bbd819d0">00047</a> <span class="keyword">const</span> <a class="code" href="pr__queue__k_8h.html#ab20931c673111c83de5b3f096cea7b35">PQKinfo</a> <a class="code" href="pr__queue__k_8h.html#a2de9476a9fbdd1e8fd20e217bbd819d0">PQ_NULL_INFO</a> = <a class="code" href="_a_n_n_8h.html#ae1346d82a39cf8b05b03fa85aaa51233">ANN_NULL_IDX</a>; <span class="comment">// nonexistent info value</span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00050"></a>00050 <span class="comment">// ANNmin_k</span>
<a name="l00051"></a>00051 <span class="comment">// An ANNmin_k structure is one which maintains the smallest</span>
<a name="l00052"></a>00052 <span class="comment">// k values (of type PQKkey) and associated information (of type</span>
<a name="l00053"></a>00053 <span class="comment">// PQKinfo). The special info and key values PQ_NULL_INFO and</span>
<a name="l00054"></a>00054 <span class="comment">// PQ_NULL_KEY means that thise entry is empty.</span>
<a name="l00055"></a>00055 <span class="comment">//</span>
<a name="l00056"></a>00056 <span class="comment">// It is currently implemented using an array with k items.</span>
<a name="l00057"></a>00057 <span class="comment">// Items are stored in increasing sorted order, and insertions</span>
<a name="l00058"></a>00058 <span class="comment">// are made through standard insertion sort. (This is quite</span>
<a name="l00059"></a>00059 <span class="comment">// inefficient, but current applications call for small values</span>
<a name="l00060"></a>00060 <span class="comment">// of k and relatively few insertions.)</span>
<a name="l00061"></a>00061 <span class="comment">//</span>
<a name="l00062"></a>00062 <span class="comment">// Note that the list contains k+1 entries, but the last entry</span>
<a name="l00063"></a>00063 <span class="comment">// is used as a simple placeholder and is otherwise ignored.</span>
<a name="l00064"></a>00064 <span class="comment">//----------------------------------------------------------------------</span>
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="class_a_n_nmin__k.html">00066</a> <span class="keyword">class </span><a class="code" href="class_a_n_nmin__k.html">ANNmin_k</a> {
<a name="l00067"></a><a class="code" href="struct_a_n_nmin__k_1_1mk__node.html">00067</a> <span class="keyword">struct </span><a class="code" href="struct_a_n_nmin__k_1_1mk__node.html">mk_node</a> { <span class="comment">// node in min_k structure</span>
<a name="l00068"></a><a class="code" href="struct_a_n_nmin__k_1_1mk__node.html#aeb5a67eddffcfb350267436f3aa70c4a">00068</a> <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a> <a class="code" href="struct_a_n_nmin__k_1_1mk__node.html#aeb5a67eddffcfb350267436f3aa70c4a">key</a>; <span class="comment">// key value</span>
<a name="l00069"></a><a class="code" href="struct_a_n_nmin__k_1_1mk__node.html#afe402f315aab9d022c2db6ba1bf39e43">00069</a> <a class="code" href="pr__queue__k_8h.html#ab20931c673111c83de5b3f096cea7b35">PQKinfo</a> <a class="code" href="struct_a_n_nmin__k_1_1mk__node.html#afe402f315aab9d022c2db6ba1bf39e43">info</a>; <span class="comment">// info field (user defined)</span>
<a name="l00070"></a>00070 };
<a name="l00071"></a>00071
<a name="l00072"></a><a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">00072</a> <span class="keywordtype">int</span> <a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">k</a>; <span class="comment">// max number of keys to store</span>
<a name="l00073"></a><a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">00073</a> <span class="keywordtype">int</span> <a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a>; <span class="comment">// number of keys currently active</span>
<a name="l00074"></a><a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">00074</a> <a class="code" href="struct_a_n_nmin__k_1_1mk__node.html">mk_node</a> *<a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>; <span class="comment">// the list itself</span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">public</span>:
<a name="l00077"></a><a class="code" href="class_a_n_nmin__k.html#ae60a1c172b6fea16e1f9c5c197bad776">00077</a> <a class="code" href="class_a_n_nmin__k.html#ae60a1c172b6fea16e1f9c5c197bad776">ANNmin_k</a>(<span class="keywordtype">int</span> max) <span class="comment">// constructor (given max size)</span>
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a> = 0; <span class="comment">// initially no items</span>
<a name="l00080"></a>00080 <a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">k</a> = max; <span class="comment">// maximum number of items</span>
<a name="l00081"></a>00081 <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a> = <span class="keyword">new</span> <a class="code" href="struct_a_n_nmin__k_1_1mk__node.html">mk_node</a>[max+1]; <span class="comment">// sorted array of keys</span>
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083
<a name="l00084"></a><a class="code" href="class_a_n_nmin__k.html#a78ebcf0a92814c60f62c490e42fc9d94">00084</a> <a class="code" href="class_a_n_nmin__k.html#a78ebcf0a92814c60f62c490e42fc9d94">~ANNmin_k</a>() <span class="comment">// destructor</span>
<a name="l00085"></a>00085 { <span class="keyword">delete</span> [] <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>; }
<a name="l00086"></a>00086
<a name="l00087"></a><a class="code" href="class_a_n_nmin__k.html#ac0e8cd2e80832836567b343273c6ca38">00087</a> <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a> <a class="code" href="class_a_n_nmin__k.html#ac0e8cd2e80832836567b343273c6ca38">ANNmin_key</a>() <span class="comment">// return minimum key</span>
<a name="l00088"></a>00088 { <span class="keywordflow">return</span> (<a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a> > 0 ? <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[0].key : <a class="code" href="pr__queue__k_8h.html#a6d22ac93de0b840f2b39f3d7bf62324c">PQ_NULL_KEY</a>); }
<a name="l00089"></a>00089
<a name="l00090"></a><a class="code" href="class_a_n_nmin__k.html#a4b6a2185bf54f0516fd0631931a64e3f">00090</a> <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a> <a class="code" href="class_a_n_nmin__k.html#a4b6a2185bf54f0516fd0631931a64e3f">max_key</a>() <span class="comment">// return maximum key</span>
<a name="l00091"></a>00091 { <span class="keywordflow">return</span> (<a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a> == <a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">k</a> ? <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[<a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">k</a>-1].key : <a class="code" href="pr__queue__k_8h.html#a6d22ac93de0b840f2b39f3d7bf62324c">PQ_NULL_KEY</a>); }
<a name="l00092"></a>00092
<a name="l00093"></a><a class="code" href="class_a_n_nmin__k.html#afef9c9c95a7563b33d1c98bbcf359700">00093</a> <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a> <a class="code" href="class_a_n_nmin__k.html#afef9c9c95a7563b33d1c98bbcf359700">ith_smallest_key</a>(<span class="keywordtype">int</span> i) <span class="comment">// ith smallest key (i in [0..n-1])</span>
<a name="l00094"></a>00094 { <span class="keywordflow">return</span> (i < <a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a> ? <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i].key : <a class="code" href="pr__queue__k_8h.html#a6d22ac93de0b840f2b39f3d7bf62324c">PQ_NULL_KEY</a>); }
<a name="l00095"></a>00095
<a name="l00096"></a><a class="code" href="class_a_n_nmin__k.html#a5afb7172ba783e16ff52a31b78000890">00096</a> <a class="code" href="pr__queue__k_8h.html#ab20931c673111c83de5b3f096cea7b35">PQKinfo</a> <a class="code" href="class_a_n_nmin__k.html#a5afb7172ba783e16ff52a31b78000890">ith_smallest_info</a>(<span class="keywordtype">int</span> i) <span class="comment">// info for ith smallest (i in [0..n-1])</span>
<a name="l00097"></a>00097 { <span class="keywordflow">return</span> (i < <a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a> ? <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i].info : <a class="code" href="pr__queue__k_8h.html#a2de9476a9fbdd1e8fd20e217bbd819d0">PQ_NULL_INFO</a>); }
<a name="l00098"></a>00098
<a name="l00099"></a><a class="code" href="class_a_n_nmin__k.html#aa3143d11f9b71be93723f4775adb1a2f">00099</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_a_n_nmin__k.html#aa3143d11f9b71be93723f4775adb1a2f">insert</a>( <span class="comment">// insert item (inlined for speed)</span>
<a name="l00100"></a>00100 <a class="code" href="pr__queue__k_8h.html#a49b3ed24c00d3149153fcbd5a007990f">PQKkey</a> kv, <span class="comment">// key value</span>
<a name="l00101"></a>00101 <a class="code" href="pr__queue__k_8h.html#ab20931c673111c83de5b3f096cea7b35">PQKinfo</a> inf) <span class="comment">// item info</span>
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 <span class="keyword">register</span> <span class="keywordtype">int</span> i;
<a name="l00104"></a>00104 <span class="comment">// slide larger values up</span>
<a name="l00105"></a>00105 <span class="keywordflow">for</span> (i = <a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a>; i > 0; i--) {
<a name="l00106"></a>00106 <span class="keywordflow">if</span> (<a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i-1].key > kv)
<a name="l00107"></a>00107 <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i] = <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i-1];
<a name="l00108"></a>00108 <span class="keywordflow">else</span>
<a name="l00109"></a>00109 <span class="keywordflow">break</span>;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i].<a class="code" href="struct_a_n_nmin__k_1_1mk__node.html#aeb5a67eddffcfb350267436f3aa70c4a">key</a> = kv; <span class="comment">// store element here</span>
<a name="l00112"></a>00112 <a class="code" href="class_a_n_nmin__k.html#af8c9379a3ff2f0f4c9cc28a8cca49f0e">mk</a>[i].<a class="code" href="struct_a_n_nmin__k_1_1mk__node.html#afe402f315aab9d022c2db6ba1bf39e43">info</a> = inf;
<a name="l00113"></a>00113 <span class="keywordflow">if</span> (<a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a> < <a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">k</a>) <a class="code" href="class_a_n_nmin__k.html#ac07beee6f18302edc35ffbb9515a6869">n</a>++; <span class="comment">// increment number of items</span>
<a name="l00114"></a>00114 <a class="code" href="_a_n_nperf_8h.html#a9e54d6f38fc80e6cdd64b97abf63c9a3">ANN_FLOP</a>(<a class="code" href="class_a_n_nmin__k.html#a1f2f5b88a57d7b868ab63a45c745f265">k</a>-i+1) <span class="comment">// increment floating ops</span>
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
