408 lines
64 KiB
HTML
408 lines
64 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: /data/users/hoss/faiss/HNSW.h 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 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 List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">/data/users/hoss/faiss/HNSW.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) Facebook, Inc. and its affiliates.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// -*- c++ -*-</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <unordered_set></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <queue></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <omp.h></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "Index.h"</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "FaissAssert.h"</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "utils.h"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/** Implementation of the Hierarchical Navigable Small World</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * datastructure.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * Efficient and robust approximate nearest neighbor search using</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * Hierarchical Navigable Small World graphs</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Yu. A. Malkov, D. A. Yashunin, arXiv 2017</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * This implmentation is heavily influenced by the NMSlib</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * implementation by Yury Malkov and Leonid Boystov</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * (https://github.com/searchivarius/nmslib)</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * The HNSW object stores only the neighbor link structure, see</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * IndexHNSW.h for the full index object.</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">struct </span>VisitedTable;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">struct </span>DistanceComputer; <span class="comment">// from AuxIndexStructures</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html"> 46</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1HNSW.html">HNSW</a> {<span class="comment"></span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// internal storage of vectors (32 bits: this is expensive)</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74"> 48</a></span> <span class="comment"></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// Faiss results are 64-bit</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a84f912f99bda1a827a74cdf8793af160"> 51</a></span> <span class="comment"></span> <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> <a class="code" href="structfaiss_1_1HNSW.html#a84f912f99bda1a827a74cdf8793af160">idx_t</a>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">typedef</span> std::pair<float, storage_idx_t> Node;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /** Heap structure that allows fast</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW_1_1MinimaxHeap.html"> 57</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1HNSW_1_1MinimaxHeap.html">MinimaxHeap</a> {</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">int</span> n;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> k;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">int</span> nvalid;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::vector<storage_idx_t> ids;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::vector<float> dis;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1CMax.html">faiss::CMax<float, storage_idx_t></a> <a class="code" href="structfaiss_1_1CMax.html">HC</a>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1HNSW_1_1MinimaxHeap.html">MinimaxHeap</a>(<span class="keywordtype">int</span> n): n(n), k(0), nvalid(0), ids(n), dis(n) {}</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> push(<a class="code" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> i, <span class="keywordtype">float</span> v);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">float</span> max() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">int</span> size() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> clear();</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> pop_min(<span class="keywordtype">float</span> *vmin_out = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">int</span> count_below(<span class="keywordtype">float</span> thresh);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  };</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /// to sort pairs of (id, distance) from nearest to fathest or the reverse</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW_1_1NodeDistCloser.html"> 83</a></span> <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1HNSW_1_1NodeDistCloser.html">NodeDistCloser</a> {</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">float</span> d;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">int</span> id;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="structfaiss_1_1HNSW_1_1NodeDistCloser.html">NodeDistCloser</a>(<span class="keywordtype">float</span> d, <span class="keywordtype">int</span> <span class="keywordtype">id</span>): d(d), id(<span class="keywordtype">id</span>) {}</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> operator < (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1HNSW_1_1NodeDistCloser.html">NodeDistCloser</a> &obj1)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d < obj1.d; }</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  };</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW_1_1NodeDistFarther.html"> 90</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1HNSW_1_1NodeDistFarther.html">NodeDistFarther</a> {</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">float</span> d;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">int</span> id;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="structfaiss_1_1HNSW_1_1NodeDistFarther.html">NodeDistFarther</a>(<span class="keywordtype">float</span> d, <span class="keywordtype">int</span> <span class="keywordtype">id</span>): d(d), id(<span class="keywordtype">id</span>) {}</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">bool</span> operator < (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1HNSW_1_1NodeDistFarther.html">NodeDistFarther</a> &obj1)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d > obj1.d; }</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  };</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /// assignment probability to each layer (sum=1)</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a907c94e0eca5200af1dc8d0aea482665"> 99</a></span> <span class="comment"></span> std::vector<double> <a class="code" href="structfaiss_1_1HNSW.html#a907c94e0eca5200af1dc8d0aea482665">assign_probas</a>;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /// number of neighbors stored per layer (cumulative), should not</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// be changed after first add</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a1c258bb88aae9b1a754ab4690d85ed41"> 103</a></span> <span class="comment"></span> std::vector<int> <a class="code" href="structfaiss_1_1HNSW.html#a1c258bb88aae9b1a754ab4690d85ed41">cum_nneighbor_per_level</a>;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /// level of each vector (base level = 1), size = ntotal</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a44847954c98957404829182c7db1b8af"> 106</a></span> <span class="comment"></span> std::vector<int> <a class="code" href="structfaiss_1_1HNSW.html#a44847954c98957404829182c7db1b8af">levels</a>;</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// offsets[i] is the offset in the neighbors array where vector i is stored</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// size ntotal + 1</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a0b456c521194903b29ce7c157539d771"> 110</a></span> <span class="comment"></span> std::vector<size_t> <a class="code" href="structfaiss_1_1HNSW.html#a0b456c521194903b29ce7c157539d771">offsets</a>;</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// neighbors[offsets[i]:offsets[i+1]] is the list of neighbors of vector i</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// for all levels. this is where all storage goes.</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a27bd11ef9a651a94bcefa5291336fc58"> 114</a></span> <span class="comment"></span> std::vector<storage_idx_t> <a class="code" href="structfaiss_1_1HNSW.html#a27bd11ef9a651a94bcefa5291336fc58">neighbors</a>;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /// entry point in the search structure (one of the points with maximum level</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a95547d97c90b361a040bae0fb0d892b4"> 117</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> <a class="code" href="structfaiss_1_1HNSW.html#a95547d97c90b361a040bae0fb0d892b4">entry_point</a>;</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="structfaiss_1_1RandomGenerator.html">faiss::RandomGenerator</a> rng;</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /// maximum level</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#afba18a290f5f759a8a7a64ed35b950eb"> 122</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#afba18a290f5f759a8a7a64ed35b950eb">max_level</a>;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> /// expansion factor at construction time</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#aa7309dd7826761def38233c8bbbc0c63"> 125</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#aa7309dd7826761def38233c8bbbc0c63">efConstruction</a>;</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> /// expansion factor at search time</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a6d1cb35c4220bf554af90133c71ae04f"> 128</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#a6d1cb35c4220bf554af90133c71ae04f">efSearch</a>;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /// during search: do we check whether the next best distance is good enough?</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#adbf81f0b21102b942182c904892e0858"> 131</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1HNSW.html#adbf81f0b21102b942182c904892e0858">check_relative_distance</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> /// number of entry points in levels > 0.</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a857bef0db2dc0000f312cc8a95f857b2"> 134</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#a857bef0db2dc0000f312cc8a95f857b2">upper_beam</a>;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> /// use bounded queue during exploration</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSW.html#a683738e8ab8e67fcabd823510c30b074"> 137</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1HNSW.html#a683738e8ab8e67fcabd823510c30b074">search_bounded_queue</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="comment">// methods that initialize the tree sizes</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /// initialize the assign_probas and cum_nneighbor_per_level to</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> /// have 2*M links on level 0 and M links on levels > 0</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#ae7d955690da5d6376c203e81e124ba94">set_default_probas</a>(<span class="keywordtype">int</span> M, <span class="keywordtype">float</span> levelMult);</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /// set nb of neighbors for this level (before adding anything)</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#afdb5a17487296267efaaa94e6a08996d">set_nb_neighbors</a>(<span class="keywordtype">int</span> level_no, <span class="keywordtype">int</span> n);</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// methods that access the tree sizes</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> /// nb of neighbors for this level</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#ad497ea80f352c33242ba7835370c2dba">nb_neighbors</a>(<span class="keywordtype">int</span> layer_no) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> /// cumumlative nb up to (and excluding) this level</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#a49b512eaaa54ead77b564cad8e3e6ebd">cum_nb_neighbors</a>(<span class="keywordtype">int</span> layer_no) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> /// range of entries in the neighbors table of vertex no at layer_no</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#aa3ae6a80d358e59e3af23f918253f61d">neighbor_range</a>(<a class="code" href="structfaiss_1_1HNSW.html#a84f912f99bda1a827a74cdf8793af160">idx_t</a> no, <span class="keywordtype">int</span> layer_no,</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">size_t</span> * begin, <span class="keywordtype">size_t</span> * end) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> /// only mandatory parameter: nb of neighbors</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1HNSW.html#a1fc852810a2497a8eb2c41635ec05520">HNSW</a>(<span class="keywordtype">int</span> M = 32);</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> /// pick a random level for a new point</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#aa6dfdaed7bc0ad895774315166fcb197">random_level</a>();</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> /// add n random levels to table (for debugging...)</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#a26710980aaca3c1c8729e5e055a42ebe">fill_with_random_links</a>(<span class="keywordtype">size_t</span> n);</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#a41a5d502f7b17a0fca8d1b0c02123a24">add_links_starting_from</a>(<a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>& ptdis,</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <a class="code" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> pt_id,</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> nearest,</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">float</span> d_nearest,</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordtype">int</span> level,</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  omp_lock_t *locks,</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a> &vt);</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> /** add point pt_id on all levels <= pt_level and build the link</span></div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * structure for them. */</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#a314b809de6f329662ab09f258b49afb3">add_with_locks</a>(<a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>& ptdis, <span class="keywordtype">int</span> pt_level, <span class="keywordtype">int</span> pt_id,</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  std::vector<omp_lock_t>& locks,</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a>& vt);</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1HNSW.html#ad91ac2e25c896dab7fb9d32f94b60a6a">search_from_candidates</a>(<a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>& qdis, <span class="keywordtype">int</span> k,</div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <a class="code" href="structfaiss_1_1HNSW.html#a84f912f99bda1a827a74cdf8793af160">idx_t</a> *I, <span class="keywordtype">float</span> *D,</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <a class="code" href="structfaiss_1_1HNSW_1_1MinimaxHeap.html">MinimaxHeap</a>& candidates,</div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a> &vt,</div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">int</span> level, <span class="keywordtype">int</span> nres_in = 0) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  std::priority_queue<Node> search_from_candidate_unbounded(</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keyword">const</span> Node& node,</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>& qdis,</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">int</span> ef,</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a> *vt</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  ) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> /// search interface</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#a330107a5801680609932849fc9404594">search</a>(<a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>& qdis, <span class="keywordtype">int</span> k,</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="structfaiss_1_1HNSW.html#a84f912f99bda1a827a74cdf8793af160">idx_t</a> *I, <span class="keywordtype">float</span> *D,</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a>& vt) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordtype">void</span> reset();</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">void</span> clear_neighbor_tables(<span class="keywordtype">int</span> level);</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">void</span> print_neighbor_stats(<span class="keywordtype">int</span> level) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">int</span> prepare_level_tab(<span class="keywordtype">size_t</span> n, <span class="keywordtype">bool</span> preset_levels = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HNSW.html#a0cf1870a859783925e95b15bf5e83584">shrink_neighbor_list</a>(</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <a class="code" href="structfaiss_1_1DistanceComputer.html">DistanceComputer</a>& qdis,</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  std::priority_queue<NodeDistFarther>& input,</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  std::vector<NodeDistFarther>& output,</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keywordtype">int</span> max_size);</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> };</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">/**************************************************************</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * Auxiliary structures</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> **************************************************************/</span></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">/// set implementation optimized for fast access.</span></div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"><a class="line" href="structfaiss_1_1VisitedTable.html"> 223</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a> {</div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  std::vector<uint8_t> visited;</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keywordtype">int</span> visno;</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1VisitedTable.html">VisitedTable</a>(<span class="keywordtype">int</span> size)</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  : visited(size), visno(1) {}</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> /// set flog #no to true</span></div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="structfaiss_1_1VisitedTable.html#a387b6428f4bfa44495c70a5f1f45f853"> 231</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1VisitedTable.html#a387b6428f4bfa44495c70a5f1f45f853">set</a>(<span class="keywordtype">int</span> no) {</div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  visited[no] = visno;</div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  }</div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> /// get flag #no</span></div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"><a class="line" href="structfaiss_1_1VisitedTable.html#a18a972137362ff04a38943d66fc19dcb"> 236</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keywordtype">int</span> no) <span class="keyword">const</span> {</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keywordflow">return</span> visited[no] == visno;</div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  }</div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> /// reset all flags to false</span></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"><a class="line" href="structfaiss_1_1VisitedTable.html#a76223893c8c3a577473092b3bb8a2446"> 241</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1VisitedTable.html#a76223893c8c3a577473092b3bb8a2446">advance</a>() {</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  visno++;</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordflow">if</span> (visno == 250) {</div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="comment">// 250 rather than 255 because sometimes we use visno and visno+1</span></div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  memset(visited.data(), 0, <span class="keyword">sizeof</span>(visited[0]) * visited.size());</div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  visno = 1;</div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  }</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  }</div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> };</div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"><a class="line" href="structfaiss_1_1HNSWStats.html"> 252</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1HNSWStats.html">HNSWStats</a> {</div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keywordtype">size_t</span> n1, n2, n3;</div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keywordtype">size_t</span> ndis;</div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">size_t</span> nreorder;</div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordtype">bool</span> view;</div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <a class="code" href="structfaiss_1_1HNSWStats.html">HNSWStats</a>() {</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  reset();</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  }</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keywordtype">void</span> reset() {</div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  n1 = n2 = n3 = 0;</div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  ndis = 0;</div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  nreorder = 0;</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  view = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  }</div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> };</div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">// global var that collects them all</span></div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="keyword">extern</span> <a class="code" href="structfaiss_1_1HNSWStats.html">HNSWStats</a> hnsw_stats;</div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> } <span class="comment">// namespace faiss</span></div>
|
|
<div class="ttc" id="structfaiss_1_1RandomGenerator_html"><div class="ttname"><a href="structfaiss_1_1RandomGenerator.html">faiss::RandomGenerator</a></div><div class="ttdoc">random generator that can be used in multithreaded contexts </div><div class="ttdef"><b>Definition:</b> <a href="utils_8h_source.html#l00047">utils.h:47</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a314b809de6f329662ab09f258b49afb3"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a314b809de6f329662ab09f258b49afb3">faiss::HNSW::add_with_locks</a></div><div class="ttdeci">void add_with_locks(DistanceComputer &ptdis, int pt_level, int pt_id, std::vector< omp_lock_t > &locks, VisitedTable &vt)</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00477">HNSW.cpp:477</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_aa3ae6a80d358e59e3af23f918253f61d"><div class="ttname"><a href="structfaiss_1_1HNSW.html#aa3ae6a80d358e59e3af23f918253f61d">faiss::HNSW::neighbor_range</a></div><div class="ttdeci">void neighbor_range(idx_t no, int layer_no, size_t *begin, size_t *end) const </div><div class="ttdoc">range of entries in the neighbors table of vertex no at layer_no </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00041">HNSW.cpp:41</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1DistanceComputer_html"><div class="ttname"><a href="structfaiss_1_1DistanceComputer.html">faiss::DistanceComputer</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00231">AuxIndexStructures.h:231</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1CMax_html"><div class="ttname"><a href="structfaiss_1_1CMax.html">faiss::CMax</a></div><div class="ttdef"><b>Definition:</b> <a href="Heap_8h_source.html#l00047">Heap.h:47</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_ad497ea80f352c33242ba7835370c2dba"><div class="ttname"><a href="structfaiss_1_1HNSW.html#ad497ea80f352c33242ba7835370c2dba">faiss::HNSW::nb_neighbors</a></div><div class="ttdeci">int nb_neighbors(int layer_no) const </div><div class="ttdoc">nb of neighbors for this level </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00021">HNSW.cpp:21</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a95547d97c90b361a040bae0fb0d892b4"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a95547d97c90b361a040bae0fb0d892b4">faiss::HNSW::entry_point</a></div><div class="ttdeci">storage_idx_t entry_point</div><div class="ttdoc">entry point in the search structure (one of the points with maximum level </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00117">HNSW.h:117</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a49b512eaaa54ead77b564cad8e3e6ebd"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a49b512eaaa54ead77b564cad8e3e6ebd">faiss::HNSW::cum_nb_neighbors</a></div><div class="ttdeci">int cum_nb_neighbors(int layer_no) const </div><div class="ttdoc">cumumlative nb up to (and excluding) this level </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00036">HNSW.cpp:36</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a84f912f99bda1a827a74cdf8793af160"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a84f912f99bda1a827a74cdf8793af160">faiss::HNSW::idx_t</a></div><div class="ttdeci">Index::idx_t idx_t</div><div class="ttdoc">Faiss results are 64-bit. </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00051">HNSW.h:51</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a907c94e0eca5200af1dc8d0aea482665"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a907c94e0eca5200af1dc8d0aea482665">faiss::HNSW::assign_probas</a></div><div class="ttdeci">std::vector< double > assign_probas</div><div class="ttdoc">assignment probability to each layer (sum=1) </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00099">HNSW.h:99</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_1_1NodeDistFarther_html"><div class="ttname"><a href="structfaiss_1_1HNSW_1_1NodeDistFarther.html">faiss::HNSW::NodeDistFarther</a></div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00090">HNSW.h:90</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a683738e8ab8e67fcabd823510c30b074"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a683738e8ab8e67fcabd823510c30b074">faiss::HNSW::search_bounded_queue</a></div><div class="ttdeci">bool search_bounded_queue</div><div class="ttdoc">use bounded queue during exploration </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00137">HNSW.h:137</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a1c258bb88aae9b1a754ab4690d85ed41"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a1c258bb88aae9b1a754ab4690d85ed41">faiss::HNSW::cum_nneighbor_per_level</a></div><div class="ttdeci">std::vector< int > cum_nneighbor_per_level</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00103">HNSW.h:103</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1VisitedTable_html_a76223893c8c3a577473092b3bb8a2446"><div class="ttname"><a href="structfaiss_1_1VisitedTable.html#a76223893c8c3a577473092b3bb8a2446">faiss::VisitedTable::advance</a></div><div class="ttdeci">void advance()</div><div class="ttdoc">reset all flags to false </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00241">HNSW.h:241</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a41a5d502f7b17a0fca8d1b0c02123a24"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a41a5d502f7b17a0fca8d1b0c02123a24">faiss::HNSW::add_links_starting_from</a></div><div class="ttdeci">void add_links_starting_from(DistanceComputer &ptdis, storage_idx_t pt_id, storage_idx_t nearest, float d_nearest, int level, omp_lock_t *locks, VisitedTable &vt)</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00441">HNSW.cpp:441</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1Index_html_ad3f0d3071f987baabbdd3da4500c87ea"><div class="ttname"><a href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSWStats_html"><div class="ttname"><a href="structfaiss_1_1HNSWStats.html">faiss::HNSWStats</a></div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00252">HNSW.h:252</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a0b456c521194903b29ce7c157539d771"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a0b456c521194903b29ce7c157539d771">faiss::HNSW::offsets</a></div><div class="ttdeci">std::vector< size_t > offsets</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00110">HNSW.h:110</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1VisitedTable_html"><div class="ttname"><a href="structfaiss_1_1VisitedTable.html">faiss::VisitedTable</a></div><div class="ttdoc">set implementation optimized for fast access. </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00223">HNSW.h:223</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a6d1cb35c4220bf554af90133c71ae04f"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a6d1cb35c4220bf554af90133c71ae04f">faiss::HNSW::efSearch</a></div><div class="ttdeci">int efSearch</div><div class="ttdoc">expansion factor at search time </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00128">HNSW.h:128</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_adbf81f0b21102b942182c904892e0858"><div class="ttname"><a href="structfaiss_1_1HNSW.html#adbf81f0b21102b942182c904892e0858">faiss::HNSW::check_relative_distance</a></div><div class="ttdeci">bool check_relative_distance</div><div class="ttdoc">during search: do we check whether the next best distance is good enough? </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00131">HNSW.h:131</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a1fc852810a2497a8eb2c41635ec05520"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a1fc852810a2497a8eb2c41635ec05520">faiss::HNSW::HNSW</a></div><div class="ttdeci">HNSW(int M=32)</div><div class="ttdoc">only mandatory parameter: nb of neighbors </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00051">HNSW.cpp:51</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_1_1NodeDistCloser_html"><div class="ttname"><a href="structfaiss_1_1HNSW_1_1NodeDistCloser.html">faiss::HNSW::NodeDistCloser</a></div><div class="ttdoc">to sort pairs of (id, distance) from nearest to fathest or the reverse </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00083">HNSW.h:83</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a857bef0db2dc0000f312cc8a95f857b2"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a857bef0db2dc0000f312cc8a95f857b2">faiss::HNSW::upper_beam</a></div><div class="ttdeci">int upper_beam</div><div class="ttdoc">number of entry points in levels &gt; 0. </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00134">HNSW.h:134</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_afdb5a17487296267efaaa94e6a08996d"><div class="ttname"><a href="structfaiss_1_1HNSW.html#afdb5a17487296267efaaa94e6a08996d">faiss::HNSW::set_nb_neighbors</a></div><div class="ttdeci">void set_nb_neighbors(int level_no, int n)</div><div class="ttdoc">set nb of neighbors for this level (before adding anything) </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00027">HNSW.cpp:27</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html"><div class="ttname"><a href="structfaiss_1_1HNSW.html">faiss::HNSW</a></div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00046">HNSW.h:46</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_ad91ac2e25c896dab7fb9d32f94b60a6a"><div class="ttname"><a href="structfaiss_1_1HNSW.html#ad91ac2e25c896dab7fb9d32f94b60a6a">faiss::HNSW::search_from_candidates</a></div><div class="ttdeci">int search_from_candidates(DistanceComputer &qdis, int k, idx_t *I, float *D, MinimaxHeap &candidates, VisitedTable &vt, int level, int nres_in=0) const </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00523">HNSW.cpp:523</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_aa6dfdaed7bc0ad895774315166fcb197"><div class="ttname"><a href="structfaiss_1_1HNSW.html#aa6dfdaed7bc0ad895774315166fcb197">faiss::HNSW::random_level</a></div><div class="ttdeci">int random_level()</div><div class="ttdoc">pick a random level for a new point </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00062">HNSW.cpp:62</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_ae7d955690da5d6376c203e81e124ba94"><div class="ttname"><a href="structfaiss_1_1HNSW.html#ae7d955690da5d6376c203e81e124ba94">faiss::HNSW::set_default_probas</a></div><div class="ttdeci">void set_default_probas(int M, float levelMult)</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00076">HNSW.cpp:76</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a330107a5801680609932849fc9404594"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a330107a5801680609932849fc9404594">faiss::HNSW::search</a></div><div class="ttdeci">void search(DistanceComputer &qdis, int k, idx_t *I, float *D, VisitedTable &vt) const </div><div class="ttdoc">search interface </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00676">HNSW.cpp:676</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a26710980aaca3c1c8729e5e055a42ebe"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a26710980aaca3c1c8729e5e055a42ebe">faiss::HNSW::fill_with_random_links</a></div><div class="ttdeci">void fill_with_random_links(size_t n)</div><div class="ttdoc">add n random levels to table (for debugging...) </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00170">HNSW.cpp:170</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_1_1MinimaxHeap_html"><div class="ttname"><a href="structfaiss_1_1HNSW_1_1MinimaxHeap.html">faiss::HNSW::MinimaxHeap</a></div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00057">HNSW.h:57</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a27bd11ef9a651a94bcefa5291336fc58"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a27bd11ef9a651a94bcefa5291336fc58">faiss::HNSW::neighbors</a></div><div class="ttdeci">std::vector< storage_idx_t > neighbors</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00114">HNSW.h:114</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_aa7309dd7826761def38233c8bbbc0c63"><div class="ttname"><a href="structfaiss_1_1HNSW.html#aa7309dd7826761def38233c8bbbc0c63">faiss::HNSW::efConstruction</a></div><div class="ttdeci">int efConstruction</div><div class="ttdoc">expansion factor at construction time </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00125">HNSW.h:125</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_ae1342fc2f07c325598a73b733e88ee74"><div class="ttname"><a href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">faiss::HNSW::storage_idx_t</a></div><div class="ttdeci">int storage_idx_t</div><div class="ttdoc">internal storage of vectors (32 bits: this is expensive) </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00048">HNSW.h:48</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1VisitedTable_html_a387b6428f4bfa44495c70a5f1f45f853"><div class="ttname"><a href="structfaiss_1_1VisitedTable.html#a387b6428f4bfa44495c70a5f1f45f853">faiss::VisitedTable::set</a></div><div class="ttdeci">void set(int no)</div><div class="ttdoc">set flog #no to true </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00231">HNSW.h:231</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a44847954c98957404829182c7db1b8af"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a44847954c98957404829182c7db1b8af">faiss::HNSW::levels</a></div><div class="ttdeci">std::vector< int > levels</div><div class="ttdoc">level of each vector (base level = 1), size = ntotal </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00106">HNSW.h:106</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_afba18a290f5f759a8a7a64ed35b950eb"><div class="ttname"><a href="structfaiss_1_1HNSW.html#afba18a290f5f759a8a7a64ed35b950eb">faiss::HNSW::max_level</a></div><div class="ttdeci">int max_level</div><div class="ttdoc">maximum level </div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8h_source.html#l00122">HNSW.h:122</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1HNSW_html_a0cf1870a859783925e95b15bf5e83584"><div class="ttname"><a href="structfaiss_1_1HNSW.html#a0cf1870a859783925e95b15bf5e83584">faiss::HNSW::shrink_neighbor_list</a></div><div class="ttdeci">static void shrink_neighbor_list(DistanceComputer &qdis, std::priority_queue< NodeDistFarther > &input, std::vector< NodeDistFarther > &output, int max_size)</div><div class="ttdef"><b>Definition:</b> <a href="HNSW_8cpp_source.html#l00235">HNSW.cpp:235</a></div></div>
|
|
</div><!-- fragment --></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>
|