196 lines
17 KiB
HTML
196 lines
17 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::RangeSearchPartialResult Struct 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 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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_1RangeSearchPartialResult.html">RangeSearchPartialResult</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structfaiss_1_1RangeSearchPartialResult-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::RangeSearchPartialResult Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>the entries in the buffers are split per query
|
|
<a href="structfaiss_1_1RangeSearchPartialResult.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="AuxIndexStructures_8h_source.html">AuxIndexStructures.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::RangeSearchPartialResult:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfaiss_1_1RangeSearchPartialResult.png" usemap="#faiss::RangeSearchPartialResult_map" alt=""/>
|
|
<map id="faiss::RangeSearchPartialResult_map" name="faiss::RangeSearchPartialResult_map">
|
|
<area href="structfaiss_1_1BufferList.html" alt="faiss::BufferList" shape="rect" coords="0,0,191,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html">QueryResult</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">result structure for a single query <a href="structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html#details">More...</a><br/></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a41aaed4f59e7a6a99e2a643dfff483f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41aaed4f59e7a6a99e2a643dfff483f5"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RangeSearchPartialResult</b> (<a class="el" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *res_in)</td></tr>
|
|
<tr class="separator:a41aaed4f59e7a6a99e2a643dfff483f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a954c26beebb561a6c2b0f399c48a9db3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a954c26beebb561a6c2b0f399c48a9db3"></a>
|
|
<a class="el" href="structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html">QueryResult</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchPartialResult.html#a954c26beebb561a6c2b0f399c48a9db3">new_result</a> (idx_t qno)</td></tr>
|
|
<tr class="memdesc:a954c26beebb561a6c2b0f399c48a9db3"><td class="mdescLeft"> </td><td class="mdescRight">begin a new result <br/></td></tr>
|
|
<tr class="separator:a954c26beebb561a6c2b0f399c48a9db3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3443ee23c08ca510afd64334d6656f50"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3443ee23c08ca510afd64334d6656f50"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>finalize</b> ()</td></tr>
|
|
<tr class="separator:a3443ee23c08ca510afd64334d6656f50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6a385008493c7b630e4e7bc56e3da74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6a385008493c7b630e4e7bc56e3da74"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchPartialResult.html#ab6a385008493c7b630e4e7bc56e3da74">set_lims</a> ()</td></tr>
|
|
<tr class="memdesc:ab6a385008493c7b630e4e7bc56e3da74"><td class="mdescLeft"> </td><td class="mdescRight">called by range_search before do_allocation <br/></td></tr>
|
|
<tr class="separator:ab6a385008493c7b630e4e7bc56e3da74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6639358995ac081f8a931a7790d0caf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6639358995ac081f8a931a7790d0caf"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchPartialResult.html#aa6639358995ac081f8a931a7790d0caf">set_result</a> (bool incremental=false)</td></tr>
|
|
<tr class="memdesc:aa6639358995ac081f8a931a7790d0caf"><td class="mdescLeft"> </td><td class="mdescRight">called by range_search after do_allocation <br/></td></tr>
|
|
<tr class="separator:aa6639358995ac081f8a931a7790d0caf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1BufferList"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1BufferList')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1BufferList.html">faiss::BufferList</a></td></tr>
|
|
<tr class="memitem:a84f9e430297d10b693a7d0abbec20b9d inherit pub_methods_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84f9e430297d10b693a7d0abbec20b9d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BufferList</b> (size_t buffer_size)</td></tr>
|
|
<tr class="separator:a84f9e430297d10b693a7d0abbec20b9d inherit pub_methods_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa124ff3a7e6a98960e12a8b32bdaec42 inherit pub_methods_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa124ff3a7e6a98960e12a8b32bdaec42"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>append_buffer</b> ()</td></tr>
|
|
<tr class="separator:aa124ff3a7e6a98960e12a8b32bdaec42 inherit pub_methods_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa17f17a53b45bb39b0724d6493ab33c9 inherit pub_methods_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa17f17a53b45bb39b0724d6493ab33c9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>add</b> (idx_t id, float dis)</td></tr>
|
|
<tr class="separator:aa17f17a53b45bb39b0724d6493ab33c9 inherit pub_methods_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78b70417a9ba5b27553b3134f1190958 inherit pub_methods_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1BufferList.html#a78b70417a9ba5b27553b3134f1190958">copy_range</a> (size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis)</td></tr>
|
|
<tr class="separator:a78b70417a9ba5b27553b3134f1190958 inherit pub_methods_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </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:abb04ae29fc8721ebb0e49928f25158cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb04ae29fc8721ebb0e49928f25158cc"></a>
|
|
<a class="el" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> * </td><td class="memItemRight" valign="bottom"><b>res</b></td></tr>
|
|
<tr class="separator:abb04ae29fc8721ebb0e49928f25158cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82a2897c2659449ba54af2b64d5da4d2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82a2897c2659449ba54af2b64d5da4d2"></a>
|
|
std::vector< <a class="el" href="structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html">QueryResult</a> > </td><td class="memItemRight" valign="bottom"><b>queries</b></td></tr>
|
|
<tr class="separator:a82a2897c2659449ba54af2b64d5da4d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1BufferList"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1BufferList')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1BufferList.html">faiss::BufferList</a></td></tr>
|
|
<tr class="memitem:a5eb5086d4b0f3904a6e4ad7a3b93d96a inherit pub_attribs_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5eb5086d4b0f3904a6e4ad7a3b93d96a"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>buffer_size</b></td></tr>
|
|
<tr class="separator:a5eb5086d4b0f3904a6e4ad7a3b93d96a inherit pub_attribs_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf92e38d902aabae3c6267e36e55f932 inherit pub_attribs_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf92e38d902aabae3c6267e36e55f932"></a>
|
|
std::vector< <a class="el" href="structfaiss_1_1BufferList_1_1Buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><b>buffers</b></td></tr>
|
|
<tr class="separator:abf92e38d902aabae3c6267e36e55f932 inherit pub_attribs_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4d7ddcd77f328a12a7da89d8febe5d9 inherit pub_attribs_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4d7ddcd77f328a12a7da89d8febe5d9"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9">wp</a></td></tr>
|
|
<tr class="memdesc:af4d7ddcd77f328a12a7da89d8febe5d9 inherit pub_attribs_structfaiss_1_1BufferList"><td class="mdescLeft"> </td><td class="mdescRight">write pointer in the last buffer. <br/></td></tr>
|
|
<tr class="separator:af4d7ddcd77f328a12a7da89d8febe5d9 inherit pub_attribs_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_structfaiss_1_1BufferList"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1BufferList')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1BufferList.html">faiss::BufferList</a></td></tr>
|
|
<tr class="memitem:a34f881c3691b14b7ed936374f4665d93 inherit pub_types_structfaiss_1_1BufferList"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34f881c3691b14b7ed936374f4665d93"></a>
|
|
typedef <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> </td><td class="memItemRight" valign="bottom"><b>idx_t</b></td></tr>
|
|
<tr class="separator:a34f881c3691b14b7ed936374f4665d93 inherit pub_types_structfaiss_1_1BufferList"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>the entries in the buffers are split per query </p>
|
|
|
|
<p>Definition at line <a class="el" href="AuxIndexStructures_8h_source.html#l00151">151</a> of file <a class="el" href="AuxIndexStructures_8h_source.html">AuxIndexStructures.h</a>.</p>
|
|
</div><hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="AuxIndexStructures_8h_source.html">AuxIndexStructures.h</a></li>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="AuxIndexStructures_8cpp_source.html">AuxIndexStructures.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|