2017-02-23 06:26:44 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.5" / >
< title > Faiss: 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 >
2019-05-28 22:17:22 +08:00
< tr class = "memitem:ae01573d8d4cbff7c3d6eaded883537a4" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ae01573d8d4cbff7c3d6eaded883537a4" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ClusteringParameters.html#ae01573d8d4cbff7c3d6eaded883537a4" > int_centroids< / a > < / td > < / tr >
< tr class = "memdesc:ae01573d8d4cbff7c3d6eaded883537a4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > round centroids coordinates to integer < br / > < / td > < / tr >
< tr class = "separator:ae01573d8d4cbff7c3d6eaded883537a4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-02-23 06:26:44 +08:00
< 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 >
2017-11-22 21:00:42 +08:00
< tr class = "memitem:ad142063e035f2a0414233f9711e16215" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ad142063e035f2a0414233f9711e16215" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ClusteringParameters.html#ad142063e035f2a0414233f9711e16215" > frozen_centroids< / a > < / td > < / tr >
< tr class = "memdesc:ad142063e035f2a0414233f9711e16215" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > use the centroids provided as input and do not change them during iterations < br / > < / td > < / tr >
< tr class = "separator:ad142063e035f2a0414233f9711e16215" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-02-23 06:26:44 +08:00
< 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 >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "Clustering_8h_source.html#l00022" > 22< / a > of file < a class = "el" href = "Clustering_8h_source.html" > Clustering.h< / a > .< / p >
2017-02-23 06:26:44 +08:00
< / div > < hr / > The documentation for this struct was generated from the following files:< ul >
2019-05-28 22:17:22 +08:00
< li > /data/users/hoss/faiss/< a class = "el" href = "Clustering_8h_source.html" > Clustering.h< / a > < / li >
< li > /data/users/hoss/faiss/< a class = "el" href = "Clustering_8cpp_source.html" > Clustering.cpp< / a > < / li >
2017-02-23 06:26:44 +08:00
< / 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 >
