mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
0df3f646fc
various bugfixes from github issues kmean with some frozen centroids GPU better tiling for large flat datasets default AVX for vector ops
517 lines
79 KiB
HTML
517 lines
79 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/utils.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/utils.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> <span class="comment"></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> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * A few utilitary functions for similarity search:</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * - random generators</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * - optimized exhaustive distance and knn search functions</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * - some functions reimplemented from torch for speed</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</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">#ifndef FAISS_utils_h</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_utils_h</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// for the random data struct</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdlib></span></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="preprocessor">#include "Heap.h"</span></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> </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</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="comment">/**************************************************</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Get some stats about the system</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> </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"> 36</span> <span class="comment">/// ms elapsed since some arbitrary epoch</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span><span class="keywordtype">double</span> <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a> ();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/// get current RSS usage in kB</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span><span class="keywordtype">size_t</span> <a class="code" href="namespacefaiss.html#aa3af5769b0b649f112332a874c64d361">get_mem_usage_kb</a> ();</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="comment">/**************************************************</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * Random data generation functions</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> **************************************************/</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/// random generator that can be used in multithreaded contexts</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structfaiss_1_1RandomGenerator.html"> 48</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1RandomGenerator.html">RandomGenerator</a> {</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifdef __linux__</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span> <span class="keywordtype">char</span> rand_state [8];</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">struct </span>random_data rand_data;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#elif __APPLE__</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span> <span class="keywordtype">unsigned</span> rand_state;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// random 31-bit positive integer</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1RandomGenerator.html#a583f124ecacdbe037ac96e23a44dd420">rand_int</a> ();</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /// random long < 2 ^ 62</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1RandomGenerator.html#acbceaa8b017793ca4f8d90e644b0d7f4">rand_long</a> ();</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"> /// generate random number between 0 and max-1</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1RandomGenerator.html#a583f124ecacdbe037ac96e23a44dd420">rand_int</a> (<span class="keywordtype">int</span> max);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /// between 0 and 1</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> <span class="keywordtype">float</span> <a class="code" href="structfaiss_1_1RandomGenerator.html#ac82a433d7bfa56d750907ba5cf74aed7">rand_float</a> ();</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </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">double</span> rand_double ();</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"> /// initialize</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1RandomGenerator.html#a7633c373153f3b2824d2d99382ba20ab">RandomGenerator</a> (<span class="keywordtype">long</span> seed = 1234);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// default copy constructor messes up pointer in rand_data</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <a class="code" href="structfaiss_1_1RandomGenerator.html#a7633c373153f3b2824d2d99382ba20ab">RandomGenerator</a> (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1RandomGenerator.html">RandomGenerator</a> & other);</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"> 79</span> </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* Generate an array of uniform random floats / multi-threaded implementation */</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span> float_rand (<span class="keywordtype">float</span> * x, <span class="keywordtype">size_t</span> n, <span class="keywordtype">long</span> seed);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> float_randn (<span class="keywordtype">float</span> * x, <span class="keywordtype">size_t</span> n, <span class="keywordtype">long</span> seed);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> long_rand (<span class="keywordtype">long</span> * x, <span class="keywordtype">size_t</span> n, <span class="keywordtype">long</span> seed);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span> byte_rand (uint8_t * x, <span class="keywordtype">size_t</span> n, <span class="keywordtype">long</span> seed);</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/* random permutation */</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">void</span> rand_perm (<span class="keywordtype">int</span> * perm, <span class="keywordtype">size_t</span> n, <span class="keywordtype">long</span> seed);</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"> 90</span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">/*********************************************************</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * Optimized distance/norm/inner prod computations</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *********************************************************/</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/// Squared L2 distance between two vectors</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span><span class="keywordtype">float</span> <a class="code" href="namespacefaiss.html#a7466bd32de31640860393a701eaac5ad">fvec_L2sqr</a> (</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">size_t</span> d);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/* SSE-implementation of inner product and L2 distance */</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">float</span> fvec_inner_product (</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">size_t</span> d);</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/// a balanced assignment has a IF of 1</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span><span class="keywordtype">double</span> <a class="code" href="namespacefaiss.html#a94c1d99ac39d22e362aa27ce7c7ff714">imbalance_factor</a> (<span class="keywordtype">int</span> n, <span class="keywordtype">int</span> k, <span class="keyword">const</span> <span class="keywordtype">long</span> *assign);</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">/// same, takes a histogram as input</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span><span class="keywordtype">double</span> <a class="code" href="namespacefaiss.html#a94c1d99ac39d22e362aa27ce7c7ff714">imbalance_factor</a> (<span class="keywordtype">int</span> k, <span class="keyword">const</span> <span class="keywordtype">int</span> *hist);</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">/** Compute pairwise distances between sets of vectors</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param d dimension of the vectors</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param nq nb of query vectors</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param nb nb of database vectors</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param xq query vectors (size nq * d)</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @param xb database vectros (size nb * d)</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @param dis output distances (size nq * nb)</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @param ldq,ldb, ldd strides for the matrices</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a3d9c7db82d43c1f0ab1d28b92bc9fe57">pairwise_L2sqr</a> (<span class="keywordtype">long</span> d,</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">long</span> nq, <span class="keyword">const</span> <span class="keywordtype">float</span> *xq,</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">long</span> nb, <span class="keyword">const</span> <span class="keywordtype">float</span> *xb,</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">float</span> *dis,</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">long</span> ldq = -1, <span class="keywordtype">long</span> ldb = -1, <span class="keywordtype">long</span> ldd = -1);</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/* compute the inner product between nx vectors x and one y */</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">void</span> fvec_inner_products_ny (</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">float</span> * ip, <span class="comment">/* output inner product */</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> ny);</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">/* compute ny square L2 distance bewteen x and a set of contiguous y vectors */</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">void</span> fvec_L2sqr_ny (</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">float</span> * __restrict dis,</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> ny);</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</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">/** squared norm of a vector */</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keywordtype">float</span> <a class="code" href="namespacefaiss.html#a7a49180ebf10e643217bbce5862c7f84">fvec_norm_L2sqr</a> (<span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">size_t</span> d);</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">/** compute the L2 norms for a set of vectors</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"> * @param ip output norms, size nx</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @param x set of vectors, size nx * d</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="keywordtype">void</span> fvec_norms_L2 (<span class="keywordtype">float</span> * ip, <span class="keyword">const</span> <span class="keywordtype">float</span> * x, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx);</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">/// same as fvec_norms_L2, but computes square norms</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span><span class="keywordtype">void</span> fvec_norms_L2sqr (<span class="keywordtype">float</span> * ip, <span class="keyword">const</span> <span class="keywordtype">float</span> * x, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx);</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">/* L2-renormalize a set of vector. Nothing done if the vector is 0-normed */</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="keywordtype">void</span> fvec_renorm_L2 (<span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">float</span> * x);</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="comment">/* This function exists because the Torch counterpart is extremly slow</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> (not multi-threaded + unexpected overhead even in single thread).</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> It is here to implement the usual property |x-y|^2=|x|^2+|y|^2-2<x|y> */</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="keywordtype">void</span> inner_product_to_L2sqr (<span class="keywordtype">float</span> * __restrict dis,</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * nr1,</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * nr2,</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">size_t</span> n1, <span class="keywordtype">size_t</span> n2);</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">/***************************************************************************</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * Compute a subset of distances</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> ***************************************************************************/</span></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">/* compute the inner product between x and a subset y of ny vectors,</span></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> whose indices are given by idy. */</span></div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="keywordtype">void</span> fvec_inner_products_by_idx (</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">float</span> * __restrict ip,</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">const</span> <span class="keywordtype">long</span> * __restrict ids,</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny);</div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">/* same but for a subset in y indexed by idsy (ny vectors in total) */</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keywordtype">void</span> fvec_L2sqr_by_idx (</div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">float</span> * __restrict dis,</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keyword">const</span> <span class="keywordtype">long</span> * __restrict ids, <span class="comment">/* ids of y vecs */</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny);</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/***************************************************************************</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * KNN functions</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> </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">/** Return the k nearest neighors of each of the nx vectors x among the ny</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * vector y, w.r.t to max inner product</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * @param x query vectors, size nx * d</span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * @param y database vectors, size ny * d</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @param res result array, which also provides k. Sorted on output</span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a880c7318971f866267a86945aaa61b17">knn_inner_product</a> (</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <a class="code" href="structfaiss_1_1HeapArray.html">float_minheap_array_t</a> * res);</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">/** Same as knn_inner_product, for the L2 distance */</span></div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a2f803e3d3b07cfab63699c89de161237">knn_L2sqr</a> (</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <a class="code" href="structfaiss_1_1HeapArray.html">float_maxheap_array_t</a> * res);</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">/** same as knn_L2sqr, but base_shift[bno] is subtracted to all</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * computed distances.</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"> * @param base_shift size ny</span></div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a5eb1701e46123827966f2a56da893d1d">knn_L2sqr_base_shift</a> (</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <a class="code" href="structfaiss_1_1HeapArray.html">float_maxheap_array_t</a> * res,</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> *base_shift);</div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">/* Find the nearest neighbors for nx queries in a set of ny vectors</span></div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * indexed by ids. May be useful for re-ranking a pre-selected vector list</span></div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="keywordtype">void</span> knn_inner_products_by_idx (</div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keyword">const</span> <span class="keywordtype">long</span> * ids,</div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <a class="code" href="structfaiss_1_1HeapArray.html">float_minheap_array_t</a> * res);</div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keywordtype">void</span> knn_L2sqr_by_idx (<span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keyword">const</span> <span class="keywordtype">long</span> * __restrict ids,</div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <a class="code" href="structfaiss_1_1HeapArray.html">float_maxheap_array_t</a> * res);</div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">/***************************************************************************</span></div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * Range search</span></div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> ***************************************************************************/</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"> 252</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment">/// Forward declaration, see AuxIndexStructures.h</span></div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>;</div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">/** Return the k nearest neighors of each of the nx vectors x among the ny</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * vector y, w.r.t to max inner product</span></div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * @param x query vectors, size nx * d</span></div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * @param y database vectors, size ny * d</span></div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * @param radius search radius around the x vectors</span></div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * @param result result structure</span></div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a1faa7bd079c9b1addf3058ddf882a000">range_search_L2sqr</a> (</div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keywordtype">float</span> radius,</div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result);</div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment">/// same as range_search_L2sqr for the inner product similarity</span></div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#ab29d725b808df6f142b80f21aa45e507">range_search_inner_product</a> (</div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * y,</div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nx, <span class="keywordtype">size_t</span> ny,</div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="keywordtype">float</span> radius,</div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result);</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment">/***************************************************************************</span></div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * Misc matrix and vector manipulation functions</span></div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> ***************************************************************************/</span></div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment">/** compute c := a + bf * b for a, b and c tables</span></div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @param n size of the tables</span></div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * @param a size n</span></div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * @param b size n</span></div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * @param c restult table, size n</span></div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a40328c31abd0bbba5bd95d7de951e847">fvec_madd</a> (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *a,</div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordtype">float</span> bf, <span class="keyword">const</span> <span class="keywordtype">float</span> *b, <span class="keywordtype">float</span> *c);</div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment">/** same as fvec_madd, also return index of the min of the result table</span></div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * @return index of the min of table c</span></div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="keywordtype">int</span> <a class="code" href="namespacefaiss.html#a9da63b8bb84460f5e8ccf8e17622cc7a">fvec_madd_and_argmin</a> (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *a,</div>
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keywordtype">float</span> bf, <span class="keyword">const</span> <span class="keywordtype">float</span> *b, <span class="keywordtype">float</span> *c);</div>
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment">/* perform a reflection (not an efficient implementation, just for test ) */</span></div>
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="keywordtype">void</span> reflection (<span class="keyword">const</span> <span class="keywordtype">float</span> * u, <span class="keywordtype">float</span> * x, <span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nu);</div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">/** For k-means: update stage.</span></div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * @param x training vectors, size n * d</span></div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * @param centroids centroid vectors, size k * d</span></div>
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * @param assign nearest centroid for each training vector, size n</span></div>
|
|
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * @param k_frozen do not update the k_frozen first centroids</span></div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * @return nb of spliting operations to fight empty clusters</span></div>
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="keywordtype">int</span> <a class="code" href="namespacefaiss.html#aa2c6a9e87a64bba8e8014e14f70bde21">km_update_centroids</a> (</div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <span class="keywordtype">float</span> * centroids,</div>
|
|
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <span class="keywordtype">long</span> * assign,</div>
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> k, <span class="keywordtype">size_t</span> n,</div>
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <span class="keywordtype">size_t</span> k_frozen);</div>
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment">/** compute the Q of the QR decomposition for m > n</span></div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * @param a size n * m: input matrix and output Q</span></div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#afb68fe89ad5e948974da1b70d7b4157c">matrix_qr</a> (<span class="keywordtype">int</span> m, <span class="keywordtype">int</span> n, <span class="keywordtype">float</span> *a);</div>
|
|
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">/** distances are supposed to be sorted. Sorts indices with same distance*/</span></div>
|
|
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#ae0ee1b6fbd3d6da0f1a3550a780ca24c">ranklist_handle_ties</a> (<span class="keywordtype">int</span> k, <span class="keywordtype">long</span> *idx, <span class="keyword">const</span> <span class="keywordtype">float</span> *dis);</div>
|
|
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment">/** count the number of comon elements between v1 and v2</span></div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * algorithm = sorting + bissection to avoid double-counting duplicates</span></div>
|
|
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="keywordtype">size_t</span> <a class="code" href="namespacefaiss.html#a8dbc652ba48d41f126b8815004899448">ranklist_intersection_size</a> (<span class="keywordtype">size_t</span> k1, <span class="keyword">const</span> <span class="keywordtype">long</span> *v1,</div>
|
|
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  <span class="keywordtype">size_t</span> k2, <span class="keyword">const</span> <span class="keywordtype">long</span> *v2);</div>
|
|
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment">/** merge a result table into another one</span></div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * @param I0, D0 first result table, size (n, k)</span></div>
|
|
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * @param I1, D1 second result table, size (n, k)</span></div>
|
|
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * @param keep_min if true, keep min values, otherwise keep max</span></div>
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * @param translation add this value to all I1's indexes</span></div>
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * @return nb of values that were taken from the second table</span></div>
|
|
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="keywordtype">size_t</span> <a class="code" href="namespacefaiss.html#afb7b33f6892678ba79aaf5e71777837c">merge_result_table_with</a> (<span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> k,</div>
|
|
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  <span class="keywordtype">long</span> *I0, <span class="keywordtype">float</span> *D0,</div>
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  <span class="keyword">const</span> <span class="keywordtype">long</span> *I1, <span class="keyword">const</span> <span class="keywordtype">float</span> *D1,</div>
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  <span class="keywordtype">bool</span> keep_min = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  <span class="keywordtype">long</span> translation = 0);</div>
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> </div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> </div>
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> </div>
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="keywordtype">void</span> fvec_argsort (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *vals,</div>
|
|
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="keywordtype">size_t</span> *perm);</div>
|
|
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> </div>
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="keywordtype">void</span> fvec_argsort_parallel (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *vals,</div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keywordtype">size_t</span> *perm);</div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> </div>
|
|
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment">/// compute histogram on v</span></div>
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="namespacefaiss.html#a7bea462108bee98d8d5859b51ec4db8e">ivec_hist</a> (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">int</span> * v, <span class="keywordtype">int</span> vmax, <span class="keywordtype">int</span> *hist);</div>
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment">/** Compute histogram of bits on a code array</span></div>
|
|
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * @param codes size(n, nbits / 8)</span></div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * @param hist size(nbits): nb of 1s in the array of codes</span></div>
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="keywordtype">void</span> <a class="code" href="namespacefaiss.html#a154a47857ed321b9db91122770a16e09">bincode_hist</a>(<span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> nbits, <span class="keyword">const</span> uint8_t *codes, <span class="keywordtype">int</span> *hist);</div>
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> </div>
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment">/// compute a checksum on a table.</span></div>
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"></span><span class="keywordtype">size_t</span> <a class="code" href="namespacefaiss.html#a4369329c9dbdfe23e3f35d09ba7b5c6e">ivec_checksum</a> (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">int</span> *a);</div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> </div>
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment">/** random subsamples a set of vectors if there are too many of them</span></div>
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * @param d dimension of the vectors</span></div>
|
|
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * @param n on input: nb of input vectors, output: nb of output vectors</span></div>
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> * @param nmax max nb of vectors to keep</span></div>
|
|
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * @param x input array, size *n-by-d</span></div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * @param seed random seed to use for sampling</span></div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * @return x or an array allocated with new [] with *n vectors</span></div>
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="keyword">const</span> <span class="keywordtype">float</span> *<a class="code" href="namespacefaiss.html#a14884d253128c7af5891a65082ad7dc6">fvecs_maybe_subsample</a> (</div>
|
|
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> *n, <span class="keywordtype">size_t</span> nmax, <span class="keyword">const</span> <span class="keywordtype">float</span> *x,</div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keywordtype">bool</span> verbose = <span class="keyword">false</span>, <span class="keywordtype">long</span> seed = 1234);</div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> </div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> } <span class="comment">// namspace faiss</span></div>
|
|
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> </div>
|
|
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> </div>
|
|
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="preprocessor">#endif </span><span class="comment">/* FAISS_utils_h */</span><span class="preprocessor"></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#l00048">utils.h:48</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_aa2c6a9e87a64bba8e8014e14f70bde21"><div class="ttname"><a href="namespacefaiss.html#aa2c6a9e87a64bba8e8014e14f70bde21">faiss::km_update_centroids</a></div><div class="ttdeci">int km_update_centroids(const float *x, float *centroids, long *assign, size_t d, size_t k, size_t n, size_t k_frozen)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01399">utils.cpp:1399</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a5eb1701e46123827966f2a56da893d1d"><div class="ttname"><a href="namespacefaiss.html#a5eb1701e46123827966f2a56da893d1d">faiss::knn_L2sqr_base_shift</a></div><div class="ttdeci">void knn_L2sqr_base_shift(const float *x, const float *y, size_t d, size_t nx, size_t ny, float_maxheap_array_t *res, const float *base_shift)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00986">utils.cpp:986</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1RandomGenerator_html_a7633c373153f3b2824d2d99382ba20ab"><div class="ttname"><a href="structfaiss_1_1RandomGenerator.html#a7633c373153f3b2824d2d99382ba20ab">faiss::RandomGenerator::RandomGenerator</a></div><div class="ttdeci">RandomGenerator(long seed=1234)</div><div class="ttdoc">initialize </div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a7466bd32de31640860393a701eaac5ad"><div class="ttname"><a href="namespacefaiss.html#a7466bd32de31640860393a701eaac5ad">faiss::fvec_L2sqr</a></div><div class="ttdeci">float fvec_L2sqr(const float *x, const float *y, size_t d)</div><div class="ttdoc">Squared L2 distance between two vectors. </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00574">utils.cpp:574</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a154a47857ed321b9db91122770a16e09"><div class="ttname"><a href="namespacefaiss.html#a154a47857ed321b9db91122770a16e09">faiss::bincode_hist</a></div><div class="ttdeci">void bincode_hist(size_t n, size_t nbits, const uint8_t *codes, int *hist)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01647">utils.cpp:1647</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a14884d253128c7af5891a65082ad7dc6"><div class="ttname"><a href="namespacefaiss.html#a14884d253128c7af5891a65082ad7dc6">faiss::fvecs_maybe_subsample</a></div><div class="ttdeci">const float * fvecs_maybe_subsample(size_t d, size_t *n, size_t nmax, const float *x, bool verbose, long seed)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01973">utils.cpp:1973</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_ae0ee1b6fbd3d6da0f1a3550a780ca24c"><div class="ttname"><a href="namespacefaiss.html#ae0ee1b6fbd3d6da0f1a3550a780ca24c">faiss::ranklist_handle_ties</a></div><div class="ttdeci">void ranklist_handle_ties(int k, long *idx, const float *dis)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01493">utils.cpp:1493</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1RandomGenerator_html_ac82a433d7bfa56d750907ba5cf74aed7"><div class="ttname"><a href="structfaiss_1_1RandomGenerator.html#ac82a433d7bfa56d750907ba5cf74aed7">faiss::RandomGenerator::rand_float</a></div><div class="ttdeci">float rand_float()</div><div class="ttdoc">between 0 and 1 </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00211">utils.cpp:211</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a40328c31abd0bbba5bd95d7de951e847"><div class="ttname"><a href="namespacefaiss.html#a40328c31abd0bbba5bd95d7de951e847">faiss::fvec_madd</a></div><div class="ttdeci">void fvec_madd(size_t n, const float *a, float bf, const float *b, float *c)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01887">utils.cpp:1887</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_aa3af5769b0b649f112332a874c64d361"><div class="ttname"><a href="namespacefaiss.html#aa3af5769b0b649f112332a874c64d361">faiss::get_mem_usage_kb</a></div><div class="ttdeci">size_t get_mem_usage_kb()</div><div class="ttdoc">get current RSS usage in kB </div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a7bea462108bee98d8d5859b51ec4db8e"><div class="ttname"><a href="namespacefaiss.html#a7bea462108bee98d8d5859b51ec4db8e">faiss::ivec_hist</a></div><div class="ttdeci">int ivec_hist(size_t n, const int *v, int vmax, int *hist)</div><div class="ttdoc">compute histogram on v </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01636">utils.cpp:1636</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1RandomGenerator_html_acbceaa8b017793ca4f8d90e644b0d7f4"><div class="ttname"><a href="structfaiss_1_1RandomGenerator.html#acbceaa8b017793ca4f8d90e644b0d7f4">faiss::RandomGenerator::rand_long</a></div><div class="ttdeci">long rand_long()</div><div class="ttdoc">random long &lt; 2 ^ 62 </div></div>
|
|
<div class="ttc" id="namespacefaiss_html_afb7b33f6892678ba79aaf5e71777837c"><div class="ttname"><a href="namespacefaiss.html#afb7b33f6892678ba79aaf5e71777837c">faiss::merge_result_table_with</a></div><div class="ttdeci">size_t merge_result_table_with(size_t n, size_t k, long *I0, float *D0, const long *I1, const float *D1, bool keep_min, long translation)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01509">utils.cpp:1509</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1RandomGenerator_html_a583f124ecacdbe037ac96e23a44dd420"><div class="ttname"><a href="structfaiss_1_1RandomGenerator.html#a583f124ecacdbe037ac96e23a44dd420">faiss::RandomGenerator::rand_int</a></div><div class="ttdeci">int rand_int()</div><div class="ttdoc">random 31-bit positive integer </div></div>
|
|
<div class="ttc" id="structfaiss_1_1HeapArray_html"><div class="ttname"><a href="structfaiss_1_1HeapArray.html">faiss::HeapArray</a></div><div class="ttdef"><b>Definition:</b> <a href="Heap_8h_source.html#l00350">Heap.h:350</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a8dbc652ba48d41f126b8815004899448"><div class="ttname"><a href="namespacefaiss.html#a8dbc652ba48d41f126b8815004899448">faiss::ranklist_intersection_size</a></div><div class="ttdeci">size_t ranklist_intersection_size(size_t k1, const long *v1, size_t k2, const long *v2_in)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01574">utils.cpp:1574</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a3d9c7db82d43c1f0ab1d28b92bc9fe57"><div class="ttname"><a href="namespacefaiss.html#a3d9c7db82d43c1f0ab1d28b92bc9fe57">faiss::pairwise_L2sqr</a></div><div class="ttdeci">void pairwise_L2sqr(long d, long nq, const float *xq, long nb, const float *xb, float *dis, long ldq, long ldb, long ldd)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01342">utils.cpp:1342</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_ab29d725b808df6f142b80f21aa45e507"><div class="ttname"><a href="namespacefaiss.html#ab29d725b808df6f142b80f21aa45e507">faiss::range_search_inner_product</a></div><div class="ttdeci">void range_search_inner_product(const float *x, const float *y, size_t d, size_t nx, size_t ny, float radius, RangeSearchResult *res)</div><div class="ttdoc">same as range_search_L2sqr for the inner product similarity </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01280">utils.cpp:1280</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a880c7318971f866267a86945aaa61b17"><div class="ttname"><a href="namespacefaiss.html#a880c7318971f866267a86945aaa61b17">faiss::knn_inner_product</a></div><div class="ttdeci">void knn_inner_product(const float *x, const float *y, size_t d, size_t nx, size_t ny, float_minheap_array_t *res)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00946">utils.cpp:946</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_af2a71f7d5402ae02ce169a4cc83020eb"><div class="ttname"><a href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">faiss::getmillisecs</a></div><div class="ttdeci">double getmillisecs()</div><div class="ttdoc">ms elapsed since some arbitrary epoch </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00074">utils.cpp:74</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a94c1d99ac39d22e362aa27ce7c7ff714"><div class="ttname"><a href="namespacefaiss.html#a94c1d99ac39d22e362aa27ce7c7ff714">faiss::imbalance_factor</a></div><div class="ttdeci">double imbalance_factor(int k, const int *hist)</div><div class="ttdoc">same, takes a histogram as input </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01612">utils.cpp:1612</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a7a49180ebf10e643217bbce5862c7f84"><div class="ttname"><a href="namespacefaiss.html#a7a49180ebf10e643217bbce5862c7f84">faiss::fvec_norm_L2sqr</a></div><div class="ttdeci">float fvec_norm_L2sqr(const float *x, size_t d)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00632">utils.cpp:632</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a1faa7bd079c9b1addf3058ddf882a000"><div class="ttname"><a href="namespacefaiss.html#a1faa7bd079c9b1addf3058ddf882a000">faiss::range_search_L2sqr</a></div><div class="ttdeci">void range_search_L2sqr(const float *x, const float *y, size_t d, size_t nx, size_t ny, float radius, RangeSearchResult *res)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01265">utils.cpp:1265</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_afb68fe89ad5e948974da1b70d7b4157c"><div class="ttname"><a href="namespacefaiss.html#afb68fe89ad5e948974da1b70d7b4157c">faiss::matrix_qr</a></div><div class="ttdeci">void matrix_qr(int m, int n, float *a)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01320">utils.cpp:1320</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="namespacefaiss_html_a4369329c9dbdfe23e3f35d09ba7b5c6e"><div class="ttname"><a href="namespacefaiss.html#a4369329c9dbdfe23e3f35d09ba7b5c6e">faiss::ivec_checksum</a></div><div class="ttdeci">size_t ivec_checksum(size_t n, const int *a)</div><div class="ttdoc">compute a checksum on a table. </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01670">utils.cpp:1670</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a9da63b8bb84460f5e8ccf8e17622cc7a"><div class="ttname"><a href="namespacefaiss.html#a9da63b8bb84460f5e8ccf8e17622cc7a">faiss::fvec_madd_and_argmin</a></div><div class="ttdeci">int fvec_madd_and_argmin(size_t n, const float *a, float bf, const float *b, float *c)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01961">utils.cpp:1961</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_a2f803e3d3b07cfab63699c89de161237"><div class="ttname"><a href="namespacefaiss.html#a2f803e3d3b07cfab63699c89de161237">faiss::knn_L2sqr</a></div><div class="ttdeci">void knn_L2sqr(const float *x, const float *y, size_t d, size_t nx, size_t ny, float_maxheap_array_t *res)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00966">utils.cpp:966</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>
|