paradiseo/trunk/paradiseo-mo/docs/html/classmo_easy_cool_sched.html
legrand bbad098cba MO full import
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@25 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-06 12:56:53 +00:00

163 lines
8.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PARADISEO-MO: moEasyCoolSched 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.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li id="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>moEasyCoolSched Class Reference</h1><!-- doxytag: class="moEasyCoolSched" --><!-- doxytag: inherits="moCoolSched" -->One of the possible <a class="el" href="classmo_cool_sched.html">moCoolSched</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_easy_cool_sched_8h-source.html">moEasyCoolSched.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moEasyCoolSched:
<p><center><img src="classmo_easy_cool_sched.png" usemap="#moEasyCoolSched_map" border="0" alt=""></center>
<map name="moEasyCoolSched_map">
<area href="classmo_cool_sched.html" alt="moCoolSched" shape="rect" coords="0,0,118,24">
</map>
<a href="classmo_easy_cool_sched-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_easy_cool_sched.html#c556b41343700293bb17e3b20d81e0f2">moEasyCoolSched</a> (double __threshold, double __ratio)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple constructor. <a href="#c556b41343700293bb17e3b20d81e0f2"></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_easy_cool_sched.html#ca08df878417ef1124e6933a9c2d7a0b">operator()</a> (double &amp;__temp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function which proceeds to the cooling. <a href="#ca08df878417ef1124e6933a9c2d7a0b"></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="3dd53700390b7bb6428db80e01626c83"></a><!-- doxytag: member="moEasyCoolSched::threshold" ref="3dd53700390b7bb6428db80e01626c83" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_easy_cool_sched.html#3dd53700390b7bb6428db80e01626c83">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="1f84deff87defafd927e8c323b188f38"></a><!-- doxytag: member="moEasyCoolSched::ratio" ref="1f84deff87defafd927e8c323b188f38" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_easy_cool_sched.html#1f84deff87defafd927e8c323b188f38">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_cool_sched.html">moCoolSched</a>.
<p>
The simpliest, the temperature decrease according to a ratio until it greater than a threshold.
<p>
<p>
Definition at line <a class="el" href="mo_easy_cool_sched_8h-source.html#l00022">22</a> of file <a class="el" href="mo_easy_cool_sched_8h-source.html">moEasyCoolSched.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c556b41343700293bb17e3b20d81e0f2"></a><!-- doxytag: member="moEasyCoolSched::moEasyCoolSched" ref="c556b41343700293bb17e3b20d81e0f2" args="(double __threshold, double __ratio)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">moEasyCoolSched::moEasyCoolSched </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">double&nbsp;</td>
<td class="mdname" nowrap> <em>__threshold</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>double&nbsp;</td>
<td class="mdname" nowrap> <em>__ratio</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Simple 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_easy_cool_sched_8h-source.html#l00031">31</a> of file <a class="el" href="mo_easy_cool_sched_8h-source.html">moEasyCoolSched.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ca08df878417ef1124e6933a9c2d7a0b"></a><!-- doxytag: member="moEasyCoolSched::operator()" ref="ca08df878417ef1124e6933a9c2d7a0b" args="(double &amp;__temp)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool moEasyCoolSched::operator() </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">double &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>__temp</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Function which proceeds to the cooling.
<p>
Decrease 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 compact><dt><b>Returns:</b></dt><dd>if the new temperature (current temperature * ratio) is greater than the threshold. </dd></dl>
<p>
Definition at line <a class="el" href="mo_easy_cool_sched_8h-source.html#l00044">44</a> of file <a class="el" href="mo_easy_cool_sched_8h-source.html">moEasyCoolSched.h</a>.
<p>
References <a class="el" href="mo_easy_cool_sched_8h-source.html#l00056">ratio</a>, and <a class="el" href="mo_easy_cool_sched_8h-source.html#l00053">threshold</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_easy_cool_sched_8h-source.html">moEasyCoolSched.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 6 13:52:55 2006 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.4.6 </small></address>
</body>
</html>