mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
151 lines
12 KiB
HTML
151 lines
12 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: FaissClusteringParameters 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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structFaissClusteringParameters-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FaissClusteringParameters Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="Clustering__c_8h_source.html">Clustering_c.h</a>></code></p>
|
|
<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:a56185e0e0b9f0c37d35ef64e42aea1a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56185e0e0b9f0c37d35ef64e42aea1a3"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a56185e0e0b9f0c37d35ef64e42aea1a3">niter</a></td></tr>
|
|
<tr class="memdesc:a56185e0e0b9f0c37d35ef64e42aea1a3"><td class="mdescLeft"> </td><td class="mdescRight">clustering iterations <br/></td></tr>
|
|
<tr class="separator:a56185e0e0b9f0c37d35ef64e42aea1a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cf97c4d30080402e2b3dd5577f46225"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cf97c4d30080402e2b3dd5577f46225"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a7cf97c4d30080402e2b3dd5577f46225">nredo</a></td></tr>
|
|
<tr class="memdesc:a7cf97c4d30080402e2b3dd5577f46225"><td class="mdescLeft"> </td><td class="mdescRight">redo clustering this many times and keep best <br/></td></tr>
|
|
<tr class="separator:a7cf97c4d30080402e2b3dd5577f46225"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25ee71d2a611b737caaf8d43e04196f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25ee71d2a611b737caaf8d43e04196f6"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a25ee71d2a611b737caaf8d43e04196f6">verbose</a></td></tr>
|
|
<tr class="memdesc:a25ee71d2a611b737caaf8d43e04196f6"><td class="mdescLeft"> </td><td class="mdescRight">(bool) <br/></td></tr>
|
|
<tr class="separator:a25ee71d2a611b737caaf8d43e04196f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a969ad16df5fb6730c94280e187fb6de5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a969ad16df5fb6730c94280e187fb6de5"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a969ad16df5fb6730c94280e187fb6de5">spherical</a></td></tr>
|
|
<tr class="memdesc:a969ad16df5fb6730c94280e187fb6de5"><td class="mdescLeft"> </td><td class="mdescRight">(bool) do we want normalized centroids? <br/></td></tr>
|
|
<tr class="separator:a969ad16df5fb6730c94280e187fb6de5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1764fa98f759b20fde75abbb2616f844"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1764fa98f759b20fde75abbb2616f844"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a1764fa98f759b20fde75abbb2616f844">update_index</a></td></tr>
|
|
<tr class="memdesc:a1764fa98f759b20fde75abbb2616f844"><td class="mdescLeft"> </td><td class="mdescRight">(bool) update index after each iteration? <br/></td></tr>
|
|
<tr class="separator:a1764fa98f759b20fde75abbb2616f844"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1caad79e8c8fde45bbc63c7c6da303f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1caad79e8c8fde45bbc63c7c6da303f1"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a1caad79e8c8fde45bbc63c7c6da303f1">frozen_centroids</a></td></tr>
|
|
<tr class="memdesc:a1caad79e8c8fde45bbc63c7c6da303f1"><td class="mdescLeft"> </td><td class="mdescRight">(bool) use the centroids provided as input and do not change them during iterations <br/></td></tr>
|
|
<tr class="separator:a1caad79e8c8fde45bbc63c7c6da303f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a078058f0c09e2fd560dd497115e30ab7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a078058f0c09e2fd560dd497115e30ab7"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a078058f0c09e2fd560dd497115e30ab7">min_points_per_centroid</a></td></tr>
|
|
<tr class="memdesc:a078058f0c09e2fd560dd497115e30ab7"><td class="mdescLeft"> </td><td class="mdescRight">otherwise you get a warning <br/></td></tr>
|
|
<tr class="separator:a078058f0c09e2fd560dd497115e30ab7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8c19c0252c7408d3d77c97fd9d9ad15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8c19c0252c7408d3d77c97fd9d9ad15"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#ac8c19c0252c7408d3d77c97fd9d9ad15">max_points_per_centroid</a></td></tr>
|
|
<tr class="memdesc:ac8c19c0252c7408d3d77c97fd9d9ad15"><td class="mdescLeft"> </td><td class="mdescRight">to limit size of dataset <br/></td></tr>
|
|
<tr class="separator:ac8c19c0252c7408d3d77c97fd9d9ad15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ce5970d8ccb1c014a2d9ace87d66da6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ce5970d8ccb1c014a2d9ace87d66da6"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structFaissClusteringParameters.html#a4ce5970d8ccb1c014a2d9ace87d66da6">seed</a></td></tr>
|
|
<tr class="memdesc:a4ce5970d8ccb1c014a2d9ace87d66da6"><td class="mdescLeft"> </td><td class="mdescRight">seed for the random number generator <br/></td></tr>
|
|
<tr class="separator:a4ce5970d8ccb1c014a2d9ace87d66da6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Copyright (c) 2015-present, Facebook, Inc. All rights reserved.</p>
|
|
<p>This source code is licensed under the BSD+Patents license found in the LICENSE file in the root directory of this source tree. Class for the clustering parameters. Can be passed to the constructor of the Clustering object. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Clustering__c_8h_source.html#l00025">25</a> of file <a class="el" href="Clustering__c_8h_source.html">Clustering_c.h</a>.</p>
|
|
</div><hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>/tmp/faiss/c_api/<a class="el" href="Clustering__c_8h_source.html">Clustering_c.h</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>
|