227 lines
29 KiB
HTML
227 lines
29 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>Faiss: /tmp/faiss/c_api/Clustering_c.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Faiss
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_5fcc7c5aeda0d349161ae950b251beed.html">c_api</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Clustering_c.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// -*- c -*-</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef FAISS_CLUSTERING_C_H</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_CLUSTERING_C_H</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "Index_c.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "faiss_c.h"</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/** Class for the clustering parameters. Can be passed to the</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * constructor of the Clustering object.</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html"> 25</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a56185e0e0b9f0c37d35ef64e42aea1a3"> 26</a></span>  <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a56185e0e0b9f0c37d35ef64e42aea1a3">niter</a>; <span class="comment">///< clustering iterations</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a7cf97c4d30080402e2b3dd5577f46225"> 27</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a7cf97c4d30080402e2b3dd5577f46225">nredo</a>; <span class="comment">///< redo clustering this many times and keep best</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a25ee71d2a611b737caaf8d43e04196f6"> 29</a></span>  <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a25ee71d2a611b737caaf8d43e04196f6">verbose</a>; <span class="comment">///< (bool)</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a969ad16df5fb6730c94280e187fb6de5"> 30</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a969ad16df5fb6730c94280e187fb6de5">spherical</a>; <span class="comment">///< (bool) do we want normalized centroids?</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a1764fa98f759b20fde75abbb2616f844"> 31</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a1764fa98f759b20fde75abbb2616f844">update_index</a>; <span class="comment">///< (bool) update index after each iteration?</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a1caad79e8c8fde45bbc63c7c6da303f1"> 32</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a1caad79e8c8fde45bbc63c7c6da303f1">frozen_centroids</a>; <span class="comment">///< (bool) use the centroids provided as input and do not change them during iterations</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a078058f0c09e2fd560dd497115e30ab7"> 34</a></span>  <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a078058f0c09e2fd560dd497115e30ab7">min_points_per_centroid</a>; <span class="comment">///< otherwise you get a warning</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#ac8c19c0252c7408d3d77c97fd9d9ad15"> 35</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#ac8c19c0252c7408d3d77c97fd9d9ad15">max_points_per_centroid</a>; <span class="comment">///< to limit size of dataset</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structFaissClusteringParameters.html#a4ce5970d8ccb1c014a2d9ace87d66da6"> 37</a></span>  <span class="keywordtype">int</span> <a class="code" href="structFaissClusteringParameters.html#a4ce5970d8ccb1c014a2d9ace87d66da6">seed</a>; <span class="comment">///< seed for the random number generator</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span>} <a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/// Sets the ClusteringParameters object with reasonable defaults</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span><span class="keywordtype">void</span> faiss_ClusteringParameters_init(<a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a>* params);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/** clustering based on assignment - centroid update iterations</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * The clustering is based on an Index object that assigns training</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * points to the centroids. Therefore, at each iteration the centroids</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * are added to the index.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * On output, the centoids table is set to the latest version</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * of the centroids and they are also added to the index. If the</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * centroids table it is not empty on input, it is also used for</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * initialization.</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * To do several clusterings, just call train() several times on</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * different training sets, clearing the centroid table in between.</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> FAISS_DECLARE_CLASS(Clustering)</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> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, niter)</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, nredo)</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, verbose)</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, spherical)</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, update_index)</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, frozen_centroids)</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, min_points_per_centroid)</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, max_points_per_centroid)</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> FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">int</span>, seed)</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/// getter for d</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span>FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">size_t</span>, d)</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/// getter for k</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span>FAISS_DECLARE_GETTER(Clustering, <span class="keywordtype">size_t</span>, k)</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/// getter for centroids (size = k * d)</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span><span class="keywordtype">void</span> faiss_Clustering_centroids(</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  FaissClustering* clustering, <span class="keywordtype">float</span>** centroids, <span class="keywordtype">size_t</span>* size);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/// getter for objective values (sum of distances reported by index)</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/// over iterations</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span><span class="keywordtype">void</span> faiss_Clustering_obj(</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  FaissClustering* clustering, <span class="keywordtype">float</span>** obj, <span class="keywordtype">size_t</span>* size);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">/// the only mandatory parameters are k and d</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span><span class="keywordtype">int</span> faiss_Clustering_new(FaissClustering** p_clustering, <span class="keywordtype">int</span> d, <span class="keywordtype">int</span> k);</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> faiss_Clustering_new_with_params(</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  FaissClustering** p_clustering, <span class="keywordtype">int</span> d, <span class="keywordtype">int</span> k, const <a class="code" href="structFaissClusteringParameters.html">FaissClusteringParameters</a>* cp);</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">int</span> faiss_Clustering_train(</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  FaissClustering* clustering, idx_t n, const <span class="keywordtype">float</span>* x, FaissIndex* index);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">void</span> faiss_Clustering_free(FaissClustering* clustering);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">/** simplified interface</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @param d dimension of the data</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param n nb of training vectors</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param k nb of output centroids</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param x training set (size n * d)</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param centroids output centroids (size k * d)</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param q_error final quantization error</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @return error code</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">int</span> faiss_kmeans_clustering (<span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> n, <span class="keywordtype">size_t</span> k,</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  const <span class="keywordtype">float</span> *x,</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">float</span> *centroids,</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">float</span> *q_error);</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="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"></span>}</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a7cf97c4d30080402e2b3dd5577f46225"><div class="ttname"><a href="structFaissClusteringParameters.html#a7cf97c4d30080402e2b3dd5577f46225">FaissClusteringParameters::nredo</a></div><div class="ttdeci">int nredo</div><div class="ttdoc">redo clustering this many times and keep best </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00027">Clustering_c.h:27</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a969ad16df5fb6730c94280e187fb6de5"><div class="ttname"><a href="structFaissClusteringParameters.html#a969ad16df5fb6730c94280e187fb6de5">FaissClusteringParameters::spherical</a></div><div class="ttdeci">int spherical</div><div class="ttdoc">(bool) do we want normalized centroids? </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00030">Clustering_c.h:30</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html"><div class="ttname"><a href="structFaissClusteringParameters.html">FaissClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00025">Clustering_c.h:25</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a1caad79e8c8fde45bbc63c7c6da303f1"><div class="ttname"><a href="structFaissClusteringParameters.html#a1caad79e8c8fde45bbc63c7c6da303f1">FaissClusteringParameters::frozen_centroids</a></div><div class="ttdeci">int frozen_centroids</div><div class="ttdoc">(bool) use the centroids provided as input and do not change them during iterations ...</div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00032">Clustering_c.h:32</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_ac8c19c0252c7408d3d77c97fd9d9ad15"><div class="ttname"><a href="structFaissClusteringParameters.html#ac8c19c0252c7408d3d77c97fd9d9ad15">FaissClusteringParameters::max_points_per_centroid</a></div><div class="ttdeci">int max_points_per_centroid</div><div class="ttdoc">to limit size of dataset </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00035">Clustering_c.h:35</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a4ce5970d8ccb1c014a2d9ace87d66da6"><div class="ttname"><a href="structFaissClusteringParameters.html#a4ce5970d8ccb1c014a2d9ace87d66da6">FaissClusteringParameters::seed</a></div><div class="ttdeci">int seed</div><div class="ttdoc">seed for the random number generator </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00037">Clustering_c.h:37</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a56185e0e0b9f0c37d35ef64e42aea1a3"><div class="ttname"><a href="structFaissClusteringParameters.html#a56185e0e0b9f0c37d35ef64e42aea1a3">FaissClusteringParameters::niter</a></div><div class="ttdeci">int niter</div><div class="ttdoc">clustering iterations </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00026">Clustering_c.h:26</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a1764fa98f759b20fde75abbb2616f844"><div class="ttname"><a href="structFaissClusteringParameters.html#a1764fa98f759b20fde75abbb2616f844">FaissClusteringParameters::update_index</a></div><div class="ttdeci">int update_index</div><div class="ttdoc">(bool) update index after each iteration? </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00031">Clustering_c.h:31</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a078058f0c09e2fd560dd497115e30ab7"><div class="ttname"><a href="structFaissClusteringParameters.html#a078058f0c09e2fd560dd497115e30ab7">FaissClusteringParameters::min_points_per_centroid</a></div><div class="ttdeci">int min_points_per_centroid</div><div class="ttdoc">otherwise you get a warning </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00034">Clustering_c.h:34</a></div></div>
|
|
<div class="ttc" id="structFaissClusteringParameters_html_a25ee71d2a611b737caaf8d43e04196f6"><div class="ttname"><a href="structFaissClusteringParameters.html#a25ee71d2a611b737caaf8d43e04196f6">FaissClusteringParameters::verbose</a></div><div class="ttdeci">int verbose</div><div class="ttdoc">(bool) </div><div class="ttdef"><b>Definition:</b> <a href="Clustering__c_8h_source.html#l00029">Clustering_c.h:29</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|