241 lines
38 KiB
HTML
241 lines
38 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/IndexIVFScalarQuantizer.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/IndexIVFScalarQuantizer.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 CC-by-NC 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="preprocessor">#ifndef FAISS_INDEX_IVF_SCALAR_QUANTIZER_H</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_IVF_SCALAR_QUANTIZER_H</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</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> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "IndexIVF.h"</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> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/** An IVF implementation where the components of the residuals are</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * encoded with a scalar uniform quantizer. All distance computations</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * are asymmetric, so the encoded vectors are decoded and approximate</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * distances are computed.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * The uniform quantizer has a range [vmin, vmax]. The range can be</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * the same for all dimensions (uniform) or specific per dimension</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * (default).</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> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html"> 34</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1ScalarQuantizer.html">ScalarQuantizer</a> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e"> 36</a></span>  <span class="keyword">enum</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e">QuantizerType</a> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2"> 37</a></span>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2">QT_8bit</a>, <span class="comment">///< 8 bits per component</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b"> 38</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b">QT_4bit</a>, <span class="comment">///< 4 bits per component</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754"> 39</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754">QT_8bit_uniform</a>, <span class="comment">///< same, shared range for all dimensions</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> QT_4bit_uniform,</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>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e">QuantizerType</a> qtype;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /** The uniform encoder can estimate the range of representable</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * values of the unform encoder using different statistics. Here</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * rs = rangestat_arg */</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// rangestat_arg.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06"> 50</a></span>  <span class="keyword">enum</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06">RangeStat</a> {</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8"> 51</a></span>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8">RS_minmax</a>, <span class="comment">///< [min - rs*(max-min), max + rs*(max-min)]</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c"> 52</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c">RS_meanstd</a>, <span class="comment">///< [mean - std * rs, mean + std * rs]</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7"> 53</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7">RS_quantiles</a>, <span class="comment">///< [Q(rs), Q(1-rs)]</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7"> 54</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7">RS_optim</a>, <span class="comment">///< alternate optimization of reconstruction error</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> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06">RangeStat</a> rangestat;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">float</span> rangestat_arg;</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"> /// dimension of input vectors</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49"> 61</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49">d</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"> /// bytes per vector</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a647b8774e4cd8ca5623a194f5c7f8a33"> 64</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a647b8774e4cd8ca5623a194f5c7f8a33">code_size</a>;</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"> /// trained values (including the range)</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structfaiss_1_1ScalarQuantizer.html#a64d1560806e6746d6cd1fee089c6a13f"> 67</a></span> <span class="comment"></span> std::vector<float> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a64d1560806e6746d6cd1fee089c6a13f">trained</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>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html">ScalarQuantizer</a> (<span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49">d</a>, <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e">QuantizerType</a> qtype);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html">ScalarQuantizer</a> ();</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> train (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// same as compute_code for several vectors</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a2bccf276565c4f80fed3d0c715c58816">compute_codes</a> (<span class="keyword">const</span> <span class="keywordtype">float</span> * x,</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  uint8_t * codes,</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">size_t</span> n) <span class="keyword">const</span> ;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> /// decode a vector from a given code (or n vectors if third argument)</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a7ab9e9158da1777d45e6f9bf73bfd489">decode</a> (<span class="keyword">const</span> uint8_t *code, <span class="keywordtype">float</span> *x, <span class="keywordtype">size_t</span> n) <span class="keyword">const</span>;</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> </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFScalarQuantizer.html"> 86</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html">IndexIVFScalarQuantizer</a>:<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> {</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html">ScalarQuantizer</a> sq;</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>  <span class="keywordtype">size_t</span> code_size;</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /// inverted list codes.</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFScalarQuantizer.html#aa4764c6d0d4175e01e3c92d3334bc996"> 92</a></span> <span class="comment"></span> std::vector<std::vector<uint8_t> > <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html#aa4764c6d0d4175e01e3c92d3334bc996">codes</a>;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html">IndexIVFScalarQuantizer</a>(<a class="code" href="structfaiss_1_1Index.html">Index</a> *<a class="code" href="structfaiss_1_1IndexIVF.html#a4b40cc7a70dff41196a3b8769586667a">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#ab38fde4c923abefc4185eb7450b5b95b">nlist</a>,</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e">ScalarQuantizer::QuantizerType</a> qtype,</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric = METRIC_L2);</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>  <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html">IndexIVFScalarQuantizer</a>();</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html#ac05d7fbfed59c85d1cf8ae526d279744">train_residual</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="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html#afa95c17787b7e3dbed9309b440d4d748">add_with_ids</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">const</span> <span class="keywordtype">long</span>* xids) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html#a0e1197a21c9291a2d570116f72fd2196">search</a>(</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">float</span>* distances,</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</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="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFScalarQuantizer.html#afd54410889924a0cb544f1e3fd5babe9">merge_from_residuals</a>(<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a>& other) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </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> </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> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVF_html"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00045">IndexIVF.h:45</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a647b8774e4cd8ca5623a194f5c7f8a33"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a647b8774e4cd8ca5623a194f5c7f8a33">faiss::ScalarQuantizer::code_size</a></div><div class="ttdeci">size_t code_size</div><div class="ttdoc">bytes per vector </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00064">IndexIVFScalarQuantizer.h:64</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a1201dbd1611fa5c10782ade5d0e4952e"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e">faiss::ScalarQuantizer::QuantizerType</a></div><div class="ttdeci">QuantizerType</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00036">IndexIVFScalarQuantizer.h:36</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a64d1560806e6746d6cd1fee089c6a13f"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a64d1560806e6746d6cd1fee089c6a13f">faiss::ScalarQuantizer::trained</a></div><div class="ttdeci">std::vector< float > trained</div><div class="ttdoc">trained values (including the range) </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00067">IndexIVFScalarQuantizer.h:67</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFScalarQuantizer_html_ac05d7fbfed59c85d1cf8ae526d279744"><div class="ttname"><a href="structfaiss_1_1IndexIVFScalarQuantizer.html#ac05d7fbfed59c85d1cf8ae526d279744">faiss::IndexIVFScalarQuantizer::train_residual</a></div><div class="ttdeci">void train_residual(idx_t n, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8cpp_source.html#l00714">IndexIVFScalarQuantizer.cpp:714</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFScalarQuantizer_html_a0e1197a21c9291a2d570116f72fd2196"><div class="ttname"><a href="structfaiss_1_1IndexIVFScalarQuantizer.html#a0e1197a21c9291a2d570116f72fd2196">faiss::IndexIVFScalarQuantizer::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="IndexIVFScalarQuantizer_8cpp_source.html#l00849">IndexIVFScalarQuantizer.cpp:849</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFScalarQuantizer_html_afd54410889924a0cb544f1e3fd5babe9"><div class="ttname"><a href="structfaiss_1_1IndexIVFScalarQuantizer.html#afd54410889924a0cb544f1e3fd5babe9">faiss::IndexIVFScalarQuantizer::merge_from_residuals</a></div><div class="ttdeci">void merge_from_residuals(IndexIVF &other) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8cpp_source.html#l00882">IndexIVFScalarQuantizer.cpp:882</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html">faiss::ScalarQuantizer</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00034">IndexIVFScalarQuantizer.h:34</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7">faiss::ScalarQuantizer::RS_optim</a></div><div class="ttdoc">alternate optimization of reconstruction error </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00054">IndexIVFScalarQuantizer.h:54</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFScalarQuantizer_html_afa95c17787b7e3dbed9309b440d4d748"><div class="ttname"><a href="structfaiss_1_1IndexIVFScalarQuantizer.html#afa95c17787b7e3dbed9309b440d4d748">faiss::IndexIVFScalarQuantizer::add_with_ids</a></div><div class="ttdeci">void add_with_ids(idx_t n, const float *x, const long *xids) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8cpp_source.html#l00733">IndexIVFScalarQuantizer.cpp:733</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_1IndexIVF_html_a4b40cc7a70dff41196a3b8769586667a"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a4b40cc7a70dff41196a3b8769586667a">faiss::IndexIVF::quantizer</a></div><div class="ttdeci">Index * quantizer</div><div class="ttdoc">quantizer that maps vectors to inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00049">IndexIVF.h:49</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_1ScalarQuantizer_html_a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754">faiss::ScalarQuantizer::QT_8bit_uniform</a></div><div class="ttdoc">same, shared range for all dimensions </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00039">IndexIVFScalarQuantizer.h:39</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a867ad0000e4ccfd40bbb1e01e7882d06"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06">faiss::ScalarQuantizer::RangeStat</a></div><div class="ttdeci">RangeStat</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00050">IndexIVFScalarQuantizer.h:50</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFScalarQuantizer_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFScalarQuantizer.html">faiss::IndexIVFScalarQuantizer</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00086">IndexIVFScalarQuantizer.h:86</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2">faiss::ScalarQuantizer::QT_8bit</a></div><div class="ttdoc">8 bits per component </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00037">IndexIVFScalarQuantizer.h:37</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7">faiss::ScalarQuantizer::RS_quantiles</a></div><div class="ttdoc">[Q(rs), Q(1-rs)] </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00053">IndexIVFScalarQuantizer.h:53</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a7ab9e9158da1777d45e6f9bf73bfd489"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a7ab9e9158da1777d45e6f9bf73bfd489">faiss::ScalarQuantizer::decode</a></div><div class="ttdeci">void decode(const uint8_t *code, float *x, size_t n) const </div><div class="ttdoc">decode a vector from a given code (or n vectors if third argument) </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8cpp_source.html#l00685">IndexIVFScalarQuantizer.cpp:685</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a2bccf276565c4f80fed3d0c715c58816"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a2bccf276565c4f80fed3d0c715c58816">faiss::ScalarQuantizer::compute_codes</a></div><div class="ttdeci">void compute_codes(const float *x, uint8_t *codes, size_t n) const </div><div class="ttdoc">same as compute_code for several vectors </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8cpp_source.html#l00674">IndexIVFScalarQuantizer.cpp:674</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b">faiss::ScalarQuantizer::QT_4bit</a></div><div class="ttdoc">4 bits per component </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00038">IndexIVFScalarQuantizer.h:38</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8">faiss::ScalarQuantizer::RS_minmax</a></div><div class="ttdoc">[min - rs*(max-min), max + rs*(max-min)] </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00051">IndexIVFScalarQuantizer.h:51</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVF_html_ab38fde4c923abefc4185eb7450b5b95b"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#ab38fde4c923abefc4185eb7450b5b95b">faiss::IndexIVF::nlist</a></div><div class="ttdeci">size_t nlist</div><div class="ttdoc">number of possible key values </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00046">IndexIVF.h:46</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_1IndexIVFScalarQuantizer_html_aa4764c6d0d4175e01e3c92d3334bc996"><div class="ttname"><a href="structfaiss_1_1IndexIVFScalarQuantizer.html#aa4764c6d0d4175e01e3c92d3334bc996">faiss::IndexIVFScalarQuantizer::codes</a></div><div class="ttdeci">std::vector< std::vector< uint8_t > > codes</div><div class="ttdoc">inverted list codes. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00092">IndexIVFScalarQuantizer.h:92</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c">faiss::ScalarQuantizer::RS_meanstd</a></div><div class="ttdoc">[mean - std * rs, mean + std * rs] </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00052">IndexIVFScalarQuantizer.h:52</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ScalarQuantizer_html_acd88af01ad1d06560cecc30bc38aef49"><div class="ttname"><a href="structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49">faiss::ScalarQuantizer::d</a></div><div class="ttdeci">size_t d</div><div class="ttdoc">dimension of input vectors </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFScalarQuantizer_8h_source.html#l00061">IndexIVFScalarQuantizer.h:61</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 vetsion 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><!-- 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>
|