mirrors
/
faiss
mirror of https://github.com/facebookresearch/faiss.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
faiss/docs/html/Clustering__c_8cpp_source.html

261 lines
37 KiB
HTML
Raw Normal View History

Facebook sync (Dec 2018). (#660) * Add GpuIndexBinaryFlat * Add IndexBinaryHNSW
2018-12-20 00:48:35 +08:00
<!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/Clustering_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&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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">Clustering_c.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<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>&#160;<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>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;Clustering_c.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;Clustering.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;Index.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;macros_impl.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1Clustering.html">faiss::Clustering</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1ClusteringParameters.html">faiss::ClusteringParameters</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>, <span class="keywordtype">int</span>, niter)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;DEFINE_GETTER(<a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>, <span class="keywordtype">int</span>, nredo)</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, verbose)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, spherical)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, update_index)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, frozen_centroids)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, min_points_per_centroid)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, max_points_per_centroid)</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;DEFINE_GETTER(Clustering, <span class="keywordtype">int</span>, seed)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">/// getter for d</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"></span>DEFINE_GETTER(Clustering, <span class="keywordtype">size_t</span>, d)</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">/// getter for k</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"></span>DEFINE_GETTER(Clustering, <span class="keywordtype">size_t</span>, k)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keywordtype">void</span> faiss_ClusteringParameters_init(<a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a>* params) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> d;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; params-&gt;frozen_centroids = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215">frozen_centroids</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; params-&gt;max_points_per_centroid = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; params-&gt;min_points_per_centroid = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a5af907901147a9b1e748b13305839924">min_points_per_centroid</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; params-&gt;niter = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">niter</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; params-&gt;nredo = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">nredo</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; params-&gt;seed = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">seed</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; params-&gt;spherical = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">spherical</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; params-&gt;update_index = d.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a27d6192097920fa981cff0acedfaac91">update_index</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; params-&gt;verbose = d.verbose; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">// This conversion is required because the two types are not memory-compatible</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">inline</span> <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> from_faiss_c(<span class="keyword">const</span> <a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a>* params) {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> o;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215">frozen_centroids</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a1caad79e8c8fde45bbc63c7c6da303f1">frozen_centroids</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#ac8c19c0252c7408d3d77c97fd9d9ad15">max_points_per_centroid</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a5af907901147a9b1e748b13305839924">min_points_per_centroid</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a078058f0c09e2fd560dd497115e30ab7">min_points_per_centroid</a>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">niter</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a56185e0e0b9f0c37d35ef64e42aea1a3">niter</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">nredo</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a7cf97c4d30080402e2b3dd5577f46225">nredo</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">seed</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a4ce5970d8ccb1c014a2d9ace87d66da6">seed</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">spherical</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a969ad16df5fb6730c94280e187fb6de5">spherical</a>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; o.<a class="code" href="structfaiss_1_1ClusteringParameters.html#a27d6192097920fa981cff0acedfaac91">update_index</a> = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a1764fa98f759b20fde75abbb2616f844">update_index</a>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; o.verbose = params-&gt;<a class="code" href="structFaissClusteringParameters.html#a25ee71d2a611b737caaf8d43e04196f6">verbose</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> o;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment">/// getter for centroids (size = k * d)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"></span><span class="keywordtype">void</span> faiss_Clustering_centroids(</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; FaissClustering* clustering, <span class="keywordtype">float</span>** centroids, <span class="keywordtype">size_t</span>* size) {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; std::vector&lt;float&gt;&amp; v = <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>*<span class="keyword">&gt;</span>(clustering)-&gt;centroids;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">if</span> (centroids) {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; *centroids = v.data();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordflow">if</span> (size) {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; *size = v.size();</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; }</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;}</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment">/// getter for objective values (sum of distances reported by index)</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment">/// over iterations</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"></span><span class="keywordtype">void</span> faiss_Clustering_obj(</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; FaissClustering* clustering, <span class="keywordtype">float</span>** obj, <span class="keywordtype">size_t</span>* size) {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; std::vector&lt;float&gt;&amp; v = <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>*<span class="keyword">&gt;</span>(clustering)-&gt;obj;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span> (obj) {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; *obj = v.data();</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">if</span> (size) {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; *size = v.size();</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;}</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment">/// the only mandatory parameters are k and d</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> faiss_Clustering_new(FaissClustering** p_clustering, <span class="keywordtype">int</span> d, <span class="keywordtype">int</span> k) {</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>* c = <span class="keyword">new</span> <a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>(d, k);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; *p_clustering = <span class="keyword">reinterpret_cast&lt;</span>FaissClustering*<span class="keyword">&gt;</span>(c);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;}</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="keywordtype">int</span> faiss_Clustering_new_with_params(</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; FaissClustering** p_clustering, <span class="keywordtype">int</span> d, <span class="keywordtype">int</span> k, <span class="keyword">const</span> <a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a>* cp) {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>* c = <span class="keyword">new</span> <a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>(d, k, from_faiss_c(cp));</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; *p_clustering = <span class="keyword">reinterpret_cast&lt;</span>FaissClustering*<span class="keyword">&gt;</span>(c);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;}</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment">/// Index is used during the assignment stage</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> faiss_Clustering_train(</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; FaissClustering* clustering, idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, FaissIndex* index) {</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>*<span class="keyword">&gt;</span>(clustering)-&gt;train(</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; n, x, *reinterpret_cast&lt;Index*&gt;(index));</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;}</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="keywordtype">void</span> faiss_Clustering_free(FaissClustering* clustering) {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">delete</span> <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="structfaiss_1_1Clustering.html">Clustering</a>*<span class="keyword">&gt;</span>(clustering);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;}</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="keywordtype">int</span> faiss_kmeans_clustering (<span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> k,</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> *x,</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordtype">float</span> *centroids,</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordtype">float</span> *q_error) {</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">float</span> out = <a class="code" href="namespacefaiss.html#a38bd0dde8a1b229201a5fcb64d05daa6">faiss::kmeans_clustering</a>(d, n, k, x, centroids);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordflow">if</span> (q_error) {</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; *q_error = out;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; }</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; } CATCH_AND_HANDLE</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;}</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;}</div>
<div class="ttc" id="structFaissClusteringParameters_html_a7cf97c4d30080402e2b3dd5577f46225"><div class="ttname"><a href="structFaissClusteringParameters.html#a7cf97c4d30080402e2b3dd5577f46225">FaissClusteringParameters::nredo</a></div><div class="ttdeci">int nredo</div><div class="ttdoc">redo clustering this many times and keep best </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00027">Clustering_c.h:27</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a5c7c6f05c75e1668befdb3be148fd5f9"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">faiss::ClusteringParameters::niter</a></div><div class="ttdeci">int niter</div><div class="ttdoc">clustering iterations </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00024">Clustering.h:24</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a11a049c40c376c57ac6cc3b8d5d1d58b"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">faiss::ClusteringParameters::nredo</a></div><div class="ttdeci">int nredo</div><div class="ttdoc">redo clustering this many times and keep best </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00025">Clustering.h:25</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_a969ad16df5fb6730c94280e187fb6de5"><div class="ttname"><a href="structFaissClusteringParameters.html#a969ad16df5fb6730c94280e187fb6de5">FaissClusteringParameters::spherical</a></div><div class="ttdeci">int spherical</div><div class="ttdoc">(bool) do we want normalized centroids? </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00030">Clustering_c.h:30</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a509c65e2ebe6ecabebd163ecb03c5579"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">faiss::ClusteringParameters::seed</a></div><div class="ttdeci">int seed</div><div class="ttdoc">seed for the random number generator </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00035">Clustering.h:35</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_ad142063e035f2a0414233f9711e16215"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215">faiss::ClusteringParameters::frozen_centroids</a></div><div class="ttdeci">bool frozen_centroids</div><div class="ttdoc">use the centroids provided as input and do not change them during iterations </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00030">Clustering.h:30</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html"><div class="ttname"><a href="structFaissClusteringParameters.html">FaissClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00025">Clustering_c.h:25</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_a1caad79e8c8fde45bbc63c7c6da303f1"><div class="ttname"><a href="structFaissClusteringParameters.html#a1caad79e8c8fde45bbc63c7c6da303f1">FaissClusteringParameters::frozen_centroids</a></div><div class="ttdeci">int frozen_centroids</div><div class="ttdoc">(bool) use the centroids provided as input and do not change them during iterations ...</div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00032">Clustering_c.h:32</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_ac8c19c0252c7408d3d77c97fd9d9ad15"><div class="ttname"><a href="structFaissClusteringParameters.html#ac8c19c0252c7408d3d77c97fd9d9ad15">FaissClusteringParameters::max_points_per_centroid</a></div><div class="ttdeci">int max_points_per_centroid</div><div class="ttdoc">to limit size of dataset </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00035">Clustering_c.h:35</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a5af907901147a9b1e748b13305839924"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a5af907901147a9b1e748b13305839924">faiss::ClusteringParameters::min_points_per_centroid</a></div><div class="ttdeci">int min_points_per_centroid</div><div class="ttdoc">otherwise you get a warning </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00032">Clustering.h:32</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html"><div class="ttname"><a href="structfaiss_1_1Clustering.html">faiss::Clustering</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00056">Clustering.h:56</a></div></div>
<div class="ttc" id="namespacefaiss_html_a38bd0dde8a1b229201a5fcb64d05daa6"><div class="ttname"><a href="namespacefaiss.html#a38bd0dde8a1b229201a5fcb64d05daa6">faiss::kmeans_clustering</a></div><div class="ttdeci">float kmeans_clustering(size_t d, size_t n, size_t k, const float *x, float *centroids)</div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8cpp_source.html#l00238">Clustering.cpp:238</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_a4ce5970d8ccb1c014a2d9ace87d66da6"><div class="ttname"><a href="structFaissClusteringParameters.html#a4ce5970d8ccb1c014a2d9ace87d66da6">FaissClusteringParameters::seed</a></div><div class="ttdeci">int seed</div><div class="ttdoc">seed for the random number generator </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00037">Clustering_c.h:37</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a27d6192097920fa981cff0acedfaac91"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a27d6192097920fa981cff0acedfaac91">faiss::ClusteringParameters::update_index</a></div><div class="ttdeci">bool update_index</div><div class="ttdoc">update index after each iteration? </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00029">Clustering.h:29</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html">faiss::ClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00023">Clustering.h:23</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_a56185e0e0b9f0c37d35ef64e42aea1a3"><div class="ttname"><a href="structFaissClusteringParameters.html#a56185e0e0b9f0c37d35ef64e42aea1a3">FaissClusteringParameters::niter</a></div><div class="ttdeci">int niter</div><div class="ttdoc">clustering iterations </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00026">Clustering_c.h:26</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="structFaissClusteringParameters_html_a1764fa98f759b20fde75abbb2616f844"><div class="ttname"><a href="structFaissClusteringParameters.html#a1764fa98f759b20fde75abbb2616f844">FaissClusteringParameters::update_index</a></div><div class="ttdeci">int update_index</div><div class="ttdoc">(bool) update index after each iteration? </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00031">Clustering_c.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_ad997fb511f574f7ddc69938c21612f8d"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">faiss::ClusteringParameters::spherical</a></div><div class="ttdeci">bool spherical</div><div class="ttdoc">do we want normalized centroids? </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00028">Clustering.h:28</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_a078058f0c09e2fd560dd497115e30ab7"><div class="ttname"><a href="structFaissClusteringParameters.html#a078058f0c09e2fd560dd497115e30ab7">FaissClusteringParameters::min_points_per_centroid</a></div><div class="ttdeci">int min_points_per_centroid</div><div class="ttdoc">otherwise you get a warning </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00034">Clustering_c.h:34</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a993e0a035248faad6e292a5ef9af1953"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">faiss::ClusteringParameters::max_points_per_centroid</a></div><div class="ttdeci">int max_points_per_centroid</div><div class="ttdoc">to limit size of dataset </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00033">Clustering.h:33</a></div></div>
<div class="ttc" id="structFaissClusteringParameters_html_a25ee71d2a611b737caaf8d43e04196f6"><div class="ttname"><a href="structFaissClusteringParameters.html#a25ee71d2a611b737caaf8d43e04196f6">FaissClusteringParameters::verbose</a></div><div class="ttdeci">int verbose</div><div class="ttdoc">(bool) </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00029">Clustering_c.h:29</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>