faiss/docs/html/structfaiss_1_1HCounterStat...

153 lines
10 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: faiss::HCounterState&lt; HammingComputer &gt; Struct 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Faiss
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1HCounterState.html">HCounterState</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1HCounterState-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::HCounterState&lt; HammingComputer &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="hamming_8h_source.html">hamming.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aeade022d80ab6c324336ae7bd9262a0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeade022d80ab6c324336ae7bd9262a0c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HCounterState</b> (int *counters, long *ids_per_dis, const uint8_t *x, int d, int k)</td></tr>
<tr class="separator:aeade022d80ab6c324336ae7bd9262a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbc245f1f1e3dc91a0638fa093e2d4eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbc245f1f1e3dc91a0638fa093e2d4eb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>update_counter</b> (const uint8_t *y, size_t j)</td></tr>
<tr class="separator:acbc245f1f1e3dc91a0638fa093e2d4eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aba2730ef4714f1ec177994b37402ccfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba2730ef4714f1ec177994b37402ccfe"></a>
int *&#160;</td><td class="memItemRight" valign="bottom"><b>counters</b></td></tr>
<tr class="separator:aba2730ef4714f1ec177994b37402ccfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acae014e42abf02111d4bffd7701b5712"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acae014e42abf02111d4bffd7701b5712"></a>
long *&#160;</td><td class="memItemRight" valign="bottom"><b>ids_per_dis</b></td></tr>
<tr class="separator:acae014e42abf02111d4bffd7701b5712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8aa41122bfbca508167f6c62f2b8701"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8aa41122bfbca508167f6c62f2b8701"></a>
<a class="el" href="structfaiss_1_1HammingComputer.html">HammingComputer</a>&#160;</td><td class="memItemRight" valign="bottom"><b>hc</b></td></tr>
<tr class="separator:ac8aa41122bfbca508167f6c62f2b8701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af064903b7159141e0997d00be5790a96"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af064903b7159141e0997d00be5790a96"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>thres</b></td></tr>
<tr class="separator:af064903b7159141e0997d00be5790a96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf19dbccb8d0c988dc7ccdc0c6eb732"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbf19dbccb8d0c988dc7ccdc0c6eb732"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>count_lt</b></td></tr>
<tr class="separator:abbf19dbccb8d0c988dc7ccdc0c6eb732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b05f257aa65e0471f3bfe39f9f439ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b05f257aa65e0471f3bfe39f9f439ae"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>count_eq</b></td></tr>
<tr class="separator:a2b05f257aa65e0471f3bfe39f9f439ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4870c60387b35d4805fb3e5bff29ef08"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4870c60387b35d4805fb3e5bff29ef08"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>k</b></td></tr>
<tr class="separator:a4870c60387b35d4805fb3e5bff29ef08"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class HammingComputer&gt;<br/>
struct faiss::HCounterState&lt; HammingComputer &gt;</h3>
<p>This class maintains a list of best distances seen so far.</p>
<p>Since the distances are in a limited range (0 to nbit), the object maintains one list per possible distance, and fills in only the n-first lists, such that the sum of sizes of the n lists is below k. </p>
<p>Definition at line <a class="el" href="hamming_8h_source.html#l00530">530</a> of file <a class="el" href="hamming_8h_source.html">hamming.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="hamming_8h_source.html">hamming.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>