Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2166

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/priorityqueue.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</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="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/priorityqueue.h</h1><a href="priorityqueue_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">    Copyright (C) 2007 by Frank Richter</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_CSUTIL_PRIORTITYQUEUE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_PRIORTITYQUEUE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">array.h</a>"</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keyword">namespace </span>CS
<a name="l00029"></a>00029 {
<a name="l00030"></a>00030   <span class="keyword">namespace </span>Utility
<a name="l00031"></a>00031   {
<a name="l00032"></a>00032     
<a name="l00038"></a>00038     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">class</span> Container = csArray&lt;T&gt; &gt;
<a name="l00039"></a><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html">00039</a>     <span class="keyword">class </span><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html" title="An implementation of a priority queue.">PriorityQueue</a>
<a name="l00040"></a>00040     {
<a name="l00041"></a>00041       Container items;
<a name="l00042"></a>00042 
<a name="l00043"></a>00043       <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">size_t</span> Parent (<span class="keywordtype">size_t</span> n) { <span class="keywordflow">return</span> (n-1)/2; }
<a name="l00044"></a>00044       <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">size_t</span> Left (<span class="keywordtype">size_t</span> n) { <span class="keywordflow">return</span> 2*n+1; }
<a name="l00045"></a>00045       <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">size_t</span> Right (<span class="keywordtype">size_t</span> n) { <span class="keywordflow">return</span> 2*n+2; }
<a name="l00046"></a>00046 
<a name="l00047"></a>00047       <span class="keywordtype">void</span> SwapItems (<span class="keywordtype">size_t</span> a, <span class="keywordtype">size_t</span> b)
<a name="l00048"></a>00048       {
<a name="l00049"></a>00049         T tmp (items[a]);
<a name="l00050"></a>00050         items[a] = items[b];
<a name="l00051"></a>00051         items[b] = tmp;
<a name="l00052"></a>00052       }
<a name="l00053"></a>00053       <span class="keyword">inline</span> <span class="keywordtype">bool</span> Larger (<span class="keywordtype">size_t</span> a, <span class="keywordtype">size_t</span> b)
<a name="l00054"></a>00054       { <span class="keywordflow">return</span> <a class="code" href="classcsComparator.html#91f6c9cfaa52ebbc6245dc0ba5f944d7" title="Compare two objects of the same type or different types (T1 and T2).">csComparator&lt;T, T&gt;::Compare</a> (items[a], items[b]) &gt; 0; }
<a name="l00055"></a>00055 
<a name="l00057"></a>00057       <span class="keywordtype">void</span> HeapifyUp (<span class="keywordtype">size_t</span> n)
<a name="l00058"></a>00058       {
<a name="l00059"></a>00059         <span class="keywordtype">size_t</span> current = n;
<a name="l00060"></a>00060         <span class="keywordflow">while</span> (current &gt; 0)
<a name="l00061"></a>00061         {
<a name="l00062"></a>00062           <span class="keywordtype">size_t</span> parent = Parent (current);
<a name="l00063"></a>00063           <span class="keywordtype">size_t</span> larger = current;
<a name="l00064"></a>00064           <span class="keywordflow">if</span> (((current ^ 1) &lt; items.GetSize())
<a name="l00065"></a>00065             &amp;&amp; Larger (current ^ 1, larger))
<a name="l00066"></a>00066           {
<a name="l00067"></a>00067             larger = current ^ 1;
<a name="l00068"></a>00068           }
<a name="l00069"></a>00069           <span class="keywordflow">if</span> (Larger (larger, parent))
<a name="l00070"></a>00070             SwapItems (larger, parent);
<a name="l00071"></a>00071           <span class="keywordflow">else</span>
<a name="l00072"></a>00072             <span class="keywordflow">return</span>;
<a name="l00073"></a>00073           current = parent;
<a name="l00074"></a>00074         }
<a name="l00075"></a>00075       }
<a name="l00077"></a>00077       <span class="keywordtype">void</span> HeapifyDown (<span class="keywordtype">size_t</span> n)
<a name="l00078"></a>00078       {
<a name="l00079"></a>00079         <span class="keywordtype">size_t</span> current = n;
<a name="l00080"></a>00080         <span class="keywordflow">do</span>
<a name="l00081"></a>00081         {
<a name="l00082"></a>00082           <span class="keywordtype">size_t</span> l = Left (current);
<a name="l00083"></a>00083           <span class="keywordtype">size_t</span> r = Right (current);
<a name="l00084"></a>00084           <span class="keywordtype">size_t</span> larger = current;
<a name="l00085"></a>00085           <span class="keywordflow">if</span> ((l &lt; items.GetSize())
<a name="l00086"></a>00086             &amp;&amp; Larger (l, larger))
<a name="l00087"></a>00087           {
<a name="l00088"></a>00088             larger = l;
<a name="l00089"></a>00089           }
<a name="l00090"></a>00090           <span class="keywordflow">if</span> ((r &lt; items.GetSize())
<a name="l00091"></a>00091             &amp;&amp; Larger (r, larger))
<a name="l00092"></a>00092           {
<a name="l00093"></a>00093             larger = r;
<a name="l00094"></a>00094           }
<a name="l00095"></a>00095           <span class="keywordflow">if</span> (larger == current) <span class="keywordflow">return</span>;
<a name="l00096"></a>00096           SwapItems (larger, current);
<a name="l00097"></a>00097           current = larger;
<a name="l00098"></a>00098         }
<a name="l00099"></a>00099         <span class="keywordflow">while</span> (current &lt; items.GetSize ());
<a name="l00100"></a>00100       }
<a name="l00101"></a>00101     <span class="keyword">public</span>:
<a name="l00103"></a><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#9bb82743aa9a3ba55f50dfffa1fc46b3">00103</a>       <span class="keywordtype">void</span> <a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#9bb82743aa9a3ba55f50dfffa1fc46b3" title="Insert an item.">Insert</a> (<span class="keyword">const</span> T&amp; what)
<a name="l00104"></a>00104       {
<a name="l00105"></a>00105         <span class="keywordtype">size_t</span> n = items.Push (what);
<a name="l00106"></a>00106         HeapifyUp (n);
<a name="l00107"></a>00107       }
<a name="l00108"></a>00108     
<a name="l00110"></a>00110 
<a name="l00111"></a><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#73c69e1f3601daec64e897ed71f8f3cb">00111</a>       T <a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#73c69e1f3601daec64e897ed71f8f3cb" title="Return and remove the largest item.">Pop</a> ()
<a name="l00112"></a>00112       {
<a name="l00113"></a>00113         T val = items[0];
<a name="l00114"></a>00114         items.DeleteIndexFast (0);
<a name="l00115"></a>00115         HeapifyDown (0);
<a name="l00116"></a>00116         <span class="keywordflow">return</span> val;
<a name="l00117"></a>00117       }
<a name="l00119"></a>00119     
<a name="l00121"></a>00121 
<a name="l00122"></a><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#81a81177dbc44413df8d0eabc634a20a">00122</a>       <span class="keyword">const</span> T&amp; <a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#81a81177dbc44413df8d0eabc634a20a" title="Return, but don&amp;#39;t remove, the largest item.">Top</a> ()<span class="keyword"> const</span>
<a name="l00123"></a>00123 <span class="keyword">      </span>{
<a name="l00124"></a>00124         <span class="keywordflow">return</span> items[0];
<a name="l00125"></a>00125       }
<a name="l00127"></a>00127 
<a name="l00134"></a>00134       <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T2&gt;
<a name="l00135"></a><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#0e18f7cb2dbac107f20ebab0182fc8a8">00135</a>       <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#0e18f7cb2dbac107f20ebab0182fc8a8" title="Remove largest item that is equal to what.">Delete</a> (<span class="keyword">const</span> T2&amp; what)
<a name="l00136"></a>00136       {
<a name="l00137"></a>00137         <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> n = 0; n &lt; items.GetSize(); n++)
<a name="l00138"></a>00138         {
<a name="l00139"></a>00139           <span class="keywordflow">if</span> (<a class="code" href="classcsComparator.html" title="A template providing various comparison and ordering functions.">csComparator&lt;T, T2&gt;::Compare</a> (items[n], what) == 0)
<a name="l00140"></a>00140           {
<a name="l00141"></a>00141             items.DeleteIndexFast (n);
<a name="l00142"></a>00142             HeapifyDown (n);
<a name="l00143"></a>00143             <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00144"></a>00144           }
<a name="l00145"></a>00145         }
<a name="l00146"></a>00146         <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00147"></a>00147       }
<a name="l00148"></a>00148     
<a name="l00150"></a><a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#b710e17271b315b768089f2884edd392">00150</a>       <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1Utility_1_1PriorityQueue.html#b710e17271b315b768089f2884edd392" title="Return whether items are still in the queue.">IsEmpty</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> items.IsEmpty(); }
<a name="l00151"></a>00151     };
<a name="l00152"></a>00152     
<a name="l00153"></a>00153   } <span class="comment">// namespace Utility</span>
<a name="l00154"></a>00154 } <span class="comment">// namespace CS</span>
<a name="l00155"></a>00155 
<a name="l00156"></a>00156 <span class="preprocessor">#endif // __CS_CSUTIL_PRIORTITYQUEUE_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>