faiss/docs/html/AuxIndexStructures__c_8cpp_...

313 lines
37 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: /tmp/faiss/c_api/AuxIndexStructures_c.cpp Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</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="dir_5fcc7c5aeda0d349161ae950b251beed.html">c_api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AuxIndexStructures_c.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;AuxIndexStructures_c.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;AuxIndexStructures.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;macros_impl.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1BufferList.html">faiss::BufferList</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1IDSelectorBatch.html">faiss::IDSelectorBatch</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1IDSelectorRange.html">faiss::IDSelectorRange</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html">faiss::RangeSearchResult</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">faiss::RangeSearchPartialResult</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>, <span class="keywordtype">size_t</span>, nq)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;int faiss_RangeSearchResult_new(FaissRangeSearchResult** p_rsr, idx_t nq) {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; *p_rsr = <span class="keyword">reinterpret_cast&lt;</span>FaissRangeSearchResult*<span class="keyword">&gt;</span>(</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">new</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>(nq));</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keywordtype">int</span> faiss_RangeSearchResult_new_with(FaissRangeSearchResult** p_rsr, idx_t nq, <span class="keywordtype">int</span> alloc_lims) {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; *p_rsr = <span class="keyword">reinterpret_cast&lt;</span>FaissRangeSearchResult*<span class="keyword">&gt;</span>(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">new</span> <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>(nq, static_cast&lt;bool&gt;(alloc_lims)));</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;}</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">/// called when lims contains the nb of elements result entries</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">/// for each query</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> faiss_RangeSearchResult_do_allocation(FaissRangeSearchResult* rsr) {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>*<span class="keyword">&gt;</span>(rsr)-&gt;do_allocation();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;DEFINE_DESTRUCTOR(<a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>)</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">/// getter for buffer_size</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"></span>DEFINE_GETTER(<a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>, <span class="keywordtype">size_t</span>, buffer_size)</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment">/// getter for lims: size (nq + 1)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"></span><span class="keywordtype">void</span> faiss_RangeSearchResult_lims(FaissRangeSearchResult* rsr, <span class="keywordtype">size_t</span>** lims) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; *lims = <span class="keyword">reinterpret_cast&lt;</span>RangeSearchResult*<span class="keyword">&gt;</span>(rsr)-&gt;lims;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment">/// getter for labels and respective distances (not sorted):</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment">/// result for query i is labels[lims[i]:lims[i+1]]</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"></span><span class="keywordtype">void</span> faiss_RangeSearchResult_labels(FaissRangeSearchResult* rsr, idx_t** labels, <span class="keywordtype">float</span>** distances) {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">auto</span> sr = <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>*<span class="keyword">&gt;</span>(rsr);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; *labels = sr-&gt;<a class="code" href="structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824">labels</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; *distances = sr-&gt;distances;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;}</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;DEFINE_DESTRUCTOR(<a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;int faiss_IDSelector_is_member(const FaissIDSelector* sel, idx_t <span class="keywordtype">id</span>) {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>*<span class="keyword">&gt;</span>(sel)-&gt;is_member(<span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;DEFINE_DESTRUCTOR(<a class="code" href="structfaiss_1_1IDSelectorRange.html">IDSelectorRange</a>)</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1IDSelectorRange.html">IDSelectorRange</a>, idx_t, imin)</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;DEFINE_GETTER(IDSelectorRange, idx_t, imax)</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="keywordtype">int</span> faiss_IDSelectorRange_new(FaissIDSelectorRange** p_sel, idx_t imin, idx_t imax) {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; *p_sel = <span class="keyword">reinterpret_cast&lt;</span>FaissIDSelectorRange*<span class="keyword">&gt;</span>(</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">new</span> IDSelectorRange(imin, imax)</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; );</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;}</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1IDSelectorBatch.html">IDSelectorBatch</a>, <span class="keywordtype">int</span>, nbits)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1IDSelectorBatch.html">IDSelectorBatch</a>, idx_t, mask)</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="keywordtype">int</span> faiss_IDSelectorBatch_new(FaissIDSelectorBatch** p_sel, <span class="keywordtype">long</span> n, const idx_t* indices) {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; *p_sel = <span class="keyword">reinterpret_cast&lt;</span>FaissIDSelectorBatch*<span class="keyword">&gt;</span>(</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">new</span> IDSelectorBatch(n, indices)</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; );</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment">// Below are structures used only by Index implementations</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;DEFINE_DESTRUCTOR(<a class="code" href="structfaiss_1_1BufferList.html">BufferList</a>)</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1BufferList.html">BufferList</a>, <span class="keywordtype">size_t</span>, buffer_size)</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;DEFINE_GETTER(BufferList, <span class="keywordtype">size_t</span>, wp)</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="keywordtype">int</span> faiss_BufferList_append_buffer(FaissBufferList* bl) {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">reinterpret_cast&lt;</span>BufferList*<span class="keyword">&gt;</span>(bl)-&gt;append_buffer();</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;}</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="keywordtype">int</span> faiss_BufferList_new(FaissBufferList** p_bl, <span class="keywordtype">size_t</span> buffer_size) {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; *p_bl = <span class="keyword">reinterpret_cast&lt;</span>FaissBufferList*<span class="keyword">&gt;</span>(</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">new</span> BufferList(buffer_size)</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; );</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;}</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="keywordtype">int</span> faiss_BufferList_add(FaissBufferList* bl, idx_t <span class="keywordtype">id</span>, <span class="keywordtype">float</span> dis) {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">reinterpret_cast&lt;</span>BufferList*<span class="keyword">&gt;</span>(bl)-&gt;add(<span class="keywordtype">id</span>, dis);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;}</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment">/// copy elemnts ofs:ofs+n-1 seen as linear data in the buffers to</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment">/// tables dest_ids, dest_dis</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> faiss_BufferList_copy_range(</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; FaissBufferList* bl, <span class="keywordtype">size_t</span> ofs, <span class="keywordtype">size_t</span> n, idx_t *dest_ids, <span class="keywordtype">float</span> *dest_dis) {</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">reinterpret_cast&lt;</span>BufferList*<span class="keyword">&gt;</span>(bl)-&gt;copy_range(ofs, n, dest_ids, dest_dis);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;}</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;DEFINE_GETTER_PERMISSIVE(<a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>, FaissRangeSearchResult*, res)</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;int faiss_RangeSearchPartialResult_new(</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; FaissRangeSearchPartialResult** p_res, FaissRangeSearchResult* res_in) {</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; *p_res = <span class="keyword">reinterpret_cast&lt;</span>FaissRangeSearchPartialResult*<span class="keyword">&gt;</span>(</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">new</span> <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>(</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; reinterpret_cast&lt;RangeSearchResult*&gt;(res_in))</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; );</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;}</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="keywordtype">int</span> faiss_RangeSearchPartialResult_finalize(</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; FaissRangeSearchPartialResult* res) {</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>*<span class="keyword">&gt;</span>(res)-&gt;finalize();</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;}</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="comment">/// called by range_search before do_allocation</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> faiss_RangeSearchPartialResult_set_lims(</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; FaissRangeSearchPartialResult* res) {</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>*<span class="keyword">&gt;</span>(res)-&gt;set_lims();</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;}</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="comment">/// called by range_search after do_allocation</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> faiss_RangeSearchPartialResult_set_result(</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; FaissRangeSearchPartialResult* res, <span class="keywordtype">int</span> incremental) {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>*<span class="keyword">&gt;</span>(res)-&gt;set_result(</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; static_cast&lt;bool&gt;(incremental));</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;}</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;DEFINE_GETTER_SUBCLASS(QueryResult, <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>, idx_t, qno)</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;DEFINE_GETTER_SUBCLASS(QueryResult, <a class="code" href="structfaiss_1_1RangeSearchPartialResult.html">RangeSearchPartialResult</a>, <span class="keywordtype">size_t</span>, nres)</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;DEFINE_GETTER_SUBCLASS_PERMISSIVE(QueryResult, RangeSearchPartialResult, FaissRangeSearchPartialResult*, pres)</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="keywordtype">int</span> faiss_RangeSearchPartialResult_new_result(</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; FaissRangeSearchPartialResult* res, idx_t qno, FaissQueryResult** qr) {</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; RangeSearchPartialResult::QueryResult* q = </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; &amp;<span class="keyword">reinterpret_cast&lt;</span>RangeSearchPartialResult*<span class="keyword">&gt;</span>(res)-&gt;new_result(qno);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keywordflow">if</span> (qr) {</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; *qr = <span class="keyword">reinterpret_cast&lt;</span>FaissQueryResult*<span class="keyword">&gt;</span>(q);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; }</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;}</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="keywordtype">int</span> faiss_QueryResult_add(FaissQueryResult* qr, <span class="keywordtype">float</span> dis, idx_t <span class="keywordtype">id</span>) {</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keyword">reinterpret_cast&lt;</span>RangeSearchPartialResult::QueryResult*<span class="keyword">&gt;</span>(qr)-&gt;add(dis, <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;}</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;}</div>
<div class="ttc" id="structfaiss_1_1IDSelectorBatch_html"><div class="ttname"><a href="structfaiss_1_1IDSelectorBatch.html">faiss::IDSelectorBatch</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00078">AuxIndexStructures.h:78</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00054">AuxIndexStructures.h:54</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelectorRange_html"><div class="ttname"><a href="structfaiss_1_1IDSelectorRange.html">faiss::IDSelectorRange</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00063">AuxIndexStructures.h:63</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchPartialResult_html"><div class="ttname"><a href="structfaiss_1_1RangeSearchPartialResult.html">faiss::RangeSearchPartialResult</a></div><div class="ttdoc">the entries in the buffers are split per query </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00141">AuxIndexStructures.h:141</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html">faiss::RangeSearchResult</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00031">AuxIndexStructures.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1BufferList_html"><div class="ttname"><a href="structfaiss_1_1BufferList.html">faiss::BufferList</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00099">AuxIndexStructures.h:99</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html_aa8ff848474a4cc16c5464cc4ec187824"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824">faiss::RangeSearchResult::labels</a></div><div class="ttdeci">idx_t * labels</div><div class="ttdoc">result for query i is labels[lims[i]:lims[i+1]] </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00037">AuxIndexStructures.h:37</a></div></div>
</div><!-- fragment --></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>