Sophie

Sophie

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

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: CS::Utility::PriorityQueue&lt; T, Container &gt; Class Template Reference (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 class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1Utility.html">Utility</a>::<a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html">PriorityQueue</a></div>
<h1>CS::Utility::PriorityQueue&lt; T, Container &gt; Class Template Reference</h1><!-- doxytag: class="CS::Utility::PriorityQueue" -->An implementation of a priority queue.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="priorityqueue_8h-source.html">csutil/priorityqueue.h</a>&gt;</code>
<p>

<p>
<a href="classCS_1_1Utility_1_1PriorityQueue-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename T2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html#0e18f7cb2dbac107f20ebab0182fc8a8">Delete</a> (const T2 &amp;what)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove largest item that is equal to <em>what</em>.  <a href="#0e18f7cb2dbac107f20ebab0182fc8a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html#9bb82743aa9a3ba55f50dfffa1fc46b3">Insert</a> (const T &amp;what)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Insert an item.  <a href="#9bb82743aa9a3ba55f50dfffa1fc46b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html#b710e17271b315b768089f2884edd392">IsEmpty</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return whether items are still in the queue.  <a href="#b710e17271b315b768089f2884edd392"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html#73c69e1f3601daec64e897ed71f8f3cb">Pop</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return and remove the largest item.  <a href="#73c69e1f3601daec64e897ed71f8f3cb"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html#81a81177dbc44413df8d0eabc634a20a">Top</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return, but don't remove, the largest item.  <a href="#81a81177dbc44413df8d0eabc634a20a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename T, class Container = csArray&lt;T&gt;&gt;<br>
 class CS::Utility::PriorityQueue&lt; T, Container &gt;</h3>

An implementation of a priority queue. 
<p>
<em>T</em> must be comparable with csComparator&lt;&gt;. Larger items are returned first. 
<p>Definition at line <a class="el" href="priorityqueue_8h-source.html#l00039">39</a> of file <a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0e18f7cb2dbac107f20ebab0182fc8a8"></a><!-- doxytag: member="CS::Utility::PriorityQueue::Delete" ref="0e18f7cb2dbac107f20ebab0182fc8a8" args="(const T2 &amp;what)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, class Container = csArray&lt;T&gt;&gt; </div>
<div class="memtemplate">
template&lt;typename T2&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html">CS::Utility::PriorityQueue</a>&lt; T, Container &gt;::Delete           </td>
          <td>(</td>
          <td class="paramtype">const T2 &amp;&nbsp;</td>
          <td class="paramname"> <em>what</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove largest item that is equal to <em>what</em>. 
<p>
The contained type <em>T</em> and the type <em>T2</em> of <em>what</em> must be comparable with csComparator&lt;&gt;. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether <em>item</em> was found and deleted. </dd></dl>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Does a linear search - slow. </dd></dl>

<p>Definition at line <a class="el" href="priorityqueue_8h-source.html#l00135">135</a> of file <a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="9bb82743aa9a3ba55f50dfffa1fc46b3"></a><!-- doxytag: member="CS::Utility::PriorityQueue::Insert" ref="9bb82743aa9a3ba55f50dfffa1fc46b3" args="(const T &amp;what)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, class Container = csArray&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html">CS::Utility::PriorityQueue</a>&lt; T, Container &gt;::Insert           </td>
          <td>(</td>
          <td class="paramtype">const T &amp;&nbsp;</td>
          <td class="paramname"> <em>what</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Insert an item. 
<p>

<p>Definition at line <a class="el" href="priorityqueue_8h-source.html#l00103">103</a> of file <a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b710e17271b315b768089f2884edd392"></a><!-- doxytag: member="CS::Utility::PriorityQueue::IsEmpty" ref="b710e17271b315b768089f2884edd392" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, class Container = csArray&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html">CS::Utility::PriorityQueue</a>&lt; T, Container &gt;::IsEmpty           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return whether items are still in the queue. 
<p>

<p>Definition at line <a class="el" href="priorityqueue_8h-source.html#l00150">150</a> of file <a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="73c69e1f3601daec64e897ed71f8f3cb"></a><!-- doxytag: member="CS::Utility::PriorityQueue::Pop" ref="73c69e1f3601daec64e897ed71f8f3cb" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, class Container = csArray&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T <a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html">CS::Utility::PriorityQueue</a>&lt; T, Container &gt;::Pop           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return and remove the largest item. 
<p>

<p>Definition at line <a class="el" href="priorityqueue_8h-source.html#l00111">111</a> of file <a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="81a81177dbc44413df8d0eabc634a20a"></a><!-- doxytag: member="CS::Utility::PriorityQueue::Top" ref="81a81177dbc44413df8d0eabc634a20a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, class Container = csArray&lt;T&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T&amp; <a class="el" href="classCS_1_1Utility_1_1PriorityQueue.html">CS::Utility::PriorityQueue</a>&lt; T, Container &gt;::Top           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return, but don't remove, the largest item. 
<p>

<p>Definition at line <a class="el" href="priorityqueue_8h-source.html#l00122">122</a> of file <a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="priorityqueue_8h-source.html">priorityqueue.h</a></ul>
<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>