Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1basic__hash.html

262 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::basic_hash&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1basic__hash.html">basic_hash</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1basic__hash-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::basic_hash&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Basic hashing operations.
<a href="classstdex_1_1basic__hash.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="hash_8hpp_source.html">stdex/hash.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stdex::basic_hash&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1basic__hash.png" usemap="#stdex::basic_5Fhash_3C_20T_20_3E_map" alt=""/>
<map id="stdex::basic_5Fhash_3C_20T_20_3E_map" name="stdex::basic_5Fhash_3C_20T_20_3E_map">
<area href="classstdex_1_1block__hash.html" alt="stdex::block_hash&lt; md5_t &gt;" shape="rect" coords="0,56,172,80"/>
<area href="classstdex_1_1block__hash.html" alt="stdex::block_hash&lt; sha1_t &gt;" shape="rect" coords="182,56,354,80"/>
<area href="classstdex_1_1block__hash.html" title="Hashing in blocks." alt="stdex::block_hash&lt; T &gt;" shape="rect" coords="364,56,536,80"/>
<area href="classstdex_1_1md5__hash.html" title="Hashes as MD5." alt="stdex::md5_hash" shape="rect" coords="0,112,172,136"/>
<area href="classstdex_1_1sha1__hash.html" title="Hashes as SHA1." alt="stdex::sha1_hash" shape="rect" coords="182,112,354,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af5e2ff7b83da5a663fa3c9766734b771" id="r_af5e2ff7b83da5a663fa3c9766734b771"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1basic__hash.html#af5e2ff7b83da5a663fa3c9766734b771">clear</a> ()=0</td></tr>
<tr class="memdesc:af5e2ff7b83da5a663fa3c9766734b771"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes hash value and internal state. <br /></td></tr>
<tr class="separator:af5e2ff7b83da5a663fa3c9766734b771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a198a7f9e606ac26dbd5a345108e5efc9" id="r_a198a7f9e606ac26dbd5a345108e5efc9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1basic__hash.html#a198a7f9e606ac26dbd5a345108e5efc9">hash</a> (_In_reads_bytes_opt_(length) const void *<a class="el" href="classstdex_1_1basic__hash.html#a00c5ecc12bc29e5381743fa2239a1dc3">data</a>, size_t length)=0</td></tr>
<tr class="memdesc:a198a7f9e606ac26dbd5a345108e5efc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hashes block of data. <br /></td></tr>
<tr class="separator:a198a7f9e606ac26dbd5a345108e5efc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2f4729c60bbb2ce12d5100be26108cf" id="r_ab2f4729c60bbb2ce12d5100be26108cf"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1basic__hash.html#ab2f4729c60bbb2ce12d5100be26108cf">finalize</a> ()=0</td></tr>
<tr class="memdesc:ab2f4729c60bbb2ce12d5100be26108cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes hash value. <br /></td></tr>
<tr class="separator:ab2f4729c60bbb2ce12d5100be26108cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00c5ecc12bc29e5381743fa2239a1dc3" id="r_a00c5ecc12bc29e5381743fa2239a1dc3"><td class="memItemLeft" align="right" valign="top"><a id="a00c5ecc12bc29e5381743fa2239a1dc3" name="a00c5ecc12bc29e5381743fa2239a1dc3"></a>
const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> ()</td></tr>
<tr class="memdesc:a00c5ecc12bc29e5381743fa2239a1dc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns hash value. <br /></td></tr>
<tr class="separator:a00c5ecc12bc29e5381743fa2239a1dc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cacac78cdfbf561da8d9f1a5841c5cb" id="r_a7cacac78cdfbf561da8d9f1a5841c5cb"><td class="memItemLeft" align="right" valign="top"><a id="a7cacac78cdfbf561da8d9f1a5841c5cb" name="a7cacac78cdfbf561da8d9f1a5841c5cb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator const T &amp;</b> () const</td></tr>
<tr class="memdesc:a7cacac78cdfbf561da8d9f1a5841c5cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns hash value. <br /></td></tr>
<tr class="separator:a7cacac78cdfbf561da8d9f1a5841c5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9b8b5f91873e5d2cfe93533832318b5a" id="r_a9b8b5f91873e5d2cfe93533832318b5a"><td class="memItemLeft" align="right" valign="top"><a id="a9b8b5f91873e5d2cfe93533832318b5a" name="a9b8b5f91873e5d2cfe93533832318b5a"></a>
static size_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> ()</td></tr>
<tr class="memdesc:a9b8b5f91873e5d2cfe93533832318b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns size of the hash value in bytes. <br /></td></tr>
<tr class="separator:a9b8b5f91873e5d2cfe93533832318b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:abc45b9744ef54b261e16d795479fd0ec" id="r_abc45b9744ef54b261e16d795479fd0ec"><td class="memItemLeft" align="right" valign="top"><a id="abc45b9744ef54b261e16d795479fd0ec" name="abc45b9744ef54b261e16d795479fd0ec"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_value</b></td></tr>
<tr class="separator:abc45b9744ef54b261e16d795479fd0ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T&gt;<br />
class stdex::basic_hash&lt; T &gt;</div><p>Basic hashing operations. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af5e2ff7b83da5a663fa3c9766734b771" name="af5e2ff7b83da5a663fa3c9766734b771"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5e2ff7b83da5a663fa3c9766734b771">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1basic__hash.html">stdex::basic_hash</a>&lt; T &gt;::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes hash value and internal state. </p>
<p>Implemented in <a class="el" href="classstdex_1_1block__hash.html#a8750f9c24cd22bd879dc638256534aec">stdex::block_hash&lt; T &gt;</a>, <a class="el" href="classstdex_1_1block__hash.html#a8750f9c24cd22bd879dc638256534aec">stdex::block_hash&lt; md5_t &gt;</a>, <a class="el" href="classstdex_1_1block__hash.html#a8750f9c24cd22bd879dc638256534aec">stdex::block_hash&lt; sha1_t &gt;</a>, <a class="el" href="classstdex_1_1crc32__hash.html#addf745566fe5a1ba3f947a70603ea235">stdex::crc32_hash</a>, <a class="el" href="classstdex_1_1md5__hash.html#a0952042043c10e184d9ee8a79421cc0f">stdex::md5_hash</a>, and <a class="el" href="classstdex_1_1sha1__hash.html#a36f38887f8e90f88df0a420f0011b9b3">stdex::sha1_hash</a>.</p>
</div>
</div>
<a id="ab2f4729c60bbb2ce12d5100be26108cf" name="ab2f4729c60bbb2ce12d5100be26108cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2f4729c60bbb2ce12d5100be26108cf">&#9670;&#160;</a></span>finalize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1basic__hash.html">stdex::basic_hash</a>&lt; T &gt;::finalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalizes hash value. </p>
<p>Implemented in <a class="el" href="classstdex_1_1crc32__hash.html#a04aeb2009f5e615481752757b9ec0731">stdex::crc32_hash</a>, <a class="el" href="classstdex_1_1md5__hash.html#ab72e50dfa280696db29143b063fccbcb">stdex::md5_hash</a>, and <a class="el" href="classstdex_1_1sha1__hash.html#aaf5f58e8b62d19d1fcc80b4f73f9ca8d">stdex::sha1_hash</a>.</p>
</div>
</div>
<a id="a198a7f9e606ac26dbd5a345108e5efc9" name="a198a7f9e606ac26dbd5a345108e5efc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a198a7f9e606ac26dbd5a345108e5efc9">&#9670;&#160;</a></span>hash()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1basic__hash.html">stdex::basic_hash</a>&lt; T &gt;::hash </td>
<td>(</td>
<td class="paramtype">_In_reads_bytes_opt_(length) const void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Hashes block of data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Amount of data in bytes </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classstdex_1_1block__hash.html#a463399ef0ec15ec0be0040ffa16afbbb">stdex::block_hash&lt; T &gt;</a>, <a class="el" href="classstdex_1_1block__hash.html#a463399ef0ec15ec0be0040ffa16afbbb">stdex::block_hash&lt; md5_t &gt;</a>, <a class="el" href="classstdex_1_1block__hash.html#a463399ef0ec15ec0be0040ffa16afbbb">stdex::block_hash&lt; sha1_t &gt;</a>, and <a class="el" href="classstdex_1_1crc32__hash.html#a682468b5c1e7fe3405e960c7d85daa8c">stdex::crc32_hash</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="hash_8hpp_source.html">hash.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 25 2023 13:06:10 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink