nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-mo/doc/html/classmo_exponential_cooling_schedule.html
jboisson 7a47863fd2 I have forgotten to regenerate the documentation, it is done 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@589 331e1502-861f-0410-8da2-ba01fb791d7f
2007-08-03 14:40:30 +00:00

153 lines
9.1 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>PARADISEO-MO: moExponentialCoolingSchedule Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>moExponentialCoolingSchedule Class Reference</h1><!-- doxytag: class="moExponentialCoolingSchedule" --><!-- doxytag: inherits="moCoolingSchedule" -->One of the possible <a class="el" href="classmo_cooling_schedule.html" title="This class gives the description of a cooling schedule.">moCoolingSchedule</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_exponential_cooling_schedule_8h-source.html">moExponentialCoolingSchedule.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moExponentialCoolingSchedule:
<p><center><img src="classmo_exponential_cooling_schedule.png" usemap="#moExponentialCoolingSchedule_map" border="0" alt=""></center>
<map name="moExponentialCoolingSchedule_map">
<area href="classmo_cooling_schedule.html" alt="moCoolingSchedule" shape="rect" coords="0,112,189,136">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_u_f.html" alt="eoUF< double &, bool >" shape="rect" coords="0,56,189,80">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="0,0,189,24">
</map>
<a href="classmo_exponential_cooling_schedule-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_exponential_cooling_schedule.html#b01930c1051c0940666c6325bfd036bc">moExponentialCoolingSchedule</a> (double __threshold, double __ratio)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Basic constructor. <a href="#b01930c1051c0940666c6325bfd036bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_exponential_cooling_schedule.html#00642b03453b51612a10fcf2280543db">operator()</a> (double &amp;__temp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function which proceeds to the cooling. <a href="#00642b03453b51612a10fcf2280543db"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d4327c0bb33b7121a322279eea97f84"></a><!-- doxytag: member="moExponentialCoolingSchedule::threshold" ref="8d4327c0bb33b7121a322279eea97f84" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_exponential_cooling_schedule.html#8d4327c0bb33b7121a322279eea97f84">threshold</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The temperature threhold. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8f3f87417c1c7253efb938a740846fa"></a><!-- doxytag: member="moExponentialCoolingSchedule::ratio" ref="e8f3f87417c1c7253efb938a740846fa" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_exponential_cooling_schedule.html#e8f3f87417c1c7253efb938a740846fa">ratio</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The decreasing factor of the temperature. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
One of the possible <a class="el" href="classmo_cooling_schedule.html" title="This class gives the description of a cooling schedule.">moCoolingSchedule</a>.
<p>
An other very simple cooling schedule, the temperature decrease according to a ratio while the temperature is greater than a given threshold.
<p>
<p>
Definition at line <a class="el" href="mo_exponential_cooling_schedule_8h-source.html#l00022">22</a> of file <a class="el" href="mo_exponential_cooling_schedule_8h-source.html">moExponentialCoolingSchedule.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b01930c1051c0940666c6325bfd036bc"></a><!-- doxytag: member="moExponentialCoolingSchedule::moExponentialCoolingSchedule" ref="b01930c1051c0940666c6325bfd036bc" args="(double __threshold, double __ratio)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">moExponentialCoolingSchedule::moExponentialCoolingSchedule </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>__threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>__ratio</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Basic constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>__threshold</em>&nbsp;</td><td>the threshold. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__ratio</em>&nbsp;</td><td>the ratio used to descrease the temperature. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_exponential_cooling_schedule_8h-source.html#l00031">31</a> of file <a class="el" href="mo_exponential_cooling_schedule_8h-source.html">moExponentialCoolingSchedule.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="00642b03453b51612a10fcf2280543db"></a><!-- doxytag: member="moExponentialCoolingSchedule::operator()" ref="00642b03453b51612a10fcf2280543db" args="(double &amp;__temp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool moExponentialCoolingSchedule::operator() </td>
<td>(</td>
<td class="paramtype">double &amp;&nbsp;</td>
<td class="paramname"> <em>__temp</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function which proceeds to the cooling.
<p>
It decreases the temperature and indicates if it is greater than the threshold.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>__temp</em>&nbsp;</td><td>the current temperature. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>if the new temperature (current temperature * ratio) is greater than the threshold. </dd></dl>
<p>
Implements <a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_u_f.html#786e028409366dc273e19104f17ba68a">eoUF&lt; double &amp;, bool &gt;</a>.
<p>
Definition at line <a class="el" href="mo_exponential_cooling_schedule_8h-source.html#l00041">41</a> of file <a class="el" href="mo_exponential_cooling_schedule_8h-source.html">moExponentialCoolingSchedule.h</a>.
<p>
References <a class="el" href="mo_exponential_cooling_schedule_8h-source.html#l00052">ratio</a>, and <a class="el" href="mo_exponential_cooling_schedule_8h-source.html#l00049">threshold</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_exponential_cooling_schedule_8h-source.html">moExponentialCoolingSchedule.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 3 16:38:57 2007 for PARADISEO-MO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink