mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
0df3f646fc
various bugfixes from github issues kmean with some frozen centroids GPU better tiling for large flat datasets default AVX for vector ops
354 lines
52 KiB
HTML
354 lines
52 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/matthijs/github_faiss/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 Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">/data/users/matthijs/github_faiss/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> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* Copyright 2004-present Facebook. All Rights Reserved.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> kmeans clustering routines</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "Clustering.h"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <cmath></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <cstdio></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <cstring></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "utils.h"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "FaissAssert.h"</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "IndexFlat.h"</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structfaiss_1_1ClusteringParameters.html#a86c8802261041f5d49b1a0d296da60be"> 27</a></span> <a class="code" href="structfaiss_1_1ClusteringParameters.html#a86c8802261041f5d49b1a0d296da60be">ClusteringParameters::ClusteringParameters</a> ():</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  niter(25),</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  nredo(1),</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  verbose(false), spherical(false),</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  update_index(false),</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  frozen_centroids(false),</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  min_points_per_centroid(39),</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  max_points_per_centroid(256),</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  seed(1234)</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {}</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// 39 corresponds to 10000 / 256 -> to avoid warnings on PQ tests with randu10k</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structfaiss_1_1Clustering.html#a2fa90a2681dc42faaf2435e63a5ae9b4"> 40</a></span> <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="l00041"></a><span class="lineno"> 41</span>  d(d), k(k) {}</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <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> &cp):</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> (cp), d(d), k(k) {}</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <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="l00049"></a><span class="lineno"> 49</span>  std::vector<int> hist(k, 0);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < n; i++)</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  hist[assign[i]]++;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">double</span> tot = 0, uf = 0;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0 ; i < k ; i++) {</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  tot += hist[i];</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  uf += hist[i] * (double) hist[i];</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  uf = uf * k / (tot * tot);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> uf;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structfaiss_1_1Clustering.html#a839f210abb11c7a1c7162e336e0ff9cf"> 67</a></span> <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> & index) {</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  FAISS_THROW_IF_NOT_MSG (nx >= k,</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="stringliteral">"need at least as many training points as clusters"</span>);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">double</span> t0 = <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>();</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// yes it is the user's responsibility, but it may spare us some</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// hard-to-debug reports.</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < nx * <a class="code" href="structfaiss_1_1Clustering.html#afbf6efacae54c58586b75ed790facd74">d</a>; i++) {</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  FAISS_THROW_IF_NOT_MSG (finite (x_in[i]),</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="stringliteral">"input contains NaN's or Inf's"</span>);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> *x = x_in;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="structfaiss_1_1ScopeDeleter.html">ScopeDeleter<float></a> del1;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span> (nx > k * <a class="code" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a>) {</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">if</span> (verbose)</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  printf(<span class="stringliteral">"Sampling a subset of %ld / %ld for training\n"</span>,</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  k * max_points_per_centroid, nx);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::vector<int> perm (nx);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  rand_perm (perm.data (), nx, <a class="code" href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">seed</a>);</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  nx = k * <a class="code" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a>;</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <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="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">for</span> (idx_t i = 0; i < nx; i++)</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  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="l00093"></a><span class="lineno"> 93</span>  x = x_new;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  del1.set (x);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (nx < k * <a class="code" href="structfaiss_1_1ClusteringParameters.html#a5af907901147a9b1e748b13305839924">min_points_per_centroid</a>) {</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  fprintf (stderr,</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="stringliteral">"WARNING clustering %ld points to %ld centroids: "</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="stringliteral">"please provide at least %ld training points\n"</span>,</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  nx, k, idx_t(k) * min_points_per_centroid);</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">if</span> (verbose)</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  printf(<span class="stringliteral">"Clustering %d points in %ldD to %ld clusters, "</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="stringliteral">"redo %d times, %d iterations\n"</span>,</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <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="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  idx_t * assign = <span class="keyword">new</span> idx_t[nx];</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="structfaiss_1_1ScopeDeleter.html">ScopeDeleter<idx_t></a> del (assign);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">float</span> * dis = <span class="keyword">new</span> <span class="keywordtype">float</span>[nx];</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="structfaiss_1_1ScopeDeleter.html">ScopeDeleter<float></a> del2(dis);</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">// for redo</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">float</span> best_err = 1e50;</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  std::vector<float> best_obj;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  std::vector<float> best_centroids;</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="comment">// support input centroids</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  FAISS_THROW_IF_NOT_MSG (</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.size() % d == 0,</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="stringliteral">"size of provided input centroids not a multiple of dimension"</span>);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <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="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">if</span> (verbose && n_input_centroids > 0) {</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  printf (<span class="stringliteral">" Using %zd centroids provided as input (%sfrozen)\n"</span>,</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  n_input_centroids, <a class="code" href="structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215">frozen_centroids</a> ? <span class="stringliteral">""</span> : <span class="stringliteral">"not "</span>);</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">double</span> t_search_tot = 0;</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">if</span> (verbose) {</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  printf(<span class="stringliteral">" Preprocessing in %.2f s\n"</span>,</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  (<a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>() - t0)/1000.);</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  t0 = <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>();</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> redo = 0; redo < <a class="code" href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">nredo</a>; redo++) {</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">if</span> (verbose && nredo > 1) {</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  printf(<span class="stringliteral">"Outer iteration %d / %d\n"</span>, redo, nredo);</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  }</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="comment">// initialize remaining centroids with random points from the dataset</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.resize (d * k);</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  std::vector<int> perm (nx);</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  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="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = n_input_centroids; i < <a class="code" href="structfaiss_1_1Clustering.html#a87581785d9516c683bbc7c9392bfa993">k</a> ; i++)</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  memcpy (&<a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>[i * d], x + perm[i] * d,</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  d * <span class="keyword">sizeof</span> (<span class="keywordtype">float</span>));</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">if</span> (<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">spherical</a>)</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  fvec_renorm_L2 (d, k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordflow">if</span> (!index.<a class="code" href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">is_trained</a>)</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  index.<a class="code" href="structfaiss_1_1Index.html#a1ffe916c958605c38b0b1bfad42485e4">train</a> (k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  FAISS_THROW_IF_NOT (index.<a class="code" href="structfaiss_1_1Index.html#a6970683faa021b7a6f1a0865c0d4eccd">ntotal</a> == 0);</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  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="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">float</span> err = 0;</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">niter</a>; i++) {</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">double</span> t0s = <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>();</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  index.<a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a> (nx, x, 1, dis, assign);</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  t_search_tot += <a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>() - t0s;</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  err = 0;</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j < nx; j++)</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  err += dis[j];</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a>.push_back (err);</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">int</span> nsplit = <a class="code" href="namespacefaiss.html#aa2c6a9e87a64bba8e8014e14f70bde21">km_update_centroids</a> (</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  x, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data(),</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  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="l00177"></a><span class="lineno"> 177</span> </div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordflow">if</span> (verbose) {</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  printf (<span class="stringliteral">" Iteration %d (%.2f s, search %.2f s): "</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="stringliteral">"objective=%g imbalance=%.3f nsplit=%d \r"</span>,</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  i, (<a class="code" href="namespacefaiss.html#af2a71f7d5402ae02ce169a4cc83020eb">getmillisecs</a>() - t0) / 1000.0,</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  t_search_tot / 1000,</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  err, imbalance_factor (nx, k, assign),</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  nsplit);</div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  fflush (stdout);</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  }</div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordflow">if</span> (<a class="code" href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">spherical</a>)</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  fvec_renorm_L2 (d, k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a> ();</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordflow">if</span> (<a class="code" href="structfaiss_1_1ClusteringParameters.html#a27d6192097920fa981cff0acedfaac91">update_index</a>)</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  index.<a class="code" href="structfaiss_1_1Index.html#a1ffe916c958605c38b0b1bfad42485e4">train</a> (k, <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>.data());</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  assert (index.<a class="code" href="structfaiss_1_1Index.html#a6970683faa021b7a6f1a0865c0d4eccd">ntotal</a> == 0);</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  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="l00197"></a><span class="lineno"> 197</span>  }</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordflow">if</span> (verbose) printf(<span class="stringliteral">"\n"</span>);</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordflow">if</span> (nredo > 1) {</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordflow">if</span> (err < best_err) {</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keywordflow">if</span> (verbose)</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  printf (<span class="stringliteral">"Objective improved: keep new clusters\n"</span>);</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  best_centroids = <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a>;</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  best_obj = <a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a>;</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  best_err = err;</div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  }</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  index.<a class="code" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">reset</a> ();</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  }</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  }</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keywordflow">if</span> (nredo > 1) {</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <a class="code" href="structfaiss_1_1Clustering.html#a64c5ec0b4a7967d8be2872974b455ff1">centroids</a> = best_centroids;</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a> = best_obj;</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  }</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> }</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"><a class="line" href="namespacefaiss.html#a38bd0dde8a1b229201a5fcb64d05daa6"> 217</a></span> <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="l00218"></a><span class="lineno"> 218</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> *x,</div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordtype">float</span> *centroids)</div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> {</div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <a class="code" href="structfaiss_1_1Clustering.html">Clustering</a> clus (d, k);</div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  clus.verbose = d * n * k > (1L << 30);</div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="comment">// display logs if > 1Gflop per iteration</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <a class="code" href="structfaiss_1_1IndexFlatL2.html">IndexFlatL2</a> index (d);</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  clus.<a class="code" href="structfaiss_1_1Clustering.html#a839f210abb11c7a1c7162e336e0ff9cf">train</a> (n, x, index);</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  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="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">return</span> clus.<a class="code" href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">obj</a>.back();</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> }</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> } <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#l01399">utils.cpp:1399</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#l00025">Clustering.h:25</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#l00026">Clustering.h:26</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#l00027">Clustering.cpp:27</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_1Index_html_a1ffe916c958605c38b0b1bfad42485e4"><div class="ttname"><a href="structfaiss_1_1Index.html#a1ffe916c958605c38b0b1bfad42485e4">faiss::Index::train</a></div><div class="ttdeci">virtual void train(idx_t, const float *)</div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00089">Index.h:89</a></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#l00079">IndexFlat.h:79</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#l00040">Clustering.cpp:40</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#l00060">Clustering.h:60</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#l00039">FaissException.h:39</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#l00036">Clustering.h:36</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#l00031">Clustering.h:31</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#l00033">Clustering.h:33</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#l00057">Clustering.h:57</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_a91e32da946477bb751706a68c5cd3327"><div class="ttname"><a href="structfaiss_1_1Clustering.html#a91e32da946477bb751706a68c5cd3327">faiss::Clustering::obj</a></div><div class="ttdeci">std::vector< float > obj</div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00067">Clustering.h:67</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#l00217">Clustering.cpp:217</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#l00065">Index.h:65</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#l00074">utils.cpp:74</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< float > centroids</div><div class="ttdoc">centroids (k * d) </div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00063">Clustering.h:63</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#l00059">Clustering.h:59</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#l00030">Clustering.h:30</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#l00024">Clustering.h:24</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#l00060">Index.h:60</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 &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#l00067">Clustering.cpp:67</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#l00069">Index.h:69</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#l00029">Clustering.h:29</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#l00034">Clustering.h:34</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|