mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
0df3f646fc
various bugfixes from github issues kmean with some frozen centroids GPU better tiling for large flat datasets default AVX for vector ops
183 lines
12 KiB
HTML
183 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::RangeSearchResult 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_1RangeSearchResult.html">RangeSearchResult</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structfaiss_1_1RangeSearchResult-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::RangeSearchResult Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="AuxIndexStructures_8h_source.html">AuxIndexStructures.h</a>></code></p>
|
|
<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:a7ac4dc6d5cae5f34f83c380481565281"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ac4dc6d5cae5f34f83c380481565281"></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:a7ac4dc6d5cae5f34f83c380481565281"><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:a56dca2b151bcf16f5d488aff321b9501"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56dca2b151bcf16f5d488aff321b9501"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#a56dca2b151bcf16f5d488aff321b9501">RangeSearchResult</a> (idx_t <a class="el" href="structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90">nq</a>, bool alloc_lims=true)</td></tr>
|
|
<tr class="memdesc:a56dca2b151bcf16f5d488aff321b9501"><td class="mdescLeft"> </td><td class="mdescRight">lims must be allocated on input to range_search. <br/></td></tr>
|
|
<tr class="separator:a56dca2b151bcf16f5d488aff321b9501"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34c4ba599c0cec45972af19e1f98f22a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#a34c4ba599c0cec45972af19e1f98f22a">do_allocation</a> ()</td></tr>
|
|
<tr class="separator:a34c4ba599c0cec45972af19e1f98f22a"><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:a29269b98c33af874d379ca4f62408b90"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29269b98c33af874d379ca4f62408b90"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90">nq</a></td></tr>
|
|
<tr class="memdesc:a29269b98c33af874d379ca4f62408b90"><td class="mdescLeft"> </td><td class="mdescRight">nb of queries <br/></td></tr>
|
|
<tr class="separator:a29269b98c33af874d379ca4f62408b90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef57f9db99ca470c01bcdce0366cb6ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef57f9db99ca470c01bcdce0366cb6ff"></a>
|
|
size_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff">lims</a></td></tr>
|
|
<tr class="memdesc:aef57f9db99ca470c01bcdce0366cb6ff"><td class="mdescLeft"> </td><td class="mdescRight">size (nq + 1) <br/></td></tr>
|
|
<tr class="separator:aef57f9db99ca470c01bcdce0366cb6ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8ff848474a4cc16c5464cc4ec187824"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8ff848474a4cc16c5464cc4ec187824"></a>
|
|
idx_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824">labels</a></td></tr>
|
|
<tr class="memdesc:aa8ff848474a4cc16c5464cc4ec187824"><td class="mdescLeft"> </td><td class="mdescRight">result for query i is labels[lims[i]:lims[i+1]] <br/></td></tr>
|
|
<tr class="separator:aa8ff848474a4cc16c5464cc4ec187824"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a944a93aecc7b51d8f9f35444280aa919"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a944a93aecc7b51d8f9f35444280aa919"></a>
|
|
float * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919">distances</a></td></tr>
|
|
<tr class="memdesc:a944a93aecc7b51d8f9f35444280aa919"><td class="mdescLeft"> </td><td class="mdescRight">corresponding distances (not sorted) <br/></td></tr>
|
|
<tr class="separator:a944a93aecc7b51d8f9f35444280aa919"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39342ad2e9ad8b90f6e95dafd3287f49"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39342ad2e9ad8b90f6e95dafd3287f49"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49">buffer_size</a></td></tr>
|
|
<tr class="memdesc:a39342ad2e9ad8b90f6e95dafd3287f49"><td class="mdescLeft"> </td><td class="mdescRight">size of the result buffers used <br/></td></tr>
|
|
<tr class="separator:a39342ad2e9ad8b90f6e95dafd3287f49"><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 objective is to have a simple result structure while minimizing the number of mem copies in the result. The method do_allocation can be overloaded to allocate the result tables in the matrix type of a scripting language like Lua or Python. </p>
|
|
|
|
<p>Definition at line <a class="el" href="AuxIndexStructures_8h_source.html#l00029">29</a> of file <a class="el" href="AuxIndexStructures_8h_source.html">AuxIndexStructures.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a34c4ba599c0cec45972af19e1f98f22a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::RangeSearchResult::do_allocation </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>called when lims contains the nb of elements result entries for each query </p>
|
|
|
|
<p>Definition at line <a class="el" href="AuxIndexStructures_8cpp_source.html#l00037">37</a> of file <a class="el" href="AuxIndexStructures_8cpp_source.html">AuxIndexStructures.cpp</a>.</p>
|
|
|
|
</div>
|
|
</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>
|