167 lines
16 KiB
HTML
167 lines
16 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/c_api/IndexIVFFlat_c.cpp 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>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_5fcc7c5aeda0d349161ae950b251beed.html">c_api</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">IndexIVFFlat_c.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// -*- c++ -*-</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "Index_c.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "Clustering_c.h"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "IndexIVFFlat_c.h"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "IndexIVFFlat.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "macros_impl.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">using</span> <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">using</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a>;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using</span> <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a>;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> DEFINE_DESTRUCTOR(<a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>)</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> DEFINE_INDEX_DOWNCAST(<a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>)</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="keywordtype">int</span> faiss_IndexIVFFlat_new(FaissIndexIVFFlat** p_index) {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">try</span> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  *p_index = <span class="keyword">reinterpret_cast<</span>FaissIndexIVFFlat*<span class="keyword">></span>(<span class="keyword">new</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>());</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  } CATCH_AND_HANDLE</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="keywordtype">int</span> faiss_IndexIVFFlat_new_with(FaissIndexIVFFlat** p_index,</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  FaissIndex* quantizer, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nlist)</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">try</span> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">auto</span> q = <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">Index</a>*<span class="keyword">></span>(quantizer);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  *p_index = <span class="keyword">reinterpret_cast<</span>FaissIndexIVFFlat*<span class="keyword">></span>(<span class="keyword">new</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>(q, d, nlist));</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  } CATCH_AND_HANDLE</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> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">int</span> faiss_IndexIVFFlat_new_with_metric(</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  FaissIndexIVFFlat** p_index, FaissIndex* quantizer, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nlist,</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  FaissMetricType metric)</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">try</span> {</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">auto</span> q = <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">Index</a>*<span class="keyword">></span>(quantizer);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">auto</span> m = <span class="keyword">static_cast<</span><a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a><span class="keyword">></span>(metric);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  *p_index = <span class="keyword">reinterpret_cast<</span>FaissIndexIVFFlat*<span class="keyword">></span>(<span class="keyword">new</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>(q, d, nlist, m));</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  } CATCH_AND_HANDLE</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> </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">int</span> faiss_IndexIVFFlat_add_core(FaissIndexIVFFlat* index, idx_t n, </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <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">const</span> <span class="keywordtype">long</span> *precomputed_idx)</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">try</span> {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>*<span class="keyword">></span>(index)->add_core(n, x, xids, precomputed_idx);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  } CATCH_AND_HANDLE</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">int</span> faiss_IndexIVFFlat_update_vectors(FaissIndexIVFFlat* index, <span class="keywordtype">int</span> nv,</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  idx_t *idx, <span class="keyword">const</span> <span class="keywordtype">float</span> *v)</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">try</span> {</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>*<span class="keyword">></span>(index)->update_vectors(nv, idx, v);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  } CATCH_AND_HANDLE</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div>
|
|
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8h_source.html#l00025">IndexIVFFlat.h:25</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#l00062">Index.h:62</a></div></div>
|
|
<div class="ttc" id="namespacefaiss_html_afd12191c638da74760ff397cf319752c"><div class="ttname"><a href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a></div><div class="ttdeci">MetricType</div><div class="ttdoc">Some algorithms support both an inner product version and a L2 search version. </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00045">Index.h:45</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>
|