Česky
Kamil Dudka

Share Library (C++)

Back Back to main page

File detail

Back Go to directory
Name:DownloadclassShare_1_1Map.html [Download]
Location: sharelib > api
Size:15.2 KB
Last modification:2022-09-09 13:06

Source code

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ShareLibrary: Share::Map&lt; TKey, TValue, TAllocator &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<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="annotated.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="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="namespaceShare.html">Share</a>::<a class="el" href="classShare_1_1Map.html">Map</a></div>
<h1>Share::Map&lt; TKey, TValue, TAllocator &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__stl.html">Leight-weight implementation of some STL containers</a>]</small>
</h1><!-- doxytag: class="Share::Map" -->STL map.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sharelib_8h-source.html">sharelib.h</a>&gt;</code>
<p>
<a href="classShare_1_1Map-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="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#6ebb91340e5270e7a2b8a5d439c47655">Map</a> (size_type htSize=defaultHtSize)</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#e5f50059db712ae874312f216bf3bbf9">~Map</a> ()</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#7085b0f4e59a27266b44ac5da4df6821">clear</a> ()</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#1923a68a1dabf4d9bcc4afe32939b2b1">find</a> (const TKey &amp;key)</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Look up for key in map by key.  <a href="#1923a68a1dabf4d9bcc4afe32939b2b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TValue &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#672646eac53e95852fa263751f92c979">operator[]</a> (const TKey &amp;key)</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">indexer  <a href="#672646eac53e95852fa263751f92c979"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#11c976b8d8bd46ead6c2c01742aa5d19">begin</a> () const</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map.html#2812de4f91367b44c1c98951016e8a6d">end</a> () const</td></tr>
 
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a></td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">STL map <a class="el" href="classShare_1_1Map_1_1const__iterator.html" title="STL map const_iterator equivalent.">const_iterator</a> equivalent.  <a href="classShare_1_1Map_1_1const__iterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>Item</b></td></tr>
 
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt;<br>
 class Share::Map&lt; TKey, TValue, TAllocator &gt;</h3>
 
STL map. 
<p>
Light-weight implementation of std::map<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>TKey</em>&nbsp;</td><td>Type of map key </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>TValue</em>&nbsp;</td><td>Type of map value </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>TAllocator</em>&nbsp;</td><td>Type of allocator for container. Default is <b>std::allocator</b>. For sharing use <a class="el" href="classShare_1_1Allocator.html" title="STL allocator.">Share::Allocator</a> instead. </td></tr>
  </table>
</dl>
 
<p>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01196">1196</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="6ebb91340e5270e7a2b8a5d439c47655"></a><!-- doxytag: member="Share::Map::Map" ref="6ebb91340e5270e7a2b8a5d439c47655" args="(size_type htSize=defaultHtSize)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::<a class="el" href="classShare_1_1Map.html">Map</a>           </td>
          <td>(</td>
          <td class="paramtype">size_type&nbsp;</td>
          <td class="paramname"> <em>htSize</em> = <code>defaultHtSize</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>htSize</em>&nbsp;</td><td>Size of hash table </td></tr>
  </table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This is not standardized constructor. </dd></dl>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01214">1214</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
</div>
</div><p>
<a class="anchor" name="e5f50059db712ae874312f216bf3bbf9"></a><!-- doxytag: member="Share::Map::~Map" ref="e5f50059db712ae874312f216bf3bbf9" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::~<a class="el" href="classShare_1_1Map.html">Map</a>           </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>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01326">1326</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7085b0f4e59a27266b44ac5da4df6821"></a><!-- doxytag: member="Share::Map::clear" ref="7085b0f4e59a27266b44ac5da4df6821" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::clear           </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>
Remove all items from map. 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01334">1334</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
</div>
</div><p>
<a class="anchor" name="1923a68a1dabf4d9bcc4afe32939b2b1"></a><!-- doxytag: member="Share::Map::find" ref="1923a68a1dabf4d9bcc4afe32939b2b1" args="(const TKey &amp;key)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a> <a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::find           </td>
          <td>(</td>
          <td class="paramtype">const TKey &amp;&nbsp;</td>
          <td class="paramname"> <em>key</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Look up for key in map by key. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>to look up </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return iterator of found item, <a class="el" href="classShare_1_1Map.html#2812de4f91367b44c1c98951016e8a6d">end()</a> if not found. </dd></dl>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01353">1353</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
</div>
</div><p>
<a class="anchor" name="672646eac53e95852fa263751f92c979"></a><!-- doxytag: member="Share::Map::operator[]" ref="672646eac53e95852fa263751f92c979" args="(const TKey &amp;key)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">TValue&amp; <a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::operator[]           </td>
          <td>(</td>
          <td class="paramtype">const TKey &amp;&nbsp;</td>
          <td class="paramname"> <em>key</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
indexer 
<p>
Look up for pair in map by key. New <a class="el" href="structShare_1_1Pair.html" title="STL pair.">Pair</a> is created if key is not found. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>to look up </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return reference to value. </dd></dl>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01369">1369</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
<p>
References <a class="el" href="sharelib_8h-source.html#l01179">Share::Pair&lt; TFirst, TSecond &gt;::first</a>, and <a class="el" href="sharelib_8h-source.html#l01180">Share::Pair&lt; TFirst, TSecond &gt;::second</a>.
</div>
</div><p>
<a class="anchor" name="11c976b8d8bd46ead6c2c01742aa5d19"></a><!-- doxytag: member="Share::Map::begin" ref="11c976b8d8bd46ead6c2c01742aa5d19" args="() const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a> <a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::begin           </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>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return iterator to begin of map. </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>There is no way to get map elements in specified order by <a class="el" href="classShare_1_1Map_1_1const__iterator.html" title="STL map const_iterator equivalent.">const_iterator</a> </dd></dl>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01395">1395</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
</div>
</div><p>
<a class="anchor" name="2812de4f91367b44c1c98951016e8a6d"></a><!-- doxytag: member="Share::Map::end" ref="2812de4f91367b44c1c98951016e8a6d" args="() const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey, class TValue, class TAllocator = std::allocator&lt; Pair&lt;TKey, TValue&gt; &gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classShare_1_1Map_1_1const__iterator.html">const_iterator</a> <a class="el" href="classShare_1_1Map.html">Share::Map</a>&lt; TKey, TValue, TAllocator &gt;::end           </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>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return iterator to element behind end of map. </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>There is no way to get map elements in specified order by <a class="el" href="classShare_1_1Map_1_1const__iterator.html" title="STL map const_iterator equivalent.">const_iterator</a> </dd></dl>
 
<p>
Definition at line <a class="el" href="sharelib_8h-source.html#l01405">1405</a> of file <a class="el" href="sharelib_8h-source.html">sharelib.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>sharelib/<a class="el" href="sharelib_8h-source.html">sharelib.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 26 17:43:03 2007 for ShareLibrary by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>