Files
libaaruformat/docs/html/spamsum_8h.html

257 lines
13 KiB
HTML

<!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.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/spamsum.h File 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('spamsum_8h.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">spamsum.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="spamsum_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:blockhash_5Fctx" id="r_blockhash_5Fctx"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structblockhash__ctx.html">blockhash_ctx</a></td></tr>
<tr class="memitem:roll_5Fstate" id="r_roll_5Fstate"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structroll__state.html">roll_state</a></td></tr>
<tr class="memitem:spamsum_5Fctx" id="r_spamsum_5Fctx"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structspamsum__ctx.html">spamsum_ctx</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a137a76507c72a195455009b62e28c671" id="r_a137a76507c72a195455009b62e28c671"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a137a76507c72a195455009b62e28c671">SPAMSUM_LENGTH</a>&#160;&#160;&#160;64</td></tr>
<tr class="memitem:ab05c87bf87434740e1400b8f7fc9cbaa" id="r_ab05c87bf87434740e1400b8f7fc9cbaa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab05c87bf87434740e1400b8f7fc9cbaa">NUM_BLOCKHASHES</a>&#160;&#160;&#160;31</td></tr>
<tr class="memitem:a6e3701d1edb7f42493d091d7202fa299" id="r_a6e3701d1edb7f42493d091d7202fa299"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e3701d1edb7f42493d091d7202fa299">ROLLING_WINDOW</a>&#160;&#160;&#160;7</td></tr>
<tr class="memitem:adcd60db457233e4a407009f6d4ceea48" id="r_adcd60db457233e4a407009f6d4ceea48"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adcd60db457233e4a407009f6d4ceea48">HASH_INIT</a>&#160;&#160;&#160;0x28021967</td></tr>
<tr class="memitem:a3340643b9fb0a58333f04e75ff897e03" id="r_a3340643b9fb0a58333f04e75ff897e03"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3340643b9fb0a58333f04e75ff897e03">HASH_PRIME</a>&#160;&#160;&#160;0x01000193</td></tr>
<tr class="memitem:ac5fb50a0e20885df11be19a6b5449749" id="r_ac5fb50a0e20885df11be19a6b5449749"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac5fb50a0e20885df11be19a6b5449749">MIN_BLOCKSIZE</a>&#160;&#160;&#160;3</td></tr>
<tr class="memitem:a2309f23e98c4c0370f32e3e3cb09afa5" id="r_a2309f23e98c4c0370f32e3e3cb09afa5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2309f23e98c4c0370f32e3e3cb09afa5">FUZZY_MAX_RESULT</a>&#160;&#160;&#160;((2 * <a class="el" href="#a137a76507c72a195455009b62e28c671">SPAMSUM_LENGTH</a>) + 20)</td></tr>
</table>
<a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
<a id="a2309f23e98c4c0370f32e3e3cb09afa5" name="a2309f23e98c4c0370f32e3e3cb09afa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2309f23e98c4c0370f32e3e3cb09afa5">&#9670;&#160;</a></span>FUZZY_MAX_RESULT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUZZY_MAX_RESULT&#160;&#160;&#160;((2 * <a class="el" href="#a137a76507c72a195455009b62e28c671">SPAMSUM_LENGTH</a>) + 20)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00030">30</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="spamsum_8c_source.html#l00191">aaruf_spamsum_final()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="adcd60db457233e4a407009f6d4ceea48" name="adcd60db457233e4a407009f6d4ceea48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcd60db457233e4a407009f6d4ceea48">&#9670;&#160;</a></span>HASH_INIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HASH_INIT&#160;&#160;&#160;0x28021967</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00027">27</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="spamsum_8c_source.html#l00037">aaruf_spamsum_init()</a>, and <a class="el" href="spamsum_8c_source.html#l00084">fuzzy_engine_step()</a>.</p>
</div>
</div>
<a id="a3340643b9fb0a58333f04e75ff897e03" name="a3340643b9fb0a58333f04e75ff897e03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3340643b9fb0a58333f04e75ff897e03">&#9670;&#160;</a></span>HASH_PRIME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HASH_PRIME&#160;&#160;&#160;0x01000193</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00028">28</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
</div>
</div>
<a id="ac5fb50a0e20885df11be19a6b5449749" name="ac5fb50a0e20885df11be19a6b5449749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5fb50a0e20885df11be19a6b5449749">&#9670;&#160;</a></span>MIN_BLOCKSIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MIN_BLOCKSIZE&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00029">29</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
</div>
</div>
<a id="ab05c87bf87434740e1400b8f7fc9cbaa" name="ab05c87bf87434740e1400b8f7fc9cbaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab05c87bf87434740e1400b8f7fc9cbaa">&#9670;&#160;</a></span>NUM_BLOCKHASHES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NUM_BLOCKHASHES&#160;&#160;&#160;31</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00025">25</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="spamsum_8c_source.html#l00191">aaruf_spamsum_final()</a>, and <a class="el" href="spamsum_8c_source.html#l00175">fuzzy_try_fork_blockhash()</a>.</p>
</div>
</div>
<a id="a6e3701d1edb7f42493d091d7202fa299" name="a6e3701d1edb7f42493d091d7202fa299"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e3701d1edb7f42493d091d7202fa299">&#9670;&#160;</a></span>ROLLING_WINDOW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ROLLING_WINDOW&#160;&#160;&#160;7</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00026">26</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="spamsum_8c_source.html#l00137">roll_hash()</a>.</p>
</div>
</div>
<a id="a137a76507c72a195455009b62e28c671" name="a137a76507c72a195455009b62e28c671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a137a76507c72a195455009b62e28c671">&#9670;&#160;</a></span>SPAMSUM_LENGTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SPAMSUM_LENGTH&#160;&#160;&#160;64</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="spamsum_8h_source.html#l00024">24</a> of file <a class="el" href="spamsum_8h_source.html">spamsum.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="spamsum_8c_source.html#l00191">aaruf_spamsum_final()</a>, <a class="el" href="spamsum_8c_source.html#l00084">fuzzy_engine_step()</a>, and <a class="el" href="spamsum_8c_source.html#l00155">fuzzy_try_reduce_blockhash()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="spamsum_8h.html">spamsum.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>