243 lines
13 KiB
HTML
243 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>etk Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1>etk Library</h1>
|
|
<li>etk</li>
|
|
<ul>
|
|
<li><a href="etk__Archive.html">Archive</a></li>
|
|
<li><a href="etk__Archive__Content.html">Archive::Content</a></li>
|
|
<li><a href="etk__BaseNoise.html">BaseNoise</a></li>
|
|
<li><a href="etk__Buffer.html">Buffer</a></li>
|
|
<li><a href="etk__CCout.html">CCout</a></li>
|
|
<li><a href="etk__CEndl.html">CEndl</a></li>
|
|
<li><a href="etk__CStart.html">CStart</a></li>
|
|
<li><a href="etk__Color.html">Color</a></li>
|
|
<li><a href="etk__FSNode.html">FSNode</a></li>
|
|
<li><a href="etk__FSNodeRight.html">FSNodeRight</a></li>
|
|
<li><a href="etk__Hash.html">Hash</a></li>
|
|
<li><a href="etk__HashData.html">HashData</a></li>
|
|
<li><a href="etk__Matrix4.html">Matrix4</a></li>
|
|
<li><a href="etk__MessageFifo.html">MessageFifo</a></li>
|
|
<li><a href="etk__Mutex.html">Mutex</a></li>
|
|
<li><a href="etk__Noise.html">Noise</a></li>
|
|
<li><a href="etk__Plane.html">Plane</a></li>
|
|
<li><a href="etk__RegExp.html">RegExp</a></li>
|
|
<li><a href="etk__RegExpNode.html">RegExpNode</a></li>
|
|
<li><a href="etk__RegExpNodeBracket.html">RegExpNodeBracket</a></li>
|
|
<li><a href="etk__RegExpNodeDigit.html">RegExpNodeDigit</a></li>
|
|
<li><a href="etk__RegExpNodeDigitNot.html">RegExpNodeDigitNot</a></li>
|
|
<li><a href="etk__RegExpNodeDot.html">RegExpNodeDot</a></li>
|
|
<li><a href="etk__RegExpNodeEOL.html">RegExpNodeEOL</a></li>
|
|
<li><a href="etk__RegExpNodeLetter.html">RegExpNodeLetter</a></li>
|
|
<li><a href="etk__RegExpNodeLetterNot.html">RegExpNodeLetterNot</a></li>
|
|
<li><a href="etk__RegExpNodePThese.html">RegExpNodePThese</a></li>
|
|
<li><a href="etk__RegExpNodePTheseElem.html">RegExpNodePTheseElem</a></li>
|
|
<li><a href="etk__RegExpNodeSOL.html">RegExpNodeSOL</a></li>
|
|
<li><a href="etk__RegExpNodeValue.html">RegExpNodeValue</a></li>
|
|
<li><a href="etk__RegExpNodeWhiteSpace.html">RegExpNodeWhiteSpace</a></li>
|
|
<li><a href="etk__RegExpNodeWhiteSpaceNot.html">RegExpNodeWhiteSpaceNot</a></li>
|
|
<li><a href="etk__RegExpNodeWordChar.html">RegExpNodeWordChar</a></li>
|
|
<li><a href="etk__RegExpNodeWordCharNot.html">RegExpNodeWordCharNot</a></li>
|
|
<li><a href="etk__Semaphore.html">Semaphore</a></li>
|
|
<li><a href="etk__UChar.html">UChar</a></li>
|
|
<li><a href="etk__Vector2D.html">Vector2D</a></li>
|
|
<li><a href="etk__Vector3D.html">Vector3D</a></li>
|
|
<li><a href="etk__Vector4D.html">Vector4D</a></li>
|
|
<li><a href="etk__archive__Zip.html">archive::Zip</a></li>
|
|
<li><a href="etk__elementPos_ts.html">elementPos_ts</a></li>
|
|
</ul>
|
|
<li><a href="etk__FSNType.html">FSNType</a></li>
|
|
<li><a href="etk__logLevel.html">logLevel</a></li>
|
|
<li><a href="etk__regExpPrivateSection.html">regExpPrivateSection</a></li>
|
|
<li><a href="etk__seekNode.html">seekNode</a></li>
|
|
<li><a href="etk__typeNode.html">typeNode</a></li>
|
|
</ul>
|
|
<li>unicode</li>
|
|
<ul>
|
|
<li><a href="unicode__charset.html">charset</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>Class: etk::Hash</h1>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#Hash">Hash</a> (<span class="code-type">int32_t</span> <span class="code-argument">_count</span>);<br>+ ~<a class="code-function" href="#Hash">Hash</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#clear">clear</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int64_t</span> <a class="code-function" href="#getId">getId</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#exist">exist</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);<br>+ MY_TYPE & <a class="code-function" href="#get">get</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ MY_TYPE & <a class="code-function" href="#operator[]">operator[]</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-storage-keyword">const</span> MY_TYPE & <a class="code-function" href="#operator[]">operator[]</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#add">add</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>,<br/> <span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-argument">_value</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#set">set</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>,<br/> <span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-argument">_value</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#remove">remove</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#size">size</a> (<span class="code-type">void</span>);<br>+ MY_TYPE & <a class="code-function" href="#operator[]">operator[]</a> (<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);<br>+ <span class="code-storage-keyword">const</span> MY_TYPE & <a class="code-function" href="#operator[]">operator[]</a> (<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <a class="code-function" href="#getKey">getKey</a> (<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);<br>+ <span class="code-storage-keyword">const</span> MY_TYPE & <a class="code-function" href="#getValue">getValue</a> (<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);<br>+ MY_TYPE & <a class="code-function" href="#getValue">getValue</a> (<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);<br></pre>
|
|
|
|
|
|
<h2>Detail:<h2>
|
|
<h3>etk::<a id="Hash">Hash</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Hash</span>(<span class="code-type">int32_t</span> <span class="code-argument">_count</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>etk::~<a id="Hash">Hash</a> ()</h3>
|
|
|
|
<pre>
|
|
~<span class="code-function">Hash</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="clear">clear</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">clear</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Remove all entry in the Hash table
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getId">getId</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int64_t</span> <span class="code-function">getId</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Get a current element ID in the Hash table
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the hash requested
|
|
<br/><b>Return:</b> Id of the element in the table or -1 of it does not existed
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="exist">exist</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">exist</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
Check if an element exist or not
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the hash requested
|
|
<br/><b>Return:</b> true if the element exist
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="get">get</a> ()</h3>
|
|
|
|
<pre>
|
|
MY_TYPE & <span class="code-function">get</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Get a current element in the vector
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the hash requested
|
|
<br/><b>Return:</b> Reference on the Element
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="operator[]">operator[]</a> ()</h3>
|
|
|
|
<pre>
|
|
MY_TYPE & <span class="code-function">operator[]</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Get an copy Element an a special position
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the hash requested
|
|
<br/><b>Return:</b> An reference on the copy of selected element
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="operator[]">operator[]</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-function">operator[]</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="add">add</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">add</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>,
|
|
<span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-argument">_value</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="set">set</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">set</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>,
|
|
<span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-argument">_value</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="remove">remove</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">remove</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="size">size</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int32_t</span> <span class="code-function">size</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the number of element in the hash table
|
|
<br/><ul>
|
|
<b>Return:</b> number of elements
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="operator[]">operator[]</a> ()</h3>
|
|
|
|
<pre>
|
|
MY_TYPE & <span class="code-function">operator[]</span>(<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="operator[]">operator[]</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-function">operator[]</span>(<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getKey">getKey</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-function">getKey</span>(<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getValue">getValue</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> MY_TYPE & <span class="code-function">getValue</span>(<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getValue">getValue</a> ()</h3>
|
|
|
|
<pre>
|
|
MY_TYPE & <span class="code-function">getValue</span>(<span class="code-type">size_t</span> <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|