paradiseo/trunk/paradiseo-moeo/docs/html/make__continue__moeo_8h-source.html
liefooga 2e7e817428 update docs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-17 15:45:01 +00:00

123 lines
15 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-MOEO: make_continue_moeo.h Source File</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.1 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li id="current"><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>
<h1>make_continue_moeo.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-</span>
<a name="l00002"></a>00002
<a name="l00003"></a>00003 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00004"></a>00004 <span class="comment">// make_continue_moeo.h</span>
<a name="l00005"></a>00005 <span class="comment">// (c) OPAC Team (LIFL), Dolphin Project (INRIA), 2007</span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> This library...</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> Contact: paradiseo-help@lists.gforge.inria.fr, http://paradiseo.gforge.inria.fr</span>
<a name="l00010"></a>00010 <span class="comment"> */</span>
<a name="l00011"></a>00011 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="preprocessor">#ifndef MAKE_CONTINUE_MOEO_H_</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_CONTINUE_MOEO_H_</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;eoCombinedContinue.h&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;eoGenContinue.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;eoEvalContinue.h&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;eoFitContinue.h&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;eoTimeContinue.h&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef _MSC_VER</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#include &lt;eoCtrlCContinue.h&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#include &lt;utils/eoParser.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;utils/eoState.h&gt;</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027
<a name="l00033"></a>00033 <span class="keyword">template</span> &lt;<span class="keyword">class</span> MOEOT&gt;
<a name="l00034"></a>00034 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_combined_continue.html">eoCombinedContinue&lt;MOEOT&gt;</a> * make_combinedContinue(<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_combined_continue.html">eoCombinedContinue&lt;MOEOT&gt;</a> *_combined, <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_continue.html">eoContinue&lt;MOEOT&gt;</a> *_cont)
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keywordflow">if</span> (_combined) <span class="comment">// already exists</span>
<a name="l00037"></a>00037 _combined-&gt;<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_combined_continue.html#a2">add</a>(*_cont);
<a name="l00038"></a>00038 <span class="keywordflow">else</span>
<a name="l00039"></a>00039 _combined = <span class="keyword">new</span> <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_combined_continue.html">eoCombinedContinue&lt;MOEOT&gt;</a>(*_cont);
<a name="l00040"></a>00040 <span class="keywordflow">return</span> _combined;
<a name="l00041"></a>00041 }
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00050"></a>00050 <span class="keyword">template</span> &lt;<span class="keyword">class</span> MOEOT&gt;
<a name="l00051"></a>00051 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_continue.html">eoContinue&lt;MOEOT&gt;</a> &amp; do_make_continue_moeo(<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_parser.html">eoParser</a>&amp; _parser, <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_state.html">eoState</a>&amp; _state, <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_eval_func_counter.html">eoEvalFuncCounter&lt;MOEOT&gt;</a> &amp; _eval)
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="comment">// the combined continue - to be filled</span>
<a name="l00054"></a>00054 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_combined_continue.html">eoCombinedContinue&lt;MOEOT&gt;</a> *continuator = NULL;
<a name="l00055"></a>00055 <span class="comment">// First the eoGenContinue - need a default value so you can run blind</span>
<a name="l00056"></a>00056 <span class="comment">// but we also need to be able to avoid it &lt;--&gt; 0</span>
<a name="l00057"></a>00057 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html">eoValueParam&lt;unsigned&gt;</a>&amp; maxGenParam = _parser.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_parameter_loader.html#a3">createParam</a>(<span class="keywordtype">unsigned</span>(100), <span class="stringliteral">"maxGen"</span>, <span class="stringliteral">"Maximum number of generations (0 = none)"</span>,<span class="charliteral">'G'</span>,<span class="stringliteral">"Stopping criterion"</span>);
<a name="l00058"></a>00058 <span class="keywordflow">if</span> (maxGenParam.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html#a2">value</a>()) <span class="comment">// positive: -&gt; define and store</span>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_gen_continue.html">eoGenContinue&lt;MOEOT&gt;</a> *genCont = <span class="keyword">new</span> <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_gen_continue.html">eoGenContinue&lt;MOEOT&gt;</a>(maxGenParam.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html#a2">value</a>());
<a name="l00061"></a>00061 _state.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_store.html#a2">storeFunctor</a>(genCont);
<a name="l00062"></a>00062 <span class="comment">// and "add" to combined</span>
<a name="l00063"></a>00063 continuator = make_combinedContinue&lt;MOEOT&gt;(continuator, genCont);
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065 <span class="comment">// maxEval</span>
<a name="l00066"></a>00066 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html">eoValueParam&lt;unsigned long&gt;</a>&amp; maxEvalParam = _parser.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_parser.html#a10">getORcreateParam</a>((<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>)0, <span class="stringliteral">"maxEval"</span>, <span class="stringliteral">"Maximum number of evaluations (0 = none)"</span>, <span class="charliteral">'E'</span>, <span class="stringliteral">"Stopping criterion"</span>);
<a name="l00067"></a>00067 <span class="keywordflow">if</span> (maxEvalParam.value())
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_eval_continue.html">eoEvalContinue&lt;MOEOT&gt;</a> *evalCont = <span class="keyword">new</span> <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_eval_continue.html">eoEvalContinue&lt;MOEOT&gt;</a>(_eval, maxEvalParam.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html#a2">value</a>());
<a name="l00070"></a>00070 _state.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_store.html#a2">storeFunctor</a>(evalCont);
<a name="l00071"></a>00071 <span class="comment">// and "add" to combined</span>
<a name="l00072"></a>00072 continuator = make_combinedContinue&lt;MOEOT&gt;(continuator, evalCont);
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074 <span class="comment">// maxTime</span>
<a name="l00075"></a>00075 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html">eoValueParam&lt;unsigned long&gt;</a>&amp; maxTimeParam = _parser.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_parser.html#a10">getORcreateParam</a>((<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>)0, <span class="stringliteral">"maxTime"</span>, <span class="stringliteral">"Maximum running time in seconds (0 = none)"</span>, <span class="charliteral">'T'</span>, <span class="stringliteral">"Stopping criterion"</span>);
<a name="l00076"></a>00076 <span class="keywordflow">if</span> (maxTimeParam.value()) <span class="comment">// positive: -&gt; define and store</span>
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 eoTimeContinue&lt;MOEOT&gt; *timeCont = <span class="keyword">new</span> eoTimeContinue&lt;MOEOT&gt;(maxTimeParam.value());
<a name="l00079"></a>00079 _state.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_store.html#a2">storeFunctor</a>(timeCont);
<a name="l00080"></a>00080 <span class="comment">// and "add" to combined</span>
<a name="l00081"></a>00081 continuator = make_combinedContinue&lt;MOEOT&gt;(continuator, timeCont);
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 <span class="comment">// CtrlC</span>
<a name="l00084"></a>00084 <span class="preprocessor">#ifndef _MSC_VER</span>
<a name="l00085"></a>00085 <span class="preprocessor"></span> <span class="comment">// the CtrlC interception (Linux only I'm afraid)</span>
<a name="l00086"></a>00086 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_ctrl_c_continue.html">eoCtrlCContinue&lt;MOEOT&gt;</a> *ctrlCCont;
<a name="l00087"></a>00087 <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_value_param.html">eoValueParam&lt;bool&gt;</a>&amp; ctrlCParam = _parser.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_parameter_loader.html#a3">createParam</a>(<span class="keyword">true</span>, <span class="stringliteral">"CtrlC"</span>, <span class="stringliteral">"Terminate current generation upon Ctrl C"</span>,<span class="charliteral">'C'</span>, <span class="stringliteral">"Stopping criterion"</span>);
<a name="l00088"></a>00088 <span class="keywordflow">if</span> (_parser.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_parser.html#a8">isItThere</a>(ctrlCParam))
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090 ctrlCCont = <span class="keyword">new</span> <a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_ctrl_c_continue.html">eoCtrlCContinue&lt;MOEOT&gt;</a>;
<a name="l00091"></a>00091 <span class="comment">// store</span>
<a name="l00092"></a>00092 _state.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_store.html#a2">storeFunctor</a>(ctrlCCont);
<a name="l00093"></a>00093 <span class="comment">// add to combinedContinue</span>
<a name="l00094"></a>00094 continuator = make_combinedContinue&lt;MOEOT&gt;(continuator, ctrlCCont);
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 <span class="preprocessor">#endif</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span> <span class="comment">// now check that there is at least one!</span>
<a name="l00098"></a>00098 <span class="keywordflow">if</span> (!continuator)
<a name="l00099"></a>00099 <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">"You MUST provide a stopping criterion"</span>);
<a name="l00100"></a>00100 <span class="comment">// OK, it's there: store in the eoState</span>
<a name="l00101"></a>00101 _state.<a class="codeRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_store.html#a2">storeFunctor</a>(continuator);
<a name="l00102"></a>00102 <span class="comment">// and return</span>
<a name="l00103"></a>00103 <span class="keywordflow">return</span> *continuator;
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="preprocessor">#endif </span><span class="comment">/*MAKE_CONTINUE_MOEO_H_*/</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Apr 17 16:53:20 2007 for ParadisEO-MOEO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>