1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<!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: faiss::ClusteringParameters Struct Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</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="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structfaiss_1_1ClusteringParameters-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::ClusteringParameters Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="Clustering_8h_source.html">Clustering.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for faiss::ClusteringParameters:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1ClusteringParameters.png" usemap="#faiss::ClusteringParameters_map" alt=""/>
<map id="faiss::ClusteringParameters_map" name="faiss::ClusteringParameters_map">
<area href="structfaiss_1_1Clustering.html" alt="faiss::Clustering" shape="rect" coords="0,56,165,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a86c8802261041f5d49b1a0d296da60be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86c8802261041f5d49b1a0d296da60be"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a86c8802261041f5d49b1a0d296da60be">ClusteringParameters</a> ()</td></tr>
<tr class="memdesc:a86c8802261041f5d49b1a0d296da60be"><td class="mdescLeft"> </td><td class="mdescRight">sets reasonable defaults <br/></td></tr>
<tr class="separator:a86c8802261041f5d49b1a0d296da60be"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a5c7c6f05c75e1668befdb3be148fd5f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c7c6f05c75e1668befdb3be148fd5f9"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a5c7c6f05c75e1668befdb3be148fd5f9">niter</a></td></tr>
<tr class="memdesc:a5c7c6f05c75e1668befdb3be148fd5f9"><td class="mdescLeft"> </td><td class="mdescRight">clustering iterations <br/></td></tr>
<tr class="separator:a5c7c6f05c75e1668befdb3be148fd5f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11a049c40c376c57ac6cc3b8d5d1d58b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11a049c40c376c57ac6cc3b8d5d1d58b"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a11a049c40c376c57ac6cc3b8d5d1d58b">nredo</a></td></tr>
<tr class="memdesc:a11a049c40c376c57ac6cc3b8d5d1d58b"><td class="mdescLeft"> </td><td class="mdescRight">redo clustering this many times and keep best <br/></td></tr>
<tr class="separator:a11a049c40c376c57ac6cc3b8d5d1d58b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a932139ba9b62b37d9121b4c6a4518b52"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a932139ba9b62b37d9121b4c6a4518b52"></a>
bool </td><td class="memItemRight" valign="bottom"><b>verbose</b></td></tr>
<tr class="separator:a932139ba9b62b37d9121b4c6a4518b52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad997fb511f574f7ddc69938c21612f8d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad997fb511f574f7ddc69938c21612f8d"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#ad997fb511f574f7ddc69938c21612f8d">spherical</a></td></tr>
<tr class="memdesc:ad997fb511f574f7ddc69938c21612f8d"><td class="mdescLeft"> </td><td class="mdescRight">do we want normalized centroids? <br/></td></tr>
<tr class="separator:ad997fb511f574f7ddc69938c21612f8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27d6192097920fa981cff0acedfaac91"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27d6192097920fa981cff0acedfaac91"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a27d6192097920fa981cff0acedfaac91">update_index</a></td></tr>
<tr class="memdesc:a27d6192097920fa981cff0acedfaac91"><td class="mdescLeft"> </td><td class="mdescRight">update index after each iteration? <br/></td></tr>
<tr class="separator:a27d6192097920fa981cff0acedfaac91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5af907901147a9b1e748b13305839924"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5af907901147a9b1e748b13305839924"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a5af907901147a9b1e748b13305839924">min_points_per_centroid</a></td></tr>
<tr class="memdesc:a5af907901147a9b1e748b13305839924"><td class="mdescLeft"> </td><td class="mdescRight">otherwise you get a warning <br/></td></tr>
<tr class="separator:a5af907901147a9b1e748b13305839924"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a993e0a035248faad6e292a5ef9af1953"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a993e0a035248faad6e292a5ef9af1953"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a993e0a035248faad6e292a5ef9af1953">max_points_per_centroid</a></td></tr>
<tr class="memdesc:a993e0a035248faad6e292a5ef9af1953"><td class="mdescLeft"> </td><td class="mdescRight">to limit size of dataset <br/></td></tr>
<tr class="separator:a993e0a035248faad6e292a5ef9af1953"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a509c65e2ebe6ecabebd163ecb03c5579"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a509c65e2ebe6ecabebd163ecb03c5579"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ClusteringParameters.html#a509c65e2ebe6ecabebd163ecb03c5579">seed</a></td></tr>
<tr class="memdesc:a509c65e2ebe6ecabebd163ecb03c5579"><td class="mdescLeft"> </td><td class="mdescRight">seed for the random number generator <br/></td></tr>
<tr class="separator:a509c65e2ebe6ecabebd163ecb03c5579"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for the clustering parameters. Can be passed to the constructor of the <a class="el" href="structfaiss_1_1Clustering.html">Clustering</a> object. </p>
<p>Definition at line <a class="el" href="Clustering_8h_source.html#l00024">24</a> of file <a class="el" href="Clustering_8h_source.html">Clustering.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="Clustering_8h_source.html">Clustering.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="Clustering_8cpp_source.html">Clustering.cpp</a></li>
</ul>
</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>