<!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/Index_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">Index_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 "Index.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "macros_impl.h"</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="keyword">extern</span> <span class="stringliteral">"C"</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> DEFINE_DESTRUCTOR(Index)</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> DEFINE_GETTER(Index, <span class="keywordtype">int</span>, d)</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_GETTER(Index, <span class="keywordtype">int</span>, is_trained)</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> DEFINE_GETTER(Index, idx_t, ntotal)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> DEFINE_GETTER(Index, FaissMetricType, metric_type)</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="keywordtype">int</span> faiss_Index_train(FaissIndex* index, idx_t n, const <span class="keywordtype">float</span>* x) {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->train(n, x);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  } CATCH_AND_HANDLE</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"> 34</span> <span class="keywordtype">int</span> faiss_Index_add(FaissIndex* index, idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->add(n, x);</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_Index_add_with_ids(FaissIndex* index, idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keyword">const</span> <span class="keywordtype">long</span>* xids) {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->add_with_ids(n, x, xids);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">int</span> faiss_Index_search(<span class="keyword">const</span> FaissIndex* index, idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, idx_t k,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">float</span>* distances, idx_t* labels) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->search(n, x, k, distances, labels);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  } CATCH_AND_HANDLE</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="keywordtype">int</span> faiss_Index_range_search(<span class="keyword">const</span> FaissIndex* index, idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keywordtype">float</span> radius,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  FaissRangeSearchResult* result) {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->range_search(</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  n, x, radius, reinterpret_cast<faiss::RangeSearchResult*>(result));</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">int</span> faiss_Index_assign(FaissIndex* index, idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span> * x, idx_t * labels, idx_t k) {</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_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->assign(n, x, labels, k);</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="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">int</span> faiss_Index_reset(FaissIndex* index) {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->reset();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> faiss_Index_remove_ids(FaissIndex* index, <span class="keyword">const</span> FaissIDSelector* sel, <span class="keywordtype">long</span>* n_removed) {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">long</span> n = <span class="keyword">reinterpret_cast<</span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->remove_ids(</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  *reinterpret_cast<const faiss::IDSelector*>(sel));</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span> (n_removed) {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  *n_removed = n;</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>  } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</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> <span class="keywordtype">int</span> faiss_Index_reconstruct(<span class="keyword">const</span> FaissIndex* index, idx_t key, <span class="keywordtype">float</span>* recons) {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->reconstruct(key, recons);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }</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">int</span> faiss_Index_reconstruct_n (<span class="keyword">const</span> FaissIndex* index, idx_t i0, idx_t ni, <span class="keywordtype">float</span>* recons) {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->reconstruct_n(i0, ni, recons);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  } CATCH_AND_HANDLE</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> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">int</span> faiss_Index_compute_residual(<span class="keyword">const</span> FaissIndex* index, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keywordtype">float</span>* residual, idx_t key) {</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->compute_residual(x, residual, key);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  } CATCH_AND_HANDLE</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> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">int</span> faiss_Index_display(<span class="keyword">const</span> FaissIndex* index) {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>*<span class="keyword">></span>(index)->display();</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> }</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> }</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><!-- 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>