282 lines
42 KiB
HTML
282 lines
42 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/IndexBinary.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/IndexBinary.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">#ifndef FAISS_INDEX_BINARY_H</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_BINARY_H</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <cstdio></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <typeinfo></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <sstream></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 "FaissAssert.h"</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "Index.h"</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</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> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// Forward declarations see AuxIndexStructures.h</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span><span class="keyword">struct </span>IDSelector;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">struct </span>RangeSearchResult;</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">/** Abstract structure for a binary index.</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Supports adding vertices and searching them.</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * All queries are symmetric because there is no distinction between codes and</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * vectors.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html"> 36</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c"> 37</a></span>  <span class="keyword">using</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> = <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a>; <span class="comment">///< all indices are this type</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> <span class="keyword">using</span> component_t = uint8_t;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">using</span> distance_t = int32_t;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88"> 41</a></span>  <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>; <span class="comment">///< vector dimension</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380"> 42</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380">code_size</a>; <span class="comment">///< number of bytes per vector ( = d / 8 )</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e"> 43</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> <a class="code" href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e">ntotal</a>; <span class="comment">///< total nb of indexed vectors</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7"> 44</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7">verbose</a>; <span class="comment">///< verbosity level</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// set if the Index does not require training, or if training is done already</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f"> 47</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f">is_trained</a>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// type of metric this index uses for search</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7"> 50</a></span> <span class="comment"></span> <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> <a class="code" href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7">metric_type</a>;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> <a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a> = 0, <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric = METRIC_L2)</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  : <a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>),</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380">code_size</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a> / 8),</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e">ntotal</a>(0),</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7">verbose</a>(false),</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f">is_trained</a>(true),</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7">metric_type</a>(metric) {</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  FAISS_THROW_IF_NOT(<a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a> % 8 == 0);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</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>  <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a>();</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /** Perform training on a representative set of vectors.</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @param n nb of training vectors</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @param x training vecors, size n * d / 8</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a34b7f0f358259d858135555967c6bc79">train</a>(idx_t n, <span class="keyword">const</span> uint8_t *x);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /** Add n vectors of dimension d to the index.</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * Vectors are implicitly assigned labels ntotal .. ntotal + n - 1</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @param x input matrix, size n * d / 8</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#af04b1093cdebfea189e0e04da68794d7">add</a>(idx_t n, <span class="keyword">const</span> uint8_t *x) = 0;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> /** Same as add, but stores xids instead of sequential ids.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * The default implementation fails with an assertion, as it is</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * not supported by all indexes.</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * @param xids if non-null, ids to store for the vectors (size n)</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a68a24abdf241eb98372b7d6fbd8d3891">add_with_ids</a>(idx_t n, <span class="keyword">const</span> uint8_t *x, <span class="keyword">const</span> <span class="keywordtype">long</span> *xids);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /** Query n vectors of dimension d to the index.</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * return at most k vectors. If there are not enough results for a</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * query, the result array is padded with -1s.</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @param x input vectors to search, size n * d / 8</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @param labels output labels of the NNs, size n*k</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @param distances output pairwise distances, size n*k</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a48cdd06037d1fb8ce827e7522ba05fb8">search</a>(idx_t n, <span class="keyword">const</span> uint8_t *x, idx_t k,</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  int32_t *distances, idx_t *labels) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> /** Query n vectors of dimension d to the index.</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * return all vectors with distance < radius. Note that many</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * indexes do not implement the range_search (only the k-NN search</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * is mandatory).</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param x input vectors to search, size n * d / 8</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @param radius search radius</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @param result result table</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#adec414108d34c63e4a06b6d3f9a3fa35">range_search</a>(idx_t n, <span class="keyword">const</span> uint8_t *x, <span class="keywordtype">int</span> radius,</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /** Return the indexes of the k vectors closest to the query x.</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * This function is identical to search but only returns labels of neighbors.</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @param x input vectors to search, size n * d / 8</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param labels output labels of the NNs, size n*k</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">assign</a>(idx_t n, <span class="keyword">const</span> uint8_t *x, idx_t *labels, idx_t k = 1);</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"> /// Removes all elements from the database.</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a11bff8bcaa366c563076a3d18f3ae30c">reset</a>() = 0;</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"> /** Removes IDs from the index. Not supported by all indexes.</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1IndexBinary.html#ae2b85e2cad27acb06cb9d6d8e600ae02">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>& sel);</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /** Reconstruct a stored vector.</span></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"> * This function may not be defined for some indexes.</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @param key id of the vector to reconstruct</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @param recons reconstucted vector (size d / 8)</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a60180e1c6b363c287b6e55191455a82f">reconstruct</a>(idx_t key, uint8_t *recons) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /** Reconstruct vectors i0 to i0 + ni - 1.</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * This function may not be defined for some indexes.</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * @param recons reconstucted vectors (size ni * d / 8)</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#ab5885ba0cbd91cf6c5fe2f53bb5650c3">reconstruct_n</a>(idx_t i0, idx_t ni, uint8_t *recons) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> /** Similar to search, but also reconstructs the stored vectors (or an</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * approximation in the case of lossy coding) for the search results.</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * If there are not enough results for a query, the resulting array</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * is padded with -1s.</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"> * @param recons reconstructed vectors size (n, k, d)</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> **/</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#ae99e8745fc02ffac2cfdb431951eeabf">search_and_reconstruct</a>(idx_t n, <span class="keyword">const</span> uint8_t *x, idx_t k,</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  int32_t *distances, idx_t *labels,</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  uint8_t *recons) <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"> /** Display the actual class name and some more info. */</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a63d722545b95badd251f3e8770b9bb9b">display</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> };</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> } <span class="comment">// namespace faiss</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#endif // FAISS_INDEX_BINARY_H</span></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a48cdd06037d1fb8ce827e7522ba05fb8"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a48cdd06037d1fb8ce827e7522ba05fb8">faiss::IndexBinary::search</a></div><div class="ttdeci">virtual void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels) const =0</div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a11bff8bcaa366c563076a3d18f3ae30c"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a11bff8bcaa366c563076a3d18f3ae30c">faiss::IndexBinary::reset</a></div><div class="ttdeci">virtual void reset()=0</div><div class="ttdoc">Removes all elements from the database. </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_1IndexBinary_html_a1656c00d77d55999becd71e3d8ea6dd7"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7">faiss::IndexBinary::verbose</a></div><div class="ttdeci">bool verbose</div><div class="ttdoc">verbosity level </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00044">IndexBinary.h:44</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_ae2b85e2cad27acb06cb9d6d8e600ae02"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#ae2b85e2cad27acb06cb9d6d8e600ae02">faiss::IndexBinary::remove_ids</a></div><div class="ttdeci">virtual long remove_ids(const IDSelector &sel)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00038">IndexBinary.cpp:38</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a132119ae93e240b54621c5c669853c7f"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f">faiss::IndexBinary::is_trained</a></div><div class="ttdeci">bool is_trained</div><div class="ttdoc">set if the Index does not require training, or if training is done already </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00047">IndexBinary.h:47</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a34b7f0f358259d858135555967c6bc79"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a34b7f0f358259d858135555967c6bc79">faiss::IndexBinary::train</a></div><div class="ttdeci">virtual void train(idx_t n, const uint8_t *x)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00019">IndexBinary.cpp:19</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a277c2645b8def11c5d982384098c5380"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380">faiss::IndexBinary::code_size</a></div><div class="ttdeci">int code_size</div><div class="ttdoc">number of bytes per vector ( = d / 8 ) </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00042">IndexBinary.h:42</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a01749bbdbd3b7ec6bb9390257ab16c5c"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">faiss::IndexBinary::idx_t</a></div><div class="ttdeci">Index::idx_t idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00037">IndexBinary.h:37</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a0e485a7189eec2675032486d3b12cf88"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">faiss::IndexBinary::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00041">IndexBinary.h:41</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a63d722545b95badd251f3e8770b9bb9b"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a63d722545b95badd251f3e8770b9bb9b">faiss::IndexBinary::display</a></div><div class="ttdeci">void display() const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00072">IndexBinary.cpp:72</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_1IndexBinary_html_a60180e1c6b363c287b6e55191455a82f"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a60180e1c6b363c287b6e55191455a82f">faiss::IndexBinary::reconstruct</a></div><div class="ttdeci">virtual void reconstruct(idx_t key, uint8_t *recons) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00043">IndexBinary.cpp:43</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a27c32414471c57138b248583fc0c5f8c"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">faiss::IndexBinary::assign</a></div><div class="ttdeci">void assign(idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00028">IndexBinary.cpp:28</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_adec414108d34c63e4a06b6d3f9a3fa35"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#adec414108d34c63e4a06b6d3f9a3fa35">faiss::IndexBinary::range_search</a></div><div class="ttdeci">virtual void range_search(idx_t n, const uint8_t *x, int radius, RangeSearchResult *result) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00023">IndexBinary.cpp:23</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a68a24abdf241eb98372b7d6fbd8d3891"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a68a24abdf241eb98372b7d6fbd8d3891">faiss::IndexBinary::add_with_ids</a></div><div class="ttdeci">virtual void add_with_ids(idx_t n, const uint8_t *x, const long *xids)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00034">IndexBinary.cpp:34</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_ae99e8745fc02ffac2cfdb431951eeabf"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#ae99e8745fc02ffac2cfdb431951eeabf">faiss::IndexBinary::search_and_reconstruct</a></div><div class="ttdeci">virtual void search_and_reconstruct(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00053">IndexBinary.cpp:53</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_ab5885ba0cbd91cf6c5fe2f53bb5650c3"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#ab5885ba0cbd91cf6c5fe2f53bb5650c3">faiss::IndexBinary::reconstruct_n</a></div><div class="ttdeci">virtual void reconstruct_n(idx_t i0, idx_t ni, uint8_t *recons) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00047">IndexBinary.cpp:47</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_1IndexBinary_html_a41b6759d127475d5fcd2b3982a8f355e"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e">faiss::IndexBinary::ntotal</a></div><div class="ttdeci">idx_t ntotal</div><div class="ttdoc">total nb of indexed vectors </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00043">IndexBinary.h:43</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00036">IndexBinary.h:36</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_af04b1093cdebfea189e0e04da68794d7"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#af04b1093cdebfea189e0e04da68794d7">faiss::IndexBinary::add</a></div><div class="ttdeci">virtual void add(idx_t n, const uint8_t *x)=0</div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a344529c829717012b530ef9c13b145b7"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7">faiss::IndexBinary::metric_type</a></div><div class="ttdeci">MetricType metric_type</div><div class="ttdoc">type of metric this index uses for search </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00050">IndexBinary.h:50</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_afd12191c638da74760ff397cf319752c"><div class="ttname"><a href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a></div><div class="ttdeci">MetricType</div><div class="ttdoc">Some algorithms support both an inner product version and a L2 search version. </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00044">Index.h:44</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>
|