faiss/docs/html/structfaiss_1_1SemiSortedAr...

167 lines
12 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::SemiSortedArray&lt; T &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_1SemiSortedArray.html">SemiSortedArray</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1SemiSortedArray-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::SemiSortedArray&lt; T &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a69baefdac53c1e6224f7325dbcda2329"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69baefdac53c1e6224f7325dbcda2329"></a>
typedef <a class="el" href="structfaiss_1_1CMax.html">CMax</a>&lt; T, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>HC</b></td></tr>
<tr class="separator:a69baefdac53c1e6224f7325dbcda2329"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a17b996fc5afdf0a2da8b17da609249c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17b996fc5afdf0a2da8b17da609249c5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SemiSortedArray</b> (int N)</td></tr>
<tr class="separator:a17b996fc5afdf0a2da8b17da609249c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e227018dc8ed022fa3d41c3efb33e14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e227018dc8ed022fa3d41c3efb33e14"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>init</b> (const T *x)</td></tr>
<tr class="separator:a0e227018dc8ed022fa3d41c3efb33e14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b7e3826daa8964a3be0ea16b4abf608"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b7e3826daa8964a3be0ea16b4abf608"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1SemiSortedArray.html#a9b7e3826daa8964a3be0ea16b4abf608">grow</a> (int next_k)</td></tr>
<tr class="memdesc:a9b7e3826daa8964a3be0ea16b4abf608"><td class="mdescLeft">&#160;</td><td class="mdescRight">grow the sorted part of the array to size next_k <br/></td></tr>
<tr class="separator:a9b7e3826daa8964a3be0ea16b4abf608"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72daedcee2bc6b5516afde28c427765d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72daedcee2bc6b5516afde28c427765d"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>get_0</b> ()</td></tr>
<tr class="separator:a72daedcee2bc6b5516afde28c427765d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac47cb32876ebe4a579dc086d103cbc15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac47cb32876ebe4a579dc086d103cbc15"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>get_diff</b> (int n)</td></tr>
<tr class="separator:ac47cb32876ebe4a579dc086d103cbc15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a60b87aaa45120342836ad9e964b88e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a60b87aaa45120342836ad9e964b88e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>get_ord</b> (int n)</td></tr>
<tr class="separator:a8a60b87aaa45120342836ad9e964b88e"><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:ac4079a3ec8ae682e8c75efc4a5af65af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4079a3ec8ae682e8c75efc4a5af65af"></a>
const T *&#160;</td><td class="memItemRight" valign="bottom"><b>x</b></td></tr>
<tr class="separator:ac4079a3ec8ae682e8c75efc4a5af65af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a346289175033adc8aa273282eb072af9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a346289175033adc8aa273282eb072af9"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>N</b></td></tr>
<tr class="separator:a346289175033adc8aa273282eb072af9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10cb2f3081c6ce04378f765d7cbce5fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10cb2f3081c6ce04378f765d7cbce5fe"></a>
std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>perm</b></td></tr>
<tr class="separator:a10cb2f3081c6ce04378f765d7cbce5fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29448a79f538f4ba488b6a84b6877a8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29448a79f538f4ba488b6a84b6877a8e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>k</b></td></tr>
<tr class="separator:a29448a79f538f4ba488b6a84b6877a8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6648c5c56189bde1c253c6dc5418c4ce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6648c5c56189bde1c253c6dc5418c4ce"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>initial_k</b></td></tr>
<tr class="separator:a6648c5c56189bde1c253c6dc5418c4ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad360ec523077e5f22e0abc9d29e05dc1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad360ec523077e5f22e0abc9d29e05dc1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>k_factor</b></td></tr>
<tr class="separator:ad360ec523077e5f22e0abc9d29e05dc1"><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;typename T&gt;<br/>
struct faiss::SemiSortedArray&lt; T &gt;</h3>
<p>same as <a class="el" href="structfaiss_1_1SortedArray.html">SortedArray</a>, but only the k first elements are sorted </p>
<p>Definition at line <a class="el" href="IndexPQ_8cpp_source.html#l00546">546</a> of file <a class="el" href="IndexPQ_8cpp_source.html">IndexPQ.cpp</a>.</p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexPQ_8cpp_source.html">IndexPQ.cpp</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>