faiss/docs/html/Clustering_8cpp_source.html

386 lines
58 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/hoss/faiss/Clustering.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>
</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">&#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 class="header">
<div class="headertitle">
<div class="title">/data/users/hoss/faiss/Clustering.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) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;Clustering.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;AuxIndexStructures.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;cstdio&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</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="preprocessor">#include &quot;utils.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;FaissAssert.h&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;IndexFlat.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>faiss {</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"><a class="line" href="structfaiss_1_1ClusteringParameters.html#a86c8802261041f5d49b1a0d296da60be"> 24</a></span>&#160;<a class="code" href="structfaiss_1_1ClusteringParameters.html#a86c8802261041f5d49b1a0d296da60be">ClusteringParameters::ClusteringParameters</a> ():</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; niter(25),</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; nredo(1),</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; verbose(false),</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; spherical(false),</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; int_centroids(false),</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; update_index(false),</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; frozen_centroids(false),</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; min_points_per_centroid(39),</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; max_points_per_centroid(256),</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; seed(1234)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{}</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// 39 corresponds to 10000 / 256 -&gt; to avoid warnings on PQ tests with randu10k</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structfaiss_1_1Clustering.html#a2fa90a2681dc42faaf2435e63a5ae9b4"> 39</a></span>&#160;<a class="code" href="structfaiss_1_1Clustering.html#a2fa90a2681dc42faaf2435e63a5ae9b4">Clustering::Clustering</a> (<span class="keywordtype">int</span> d, <span class="keywordtype">int</span> k):</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; d(d), k(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;<a class="code" href="structfaiss_1_1Clustering.html#a2fa90a2681dc42faaf2435e63a5ae9b4">Clustering::Clustering</a> (<span class="keywordtype">int</span> d, <span class="keywordtype">int</span> k, <span class="keyword">const</span> <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> &amp;cp):</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> (cp), d(d), k(k) {}</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">static</span> <span class="keywordtype">double</span> imbalance_factor (<span class="keywordtype">int</span> n, <span class="keywordtype">int</span> k, <span class="keywordtype">long</span> *assign) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; std::vector&lt;int&gt; hist(k, 0);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; n; i++)</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; hist[assign[i]]++;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">double</span> tot = 0, uf = 0;</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; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0 ; i &lt; k ; i++) {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; tot += hist[i];</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uf += hist[i] * (double) hist[i];</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; uf = uf * k / (tot * tot);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> uf;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structfaiss_1_1Clustering.html#adcb47440a792267bb9218c10378cf1a8"> 63</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1Clustering.html#adcb47440a792267bb9218c10378cf1a8">Clustering::post_process_centroids</a> ()</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">spherical</a>) {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; fvec_renorm_L2 (<a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>, k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</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;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="structfaiss_1_1ClusteringParameters.html#ae01573d8d4cbff7c3d6eaded883537a4">int_centroids</a>) {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.size(); i++)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>[i] = roundf (<a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>[i]);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</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"><a class="line" href="structfaiss_1_1Clustering.html#a839f210abb11c7a1c7162e336e0ff9cf"> 77</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1Clustering.html#a839f210abb11c7a1c7162e336e0ff9cf">Clustering::train</a> (idx_t nx, <span class="keyword">const</span> <span class="keywordtype">float</span> *x_in, <a class="code" href="structfaiss_1_1Index.html">Index</a> &amp; index) {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; FAISS_THROW_IF_NOT_FMT (nx &gt;= k,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="stringliteral">&quot;Number of training points (%ld) should be at least &quot;</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="stringliteral">&quot;as large as number of clusters (%ld)&quot;</span>, nx, k);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">double</span> t0 = <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>();</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">// yes it is the user&#39;s responsibility, but it may spare us some</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// hard-to-debug reports.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; nx * <a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>; i++) {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; FAISS_THROW_IF_NOT_MSG (finite (x_in[i]),</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="stringliteral">&quot;input contains NaN&#39;s or Inf&#39;s&quot;</span>);</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;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> *x = x_in;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="structfaiss_1_1ScopeDeleter.html">ScopeDeleter&lt;float&gt;</a> del1;</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="keywordflow">if</span> (nx &gt; k * <a class="code" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a>) {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">if</span> (verbose)</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; printf(<span class="stringliteral">&quot;Sampling a subset of %ld / %ld for training\n&quot;</span>,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; k * max_points_per_centroid, nx);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; std::vector&lt;int&gt; perm (nx);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; rand_perm (perm.data (), nx, <a class="code" href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">seed</a>);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; nx = k * <a class="code" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a>;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">float</span> * x_new = <span class="keyword">new</span> <span class="keywordtype">float</span> [nx * <a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>];</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">for</span> (idx_t i = 0; i &lt; nx; i++)</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; memcpy (x_new + i * d, x + perm[i] * d, <span class="keyword">sizeof</span>(x_new[0]) * <a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; x = x_new;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; del1.set (x);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (nx &lt; k * <a class="code" href="structfaiss_1_1ClusteringParameters.html#a5af907901147a9b1e748b13305839924">min_points_per_centroid</a>) {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; fprintf (stderr,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="stringliteral">&quot;WARNING clustering %ld points to %ld centroids: &quot;</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="stringliteral">&quot;please provide at least %ld training points\n&quot;</span>,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; nx, k, idx_t(k) * min_points_per_centroid);</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;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">if</span> (nx == k) {</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">if</span> (verbose) {</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; printf(<span class="stringliteral">&quot;Number of training points (%ld) same as number of &quot;</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="stringliteral">&quot;clusters, just copying\n&quot;</span>, nx);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; }</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="comment">// this is a corner case, just copy training set to clusters</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.resize (d * k);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; memcpy (<a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data(), x_in, <span class="keyword">sizeof</span> (*x_in) * d * <a class="code" href="structfaiss_1_1Clustering.html#a87581785d9516c683bbc7c9392bfa993">k</a>);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a>();</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">add</a>(k, x_in);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">return</span>;</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;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">if</span> (verbose)</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; printf(<span class="stringliteral">&quot;Clustering %d points in %ldD to %ld clusters, &quot;</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="stringliteral">&quot;redo %d times, %d iterations\n&quot;</span>,</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">int</span>(nx), d, k, <a class="code" href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">nredo</a>, <a class="code" href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">niter</a>);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; idx_t * assign = <span class="keyword">new</span> idx_t[nx];</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="structfaiss_1_1ScopeDeleter.html">ScopeDeleter&lt;idx_t&gt;</a> del (assign);</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordtype">float</span> * dis = <span class="keyword">new</span> <span class="keywordtype">float</span>[nx];</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <a class="code" href="structfaiss_1_1ScopeDeleter.html">ScopeDeleter&lt;float&gt;</a> del2(dis);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="comment">// for redo</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">float</span> best_err = HUGE_VALF;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; std::vector&lt;float&gt; best_obj;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; std::vector&lt;float&gt; best_centroids;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="comment">// support input centroids</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; FAISS_THROW_IF_NOT_MSG (</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.size() % d == 0,</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="stringliteral">&quot;size of provided input centroids not a multiple of dimension&quot;</span>);</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keywordtype">size_t</span> n_input_centroids = <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.size() / <a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordflow">if</span> (verbose &amp;&amp; n_input_centroids &gt; 0) {</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; printf (<span class="stringliteral">&quot; Using %zd centroids provided as input (%sfrozen)\n&quot;</span>,</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; n_input_centroids, <a class="code" href="structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215">frozen_centroids</a> ? <span class="stringliteral">&quot;&quot;</span> : <span class="stringliteral">&quot;not &quot;</span>);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keywordtype">double</span> t_search_tot = 0;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keywordflow">if</span> (verbose) {</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; printf(<span class="stringliteral">&quot; Preprocessing in %.2f s\n&quot;</span>,</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; (<a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>() - t0) / 1000.);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; }</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; t0 = <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>();</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> redo = 0; redo &lt; <a class="code" href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">nredo</a>; redo++) {</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keywordflow">if</span> (verbose &amp;&amp; nredo &gt; 1) {</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; printf(<span class="stringliteral">&quot;Outer iteration %d / %d\n&quot;</span>, redo, nredo);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; }</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="comment">// initialize remaining centroids with random points from the dataset</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.resize (d * k);</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; std::vector&lt;int&gt; perm (nx);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; rand_perm (perm.data(), nx, <a class="code" href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">seed</a> + 1 + redo * 15486557L);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = n_input_centroids; i &lt; <a class="code" href="structfaiss_1_1Clustering.html#a87581785d9516c683bbc7c9392bfa993">k</a> ; i++)</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; memcpy (&amp;<a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>[i * d], x + perm[i] * d,</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; d * <span class="keyword">sizeof</span> (<span class="keywordtype">float</span>));</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#adcb47440a792267bb9218c10378cf1a8">post_process_centroids</a> ();</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordflow">if</span> (index.<a class="code" href="structfaiss_1_1Index.html#a6970683faa021b7a6f1a0865c0d4eccd">ntotal</a> != 0) {</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a>();</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; }</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <span class="keywordflow">if</span> (!index.<a class="code" href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">is_trained</a>) {</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#abf601502bdbfa02b9d7bcd7b3671b71d">train</a> (k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; }</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">add</a> (k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keywordtype">float</span> err = 0;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; <a class="code" href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">niter</a>; i++) {</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keywordtype">double</span> t0s = <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>();</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a> (nx, x, 1, dis, assign);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <a class="code" href="structfaiss_1_1InterruptCallback.html#a6b7b2569b2d3a88daea65b469a24e378">InterruptCallback::check</a>();</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; t_search_tot += <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>() - t0s;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; err = 0;</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; nx; j++)</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; err += dis[j];</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a>.push_back (err);</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keywordtype">int</span> nsplit = <a class="code" href="namespacefaiss.html#aa2c6a9e87a64bba8e8014e14f70bde21">km_update_centroids</a> (</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; x, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data(),</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; assign, <a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>, <a class="code" href="structfaiss_1_1Clustering.html#a87581785d9516c683bbc7c9392bfa993">k</a>, nx, <a class="code" href="structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215">frozen_centroids</a> ? n_input_centroids : 0);</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="keywordflow">if</span> (verbose) {</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; printf (<span class="stringliteral">&quot; Iteration %d (%.2f s, search %.2f s): &quot;</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="stringliteral">&quot;objective=%g imbalance=%.3f nsplit=%d \r&quot;</span>,</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; i, (<a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>() - t0) / 1000.0,</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; t_search_tot / 1000,</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; err, imbalance_factor (nx, k, assign),</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; nsplit);</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; fflush (stdout);</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; }</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#adcb47440a792267bb9218c10378cf1a8">post_process_centroids</a> ();</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a> ();</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="structfaiss_1_1ClusteringParameters.html#a27d6192097920fa981cff0acedfaac91">update_index</a>)</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#abf601502bdbfa02b9d7bcd7b3671b71d">train</a> (k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; assert (index.<a class="code" href="structfaiss_1_1Index.html#a6970683faa021b7a6f1a0865c0d4eccd">ntotal</a> == 0);</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">add</a> (k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <a class="code" href="structfaiss_1_1InterruptCallback.html#a6b7b2569b2d3a88daea65b469a24e378">InterruptCallback::check</a> ();</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; }</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordflow">if</span> (verbose) printf(<span class="stringliteral">&quot;\n&quot;</span>);</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keywordflow">if</span> (nredo &gt; 1) {</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="keywordflow">if</span> (err &lt; best_err) {</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <span class="keywordflow">if</span> (verbose)</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; printf (<span class="stringliteral">&quot;Objective improved: keep new clusters\n&quot;</span>);</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; best_centroids = <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>;</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; best_obj = <a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a>;</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; best_err = err;</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; }</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a> ();</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; }</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; }</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="keywordflow">if</span> (nredo &gt; 1) {</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a> = best_centroids;</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a> = best_obj;</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a>();</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; index.<a class="code" href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">add</a>(k, best_centroids.data());</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; }</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;}</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;</div>
<div class="line"><a name="l00246"></a><span class="lineno"><a class="line" href="namespacefaiss.html#a38bd0dde8a1b229201a5fcb64d05daa6"> 246</a></span>&#160;<span class="keywordtype">float</span> <a class="code" href="namespacefaiss.html#a38bd0dde8a1b229201a5fcb64d05daa6">kmeans_clustering</a> (<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="l00247"></a><span class="lineno"> 247</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> *x,</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <span class="keywordtype">float</span> *centroids)</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;{</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; <a class="code" href="structfaiss_1_1Clustering.html">Clustering</a> clus (d, k);</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; clus.verbose = d * n * k &gt; (1L &lt;&lt; 30);</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <span class="comment">// display logs if &gt; 1Gflop per iteration</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a> index (d);</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; clus.<a class="code" href="structfaiss_1_1Clustering.html#a839f210abb11c7a1c7162e336e0ff9cf">train</a> (n, x, index);</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; memcpy(centroids, clus.<a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data(), <span class="keyword">sizeof</span>(*centroids) * d * k);</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; <span class="keywordflow">return</span> clus.<a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a>.back();</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;}</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;} <span class="comment">// namespace faiss</span></div>
<div class="ttc" id="namespacefaiss_html_aa2c6a9e87a64bba8e8014e14f70bde21"><div class="ttname"><a href="namespacefaiss.html#aa2c6a9e87a64bba8e8014e14f70bde21">faiss::km_update_centroids</a></div><div class="ttdeci">int km_update_centroids(const float *x, float *centroids, long *assign, size_t d, size_t k, size_t n, size_t k_frozen)</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l01078">utils.cpp:1078</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#l00023">Clustering.h:23</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#l00024">Clustering.h:24</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html_a86c8802261041f5d49b1a0d296da60be"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#a86c8802261041f5d49b1a0d296da60be">faiss::ClusteringParameters::ClusteringParameters</a></div><div class="ttdeci">ClusteringParameters()</div><div class="ttdoc">sets reasonable defaults </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8cpp_source.html#l00024">Clustering.cpp:24</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a849361f5f0ab0aba8d419c86f2594191"><div class="ttname"><a href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">faiss::Index::reset</a></div><div class="ttdeci">virtual void reset()=0</div><div class="ttdoc">removes all elements from the database. </div></div>
<div class="ttc" id="structfaiss_1_1IndexFlatL2_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00077">IndexFlat.h:77</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_a2fa90a2681dc42faaf2435e63a5ae9b4"><div class="ttname"><a href="structfaiss_1_1Clustering.html#a2fa90a2681dc42faaf2435e63a5ae9b4">faiss::Clustering::Clustering</a></div><div class="ttdeci">Clustering(int d, int k)</div><div class="ttdoc">the only mandatory parameters are k and d </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8cpp_source.html#l00039">Clustering.cpp:39</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_abf601502bdbfa02b9d7bcd7b3671b71d"><div class="ttname"><a href="structfaiss_1_1Index.html#abf601502bdbfa02b9d7bcd7b3671b71d">faiss::Index::train</a></div><div class="ttdeci">virtual void train(idx_t n, const float *x)</div><div class="ttdef"><b>Definition:</b> <a href="Index_8cpp_source.html#l00023">Index.cpp:23</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_a87581785d9516c683bbc7c9392bfa993"><div class="ttname"><a href="structfaiss_1_1Clustering.html#a87581785d9516c683bbc7c9392bfa993">faiss::Clustering::k</a></div><div class="ttdeci">size_t k</div><div class="ttdoc">nb of centroids </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00059">Clustering.h:59</a></div></div>
<div class="ttc" id="structfaiss_1_1ScopeDeleter_html"><div class="ttname"><a href="structfaiss_1_1ScopeDeleter.html">faiss::ScopeDeleter</a></div><div class="ttdef"><b>Definition:</b> <a href="FaissException_8h_source.html#l00045">FaissException.h:45</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="structfaiss_1_1InterruptCallback_html_a6b7b2569b2d3a88daea65b469a24e378"><div class="ttname"><a href="structfaiss_1_1InterruptCallback.html#a6b7b2569b2d3a88daea65b469a24e378">faiss::InterruptCallback::check</a></div><div class="ttdeci">static void check()</div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8cpp_source.html#l00307">AuxIndexStructures.cpp:307</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="structfaiss_1_1Index_html_a1b5e9ac70adbce0897dd6c8276ad96f2"><div class="ttname"><a href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">faiss::Index::add</a></div><div class="ttdeci">virtual void add(idx_t n, const float *x)=0</div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_adcb47440a792267bb9218c10378cf1a8"><div class="ttname"><a href="structfaiss_1_1Clustering.html#adcb47440a792267bb9218c10378cf1a8">faiss::Clustering::post_process_centroids</a></div><div class="ttdeci">void post_process_centroids()</div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8cpp_source.html#l00063">Clustering.cpp:63</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_a91e32da946477bb751706a68c5cd3327"><div class="ttname"><a href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">faiss::Clustering::obj</a></div><div class="ttdeci">std::vector&lt; float &gt; obj</div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00066">Clustering.h:66</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#l00246">Clustering.cpp:246</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a6970683faa021b7a6f1a0865c0d4eccd"><div class="ttname"><a href="structfaiss_1_1Index.html#a6970683faa021b7a6f1a0865c0d4eccd">faiss::Index::ntotal</a></div><div class="ttdeci">idx_t ntotal</div><div class="ttdoc">total nb of indexed vectors </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00067">Index.h:67</a></div></div>
<div class="ttc" id="namespacefaiss_html_af2a71f7d5402ae02ce169a4cc83020eb"><div class="ttname"><a href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">faiss::getmillisecs</a></div><div class="ttdeci">double getmillisecs()</div><div class="ttdoc">ms elapsed since some arbitrary epoch </div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00069">utils.cpp:69</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_a64c5ec0b4a7967d8be2872974b455ff1"><div class="ttname"><a href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">faiss::Clustering::centroids</a></div><div class="ttdeci">std::vector&lt; float &gt; centroids</div><div class="ttdoc">centroids (k * d) </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00062">Clustering.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_afbf6efacae54c58586b75ed790facd74"><div class="ttname"><a href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">faiss::Clustering::d</a></div><div class="ttdeci">size_t d</div><div class="ttdoc">dimension of the vectors </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00058">Clustering.h:58</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_aced51b1ebc33c47ab3ae15ea906559a7"><div class="ttname"><a href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">faiss::Index::search</a></div><div class="ttdeci">virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const =0</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_ae01573d8d4cbff7c3d6eaded883537a4"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html#ae01573d8d4cbff7c3d6eaded883537a4">faiss::ClusteringParameters::int_centroids</a></div><div class="ttdeci">bool int_centroids</div><div class="ttdoc">round centroids coordinates to integer </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00028">Clustering.h:28</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#l00022">Clustering.h:22</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#l00061">Index.h:61</a></div></div>
<div class="ttc" id="structfaiss_1_1Clustering_html_a839f210abb11c7a1c7162e336e0ff9cf"><div class="ttname"><a href="structfaiss_1_1Clustering.html#a839f210abb11c7a1c7162e336e0ff9cf">faiss::Clustering::train</a></div><div class="ttdeci">virtual void train(idx_t n, const float *x, faiss::Index &amp;index)</div><div class="ttdoc">Index is used during the assignment stage. </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8cpp_source.html#l00077">Clustering.cpp:77</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a6e92732617c4dbe364e7678dd8773a7f"><div class="ttname"><a href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">faiss::Index::is_trained</a></div><div class="ttdeci">bool is_trained</div><div class="ttdoc">set if the Index does not require training, or if training is done already </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00071">Index.h:71</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#l00027">Clustering.h:27</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><!-- 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>