faiss/docs/html/structfaiss_1_1SimulatedAnn...

156 lines
10 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: faiss::SimulatedAnnealingParameters 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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_1SimulatedAnnealingParameters.html">SimulatedAnnealingParameters</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1SimulatedAnnealingParameters-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::SimulatedAnnealingParameters Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>parameters used for the simulated annealing method
<a href="structfaiss_1_1SimulatedAnnealingParameters.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PolysemousTraining_8h_source.html">PolysemousTraining.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::SimulatedAnnealingParameters:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1SimulatedAnnealingParameters.png" usemap="#faiss::SimulatedAnnealingParameters_map" alt=""/>
<map id="faiss::SimulatedAnnealingParameters_map" name="faiss::SimulatedAnnealingParameters_map">
<area href="structfaiss_1_1PolysemousTraining.html" title="optimizes the order of indices in a ProductQuantizer " alt="faiss::PolysemousTraining" shape="rect" coords="0,56,219,80"/>
<area href="structfaiss_1_1SimulatedAnnealingOptimizer.html" title="Simulated annealing optimization algorithm for permutations. " alt="faiss::SimulatedAnnealingOptimizer" shape="rect" coords="229,56,448,80"/>
</map>
</div></div>
<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:a217f2edf539c4c5b7acb9b54129ba024"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a217f2edf539c4c5b7acb9b54129ba024"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>init_temperature</b></td></tr>
<tr class="separator:a217f2edf539c4c5b7acb9b54129ba024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa504c46bab0faa2ce816df8294b55ce5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa504c46bab0faa2ce816df8294b55ce5"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>temperature_decay</b></td></tr>
<tr class="separator:aa504c46bab0faa2ce816df8294b55ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a782872c517c1a0b8211c6179f60e6d8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a782872c517c1a0b8211c6179f60e6d8e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>n_iter</b></td></tr>
<tr class="separator:a782872c517c1a0b8211c6179f60e6d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf0dc7ec9cf5cfb6b043b2610e2beff4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf0dc7ec9cf5cfb6b043b2610e2beff4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>n_redo</b></td></tr>
<tr class="separator:adf0dc7ec9cf5cfb6b043b2610e2beff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6b87ff7698b724937bc00c0845a71ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6b87ff7698b724937bc00c0845a71ad"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>seed</b></td></tr>
<tr class="separator:ae6b87ff7698b724937bc00c0845a71ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0bbe4df85cb764234d6a700d0db00c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0bbe4df85cb764234d6a700d0db00c4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>verbose</b></td></tr>
<tr class="separator:ae0bbe4df85cb764234d6a700d0db00c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a92240b3cfe75d58c802dbedf4e4c2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a92240b3cfe75d58c802dbedf4e4c2e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>only_bit_flips</b></td></tr>
<tr class="separator:a1a92240b3cfe75d58c802dbedf4e4c2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a66766c4a8ca802c99a4c1315e197d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a66766c4a8ca802c99a4c1315e197d9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>init_random</b></td></tr>
<tr class="separator:a2a66766c4a8ca802c99a4c1315e197d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>parameters used for the simulated annealing method </p>
<p>Definition at line <a class="el" href="PolysemousTraining_8h_source.html#l00025">25</a> of file <a class="el" href="PolysemousTraining_8h_source.html">PolysemousTraining.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="PolysemousTraining_8h_source.html">PolysemousTraining.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="PolysemousTraining_8cpp_source.html">PolysemousTraining.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>