162 lines
18 KiB
HTML
162 lines
18 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: /tmp/faiss/IndexBinaryFlat.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">/tmp/faiss/IndexBinaryFlat.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// -*- c++ -*-</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef INDEX_BINARY_FLAT_H</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define INDEX_BINARY_FLAT_H</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "IndexBinary.h"</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/** Index that stores the full vectors and performs exhaustive search. */</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryFlat.html"> 22</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexBinaryFlat.html">IndexBinaryFlat</a> : <a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> {<span class="comment"></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> /// database vectors, size ntotal * d / 8</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryFlat.html#afc0b5b076b35a1a1889b0012848c795c"> 24</a></span> <span class="comment"></span> std::vector<uint8_t> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#afc0b5b076b35a1a1889b0012848c795c">xb</a>;</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /** Select between using a heap or counting to select the k smallest values</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * when scanning inverted lists.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryFlat.html#a9fa80e22a4accee4da0ee152a4910c1b"> 29</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#a9fa80e22a4accee4da0ee152a4910c1b">use_heap</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">size_t</span> query_batch_size = 32;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html">IndexBinaryFlat</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> <a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>);</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="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#ad2e6f7d9e4672caff89b6045cd2a808a">add</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, <span class="keyword">const</span> uint8_t *x) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#a1765bac1dad81f86e226446483b5470e">reset</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#a473e35ebabadc79869ca89f987553b13">search</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, <span class="keyword">const</span> uint8_t *x, <a class="code" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> k,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  int32_t *distances, <a class="code" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> *labels) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#a65c83fa2f2740fc17089e63dc7b70076">reconstruct</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> key, uint8_t *recons) <span class="keyword">const override</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"> /** Remove some ids. Note that because of the indexing structure,</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * the semantics of this operation are different from the usual ones:</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * the new ids are shifted. */</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1IndexBinaryFlat.html#aabfbe7b0938f28a3eefeeedea4b7b545">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>& sel) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structfaiss_1_1IndexBinaryFlat.html">IndexBinaryFlat</a>() {}</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <span class="comment">// namespace faiss</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif // INDEX_BINARY_FLAT_H</span></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html">faiss::IndexBinaryFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8h_source.html#l00022">IndexBinaryFlat.h:22</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_ad2e6f7d9e4672caff89b6045cd2a808a"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#ad2e6f7d9e4672caff89b6045cd2a808a">faiss::IndexBinaryFlat::add</a></div><div class="ttdeci">void add(idx_t n, const uint8_t *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8cpp_source.html#l00025">IndexBinaryFlat.cpp:25</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00054">AuxIndexStructures.h:54</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_aabfbe7b0938f28a3eefeeedea4b7b545"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#aabfbe7b0938f28a3eefeeedea4b7b545">faiss::IndexBinaryFlat::remove_ids</a></div><div class="ttdeci">long remove_ids(const IDSelector &sel) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8cpp_source.html#l00059">IndexBinaryFlat.cpp:59</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_a473e35ebabadc79869ca89f987553b13"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#a473e35ebabadc79869ca89f987553b13">faiss::IndexBinaryFlat::search</a></div><div class="ttdeci">void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8cpp_source.html#l00035">IndexBinaryFlat.cpp:35</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_a65c83fa2f2740fc17089e63dc7b70076"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#a65c83fa2f2740fc17089e63dc7b70076">faiss::IndexBinaryFlat::reconstruct</a></div><div class="ttdeci">void reconstruct(idx_t key, uint8_t *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8cpp_source.html#l00079">IndexBinaryFlat.cpp:79</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a0e485a7189eec2675032486d3b12cf88"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">faiss::IndexBinary::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00040">IndexBinary.h:40</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_a9fa80e22a4accee4da0ee152a4910c1b"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#a9fa80e22a4accee4da0ee152a4910c1b">faiss::IndexBinaryFlat::use_heap</a></div><div class="ttdeci">bool use_heap</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8h_source.html#l00029">IndexBinaryFlat.h:29</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_a1765bac1dad81f86e226446483b5470e"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#a1765bac1dad81f86e226446483b5470e">faiss::IndexBinaryFlat::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">Removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8cpp_source.html#l00030">IndexBinaryFlat.cpp:30</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinaryFlat_html_afc0b5b076b35a1a1889b0012848c795c"><div class="ttname"><a href="structfaiss_1_1IndexBinaryFlat.html#afc0b5b076b35a1a1889b0012848c795c">faiss::IndexBinaryFlat::xb</a></div><div class="ttdeci">std::vector< uint8_t > xb</div><div class="ttdoc">database vectors, size ntotal * d / 8 </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryFlat_8h_source.html#l00024">IndexBinaryFlat.h:24</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00037">IndexBinary.h:37</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1IndexBinary_html_ace45f4c385c2faaaa1617bb81b26e91b"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">faiss::IndexBinary::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="IndexBinary_8h_source.html#l00038">IndexBinary.h:38</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>
|