mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
various bugfixes from github issues kmean with some frozen centroids GPU better tiling for large flat datasets default AVX for vector ops
295 lines
48 KiB
HTML
295 lines
48 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/matthijs/github_faiss/faiss/IndexFlat.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/matthijs/github_faiss/faiss/IndexFlat.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) 2015-present, Facebook, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// -*- c++ -*-</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef INDEX_FLAT_H</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span><span class="preprocessor">#define INDEX_FLAT_H</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "Index.h"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/** Index that stores the full vectors and performs exhaustive search */</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlat.html"> 23</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a>: <a class="code" href="structfaiss_1_1Index.html">Index</a> {<span class="comment"></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// database vectors, size ntotal * d</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlat.html#a9001de47890fe5d2eced9551d3613d47"> 25</a></span> <span class="comment"></span> std::vector<float> <a class="code" href="structfaiss_1_1IndexFlat.html#a9001de47890fe5d2eced9551d3613d47">xb</a>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric = METRIC_INNER_PRODUCT);</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat.html#a406f028c702edec72477eacc5733f59c">add</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat.html#ab63dc34ef5d33f98f94aa0ade7c7324f">reset</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat.html#a85510d70f4675197df9988651e4692c9">search</a>(</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">float</span>* distances,</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a>* labels) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat.html#ac56b7ed90ab65fab9c586a1e56006d12">range_search</a>(</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">float</span> radius,</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>* result) <span class="keyword">const override</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"> 46</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat.html#ae4b33315752b62cff1626f9f967167b1">reconstruct</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> key, <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /** compute distance with a subset of vectors</span></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"> * @param x query vectors, size n * d</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param labels indices of the vectors that should be compared</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * for each query vector, size n * k</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param distances</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * corresponding output distances, size n * k</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat.html#a14b51786e7f98be1954eef35d02813a7">compute_distance_subset</a> (</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> *x,</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">float</span> *distances,</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /** remove some ids. NB that Because of the structure of the</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * indexing structre, the semantics of this operation are</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * different from the usual ones: the new ids are shifted */</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1IndexFlat.html#a8d1ea1d28e80849f8b0f5493679d68c9">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>& sel) <span class="keyword">override</span>;</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>  <a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> () {}</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> </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> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlatIP.html"> 73</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexFlatIP.html">IndexFlatIP</a>:<a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> {</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexFlatIP.html">IndexFlatIP</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>): <a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> (d, METRIC_INNER_PRODUCT) {}</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="structfaiss_1_1IndexFlatIP.html">IndexFlatIP</a> () {}</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</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> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlatL2.html"> 79</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a>:<a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> {</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>): <a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> (d, METRIC_L2) {}</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a> () {}</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// same as an IndexFlatL2 but a value is subtracted from each distance</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlatL2BaseShift.html"> 86</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexFlatL2BaseShift.html">IndexFlatL2BaseShift</a>: <a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a> {</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::vector<float> shift;</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>  <a class="code" href="structfaiss_1_1IndexFlatL2BaseShift.html">IndexFlatL2BaseShift</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, <span class="keywordtype">size_t</span> nshift, <span class="keyword">const</span> <span class="keywordtype">float</span> *shift);</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlatL2BaseShift.html#a16e9bf1aec9d18b3ebbe78fea6bfecc0">search</a>(</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">float</span>* distances,</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a>* labels) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </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">/** Index that queries in a base_index (a fast one) and refines the</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * results with an exact search, hopefully improving the results.</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexRefineFlat.html"> 103</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexRefineFlat.html">IndexRefineFlat</a>: <a class="code" href="structfaiss_1_1Index.html">Index</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"> /// storage for full vectors</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexRefineFlat.html#aab99f32713ece942ccefccf306292ca0"> 106</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1IndexFlat.html">IndexFlat</a> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#aab99f32713ece942ccefccf306292ca0">refine_index</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"> /// faster index to pre-select the vectors that should be filtered</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexRefineFlat.html#a4acc0b3a8c33e5dd8851448ac162dfd0"> 109</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1Index.html">Index</a> *<a class="code" href="structfaiss_1_1IndexRefineFlat.html#a4acc0b3a8c33e5dd8851448ac162dfd0">base_index</a>;</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexRefineFlat.html#aaf0f6a094de0e9409effa81bedb9c7e2"> 110</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#aaf0f6a094de0e9409effa81bedb9c7e2">own_fields</a>; <span class="comment">///< should the base index be deallocated?</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// factor between k requested in search and the k requested from</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// the base_index (should be >= 1)</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexRefineFlat.html#a7383fabb28db5b0df45ca4ea81f7acd4"> 114</a></span> <span class="comment"></span> <span class="keywordtype">float</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#a7383fabb28db5b0df45ca4ea81f7acd4">k_factor</a>;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html">IndexRefineFlat</a> (<a class="code" href="structfaiss_1_1Index.html">Index</a> *<a class="code" href="structfaiss_1_1IndexRefineFlat.html#a4acc0b3a8c33e5dd8851448ac162dfd0">base_index</a>);</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="structfaiss_1_1IndexRefineFlat.html">IndexRefineFlat</a> ();</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#a79c4c9b9ffabc4460ef4def6eb962e68">train</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#a10d5009c838e8653fd767ca48a3e6fcc">add</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#ac3efe902315768afe83fa2b8ea5dc591">reset</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexRefineFlat.html#ad04444de1e2c26c463cc52f3c076dd41">search</a>(</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordtype">float</span>* distances,</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a>* labels) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  ~<a class="code" href="structfaiss_1_1IndexRefineFlat.html">IndexRefineFlat</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</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">/// optimized version for 1D "vectors"</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlat1D.html"> 138</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexFlat1D.html">IndexFlat1D</a>:<a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a> {</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexFlat1D.html#a8b025a468b088a343cf8079006de45e2"> 139</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html#a8b025a468b088a343cf8079006de45e2">continuous_update</a>; <span class="comment">///< is the permutation updated continuously?</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"><a class="line" href="structfaiss_1_1IndexFlat1D.html#a3442f0d86a14108534f99eea0b7d4d3f"> 141</a></span>  std::vector<idx_t> <a class="code" href="structfaiss_1_1IndexFlat1D.html#a3442f0d86a14108534f99eea0b7d4d3f">perm</a>; <span class="comment">///< sorted database indices</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html">IndexFlat1D</a> (<span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html#a8b025a468b088a343cf8079006de45e2">continuous_update</a>=<span class="keyword">true</span>);</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"> /// if not continuous_update, call this between the last add and</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /// the first search</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html#ac7466c6c9b1e9e81ea19b846ddb8209e">update_permutation</a> ();</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html#a5dc39280262484ecadda5e11162c2457">add</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html#aa205c4ffa6cbd50f49ef9cb6cc050000">reset</a>() <span class="keyword">override</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"> /// Warn: the distances returned are L1 not L2</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexFlat1D.html#a65736f2900865cd156faba4fcd260d05">search</a>(</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">float</span>* distances,</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a>* labels) <span class="keyword">const override</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> </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> }</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlatL2BaseShift_html_a16e9bf1aec9d18b3ebbe78fea6bfecc0"><div class="ttname"><a href="structfaiss_1_1IndexFlatL2BaseShift.html#a16e9bf1aec9d18b3ebbe78fea6bfecc0">faiss::IndexFlatL2BaseShift::search</a></div><div class="ttdeci">void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00133">IndexFlat.cpp:133</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00023">IndexFlat.h:23</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_ac3efe902315768afe83fa2b8ea5dc591"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#ac3efe902315768afe83fa2b8ea5dc591">faiss::IndexRefineFlat::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00184">IndexFlat.cpp:184</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html_a8b025a468b088a343cf8079006de45e2"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html#a8b025a468b088a343cf8079006de45e2">faiss::IndexFlat1D::continuous_update</a></div><div class="ttdeci">bool continuous_update</div><div class="ttdoc">is the permutation updated continuously? </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00139">IndexFlat.h:139</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html">faiss::IndexFlat1D</a></div><div class="ttdoc">optimized version for 1D &quot;vectors&quot; </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00138">IndexFlat.h:138</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00052">AuxIndexStructures.h:52</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlatL2_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00079">IndexFlat.h:79</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_a85510d70f4675197df9988651e4692c9"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#a85510d70f4675197df9988651e4692c9">faiss::IndexFlat::search</a></div><div class="ttdeci">void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00042">IndexFlat.cpp:42</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_ab63dc34ef5d33f98f94aa0ade7c7324f"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#ab63dc34ef5d33f98f94aa0ade7c7324f">faiss::IndexFlat::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00036">IndexFlat.cpp:36</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html_ac7466c6c9b1e9e81ea19b846ddb8209e"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html#ac7466c6c9b1e9e81ea19b846ddb8209e">faiss::IndexFlat1D::update_permutation</a></div><div class="ttdeci">void update_permutation()</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00284">IndexFlat.cpp:284</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_ae4b33315752b62cff1626f9f967167b1"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#ae4b33315752b62cff1626f9f967167b1">faiss::IndexFlat::reconstruct</a></div><div class="ttdeci">void reconstruct(idx_t key, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00118">IndexFlat.cpp:118</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html_a5dc39280262484ecadda5e11162c2457"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html#a5dc39280262484ecadda5e11162c2457">faiss::IndexFlat1D::add</a></div><div class="ttdeci">void add(idx_t n, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00294">IndexFlat.cpp:294</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_a8d1ea1d28e80849f8b0f5493679d68c9"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#a8d1ea1d28e80849f8b0f5493679d68c9">faiss::IndexFlat::remove_ids</a></div><div class="ttdeci">long remove_ids(const IDSelector &sel) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00095">IndexFlat.cpp:95</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlatIP_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00073">IndexFlat.h:73</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_ad04444de1e2c26c463cc52f3c076dd41"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#ad04444de1e2c26c463cc52f3c076dd41">faiss::IndexRefineFlat::search</a></div><div class="ttdeci">void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00219">IndexFlat.cpp:219</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_a4acc0b3a8c33e5dd8851448ac162dfd0"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#a4acc0b3a8c33e5dd8851448ac162dfd0">faiss::IndexRefineFlat::base_index</a></div><div class="ttdeci">Index * base_index</div><div class="ttdoc">faster index to pre-select the vectors that should be filtered </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00109">IndexFlat.h:109</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html">faiss::IndexRefineFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00103">IndexFlat.h:103</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_aab99f32713ece942ccefccf306292ca0"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#aab99f32713ece942ccefccf306292ca0">faiss::IndexRefineFlat::refine_index</a></div><div class="ttdeci">IndexFlat refine_index</div><div class="ttdoc">storage for full vectors </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00106">IndexFlat.h:106</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_aaf0f6a094de0e9409effa81bedb9c7e2"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#aaf0f6a094de0e9409effa81bedb9c7e2">faiss::IndexRefineFlat::own_fields</a></div><div class="ttdeci">bool own_fields</div><div class="ttdoc">should the base index be deallocated? </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00110">IndexFlat.h:110</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1Index_html_a2a002388d2c081c2dbab8508dcefe73d"><div class="ttname"><a href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">faiss::Index::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00064">Index.h:64</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_ac56b7ed90ab65fab9c586a1e56006d12"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#ac56b7ed90ab65fab9c586a1e56006d12">faiss::IndexFlat::range_search</a></div><div class="ttdeci">void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00058">IndexFlat.cpp:58</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_a79c4c9b9ffabc4460ef4def6eb962e68"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#a79c4c9b9ffabc4460ef4def6eb962e68">faiss::IndexRefineFlat::train</a></div><div class="ttdeci">void train(idx_t n, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00171">IndexFlat.cpp:171</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1Index_html_a040c6aed1f224f3ea7bf58eebc0c31a4"><div class="ttname"><a href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">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_1IndexFlat_html_a406f028c702edec72477eacc5733f59c"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#a406f028c702edec72477eacc5733f59c">faiss::IndexFlat::add</a></div><div class="ttdeci">void add(idx_t n, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00030">IndexFlat.cpp:30</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html_a65736f2900865cd156faba4fcd260d05"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html#a65736f2900865cd156faba4fcd260d05">faiss::IndexFlat1D::search</a></div><div class="ttdeci">void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override</div><div class="ttdoc">Warn: the distances returned are L1 not L2. </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00307">IndexFlat.cpp:307</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#l00029">AuxIndexStructures.h:29</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_a14b51786e7f98be1954eef35d02813a7"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#a14b51786e7f98be1954eef35d02813a7">faiss::IndexFlat::compute_distance_subset</a></div><div class="ttdeci">void compute_distance_subset(idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00073">IndexFlat.cpp:73</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlatL2BaseShift_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatL2BaseShift.html">faiss::IndexFlatL2BaseShift</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00086">IndexFlat.h:86</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1Index_html"><div class="ttname"><a href="structfaiss_1_1Index.html">faiss::Index</a></div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00060">Index.h:60</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat_html_a9001de47890fe5d2eced9551d3613d47"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html#a9001de47890fe5d2eced9551d3613d47">faiss::IndexFlat::xb</a></div><div class="ttdeci">std::vector< float > xb</div><div class="ttdoc">database vectors, size ntotal * d </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00025">IndexFlat.h:25</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_a7383fabb28db5b0df45ca4ea81f7acd4"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#a7383fabb28db5b0df45ca4ea81f7acd4">faiss::IndexRefineFlat::k_factor</a></div><div class="ttdeci">float k_factor</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00114">IndexFlat.h:114</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html_aa205c4ffa6cbd50f49ef9cb6cc050000"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html#aa205c4ffa6cbd50f49ef9cb6cc050000">faiss::IndexFlat1D::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00301">IndexFlat.cpp:301</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexFlat1D_html_a3442f0d86a14108534f99eea0b7d4d3f"><div class="ttname"><a href="structfaiss_1_1IndexFlat1D.html#a3442f0d86a14108534f99eea0b7d4d3f">faiss::IndexFlat1D::perm</a></div><div class="ttdeci">std::vector< idx_t > perm</div><div class="ttdoc">sorted database indices </div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00141">IndexFlat.h:141</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#l00043">Index.h:43</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexRefineFlat_html_a10d5009c838e8653fd767ca48a3e6fcc"><div class="ttname"><a href="structfaiss_1_1IndexRefineFlat.html#a10d5009c838e8653fd767ca48a3e6fcc">faiss::IndexRefineFlat::add</a></div><div class="ttdeci">void add(idx_t n, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8cpp_source.html#l00177">IndexFlat.cpp:177</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>
|