paradiseo/trunk/paradiseo-mo/doc/html/classmo_linear_cooling_schedule.html

151 lines
9 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: moLinearCoolingSchedule 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.7 -->
<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>moLinearCoolingSchedule Class Reference</h1><!-- doxytag: class="moLinearCoolingSchedule" --><!-- doxytag: inherits="moCoolingSchedule" -->One of the possible <a class="el" href="classmo_cooling_schedule.html">moCoolingSchedule</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_linear_cooling_schedule_8h-source.html">moLinearCoolingSchedule.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moLinearCoolingSchedule:
<p><center><img src="classmo_linear_cooling_schedule.png" usemap="#moLinearCoolingSchedule_map" border="0" alt=""></center>
<map name="moLinearCoolingSchedule_map">
<area href="classmo_cooling_schedule.html" alt="moCoolingSchedule" shape="rect" coords="0,112,160,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_u_f.html" alt="eoUF< double &, bool >" shape="rect" coords="0,56,160,80">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="0,0,160,24">
</map>
<a href="classmo_linear_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_linear_cooling_schedule.html#2fdde7b1520d5a41251627e81cc9c13d">moLinearCoolingSchedule</a> (double __threshold, double __quantity)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple constructor. <a href="#2fdde7b1520d5a41251627e81cc9c13d"></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_linear_cooling_schedule.html#814b109fdfd9426a92a5444b05014da3">operator()</a> (double &amp;__temp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/struct_function.html">Function</a> which proceeds to the cooling. <a href="#814b109fdfd9426a92a5444b05014da3"></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="e7f539f986801ea71392c4a55ba08a76"></a><!-- doxytag: member="moLinearCoolingSchedule::threshold" ref="e7f539f986801ea71392c4a55ba08a76" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_linear_cooling_schedule.html#e7f539f986801ea71392c4a55ba08a76">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="6159dc39ceda89b23ffdab3d6ce8d8ed"></a><!-- doxytag: member="moLinearCoolingSchedule::quantity" ref="6159dc39ceda89b23ffdab3d6ce8d8ed" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_linear_cooling_schedule.html#6159dc39ceda89b23ffdab3d6ce8d8ed">quantity</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The quantity that allows the temperature to decrease. <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">moCoolingSchedule</a>.
<p>
An another very simple cooling schedule, the temperature decrease according to a quantity while the temperature is greater than a threshold.
<p>
<p>
Definition at line <a class="el" href="mo_linear_cooling_schedule_8h-source.html#l00022">22</a> of file <a class="el" href="mo_linear_cooling_schedule_8h-source.html">moLinearCoolingSchedule.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2fdde7b1520d5a41251627e81cc9c13d"></a><!-- doxytag: member="moLinearCoolingSchedule::moLinearCoolingSchedule" ref="2fdde7b1520d5a41251627e81cc9c13d" args="(double __threshold, double __quantity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">moLinearCoolingSchedule::moLinearCoolingSchedule </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>__quantity</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>
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>__quantity</em>&nbsp;</td><td>the quantity used to descrease the temperature. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_linear_cooling_schedule_8h-source.html#l00031">31</a> of file <a class="el" href="mo_linear_cooling_schedule_8h-source.html">moLinearCoolingSchedule.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="814b109fdfd9426a92a5444b05014da3"></a><!-- doxytag: member="moLinearCoolingSchedule::operator()" ref="814b109fdfd9426a92a5444b05014da3" args="(double &amp;__temp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool moLinearCoolingSchedule::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>
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/struct_function.html">Function</a> 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 compact><dt><b>Returns:</b></dt><dd>if the new temperature (current temperature - quantity) is greater than the threshold. </dd></dl>
<p>
Implements <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_u_f.html#786e028409366dc273e19104f17ba68a">eoUF&lt; double &amp;, bool &gt;</a>.
<p>
Definition at line <a class="el" href="mo_linear_cooling_schedule_8h-source.html#l00041">41</a> of file <a class="el" href="mo_linear_cooling_schedule_8h-source.html">moLinearCoolingSchedule.h</a>.
<p>
References <a class="el" href="mo_linear_cooling_schedule_8h-source.html#l00052">quantity</a>, and <a class="el" href="mo_linear_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_linear_cooling_schedule_8h-source.html">moLinearCoolingSchedule.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jul 5 12:04:05 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.4.7 </small></address>
</body>
</html>