nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-peo/doc/html/peoParallelAlgorithmWrapper_8h-source.html
legrand abc68c9e88 completed doc 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@665 331e1502-861f-0410-8da2-ba01fb791d7f
2007-10-08 09:41:23 +00:00

142 lines
16 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=iso-8859-1">
<title>ParadisEO-PEOMovingObjects: peoParallelAlgorithmWrapper.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.4.7 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>peoParallelAlgorithmWrapper.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* </span>
<a name="l00002"></a>00002 <span class="comment">* &lt;peoParallelAlgorithmWrapper.h&gt;</span>
<a name="l00003"></a>00003 <span class="comment">* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007</span>
<a name="l00004"></a>00004 <span class="comment">* (C) OPAC Team, LIFL, 2002-2007</span>
<a name="l00005"></a>00005 <span class="comment">*</span>
<a name="l00006"></a>00006 <span class="comment">* Sebastien Cahon, Alexandru-Adrian Tantar</span>
<a name="l00007"></a>00007 <span class="comment">*</span>
<a name="l00008"></a>00008 <span class="comment">* This software is governed by the CeCILL license under French law and</span>
<a name="l00009"></a>00009 <span class="comment">* abiding by the rules of distribution of free software. You can use,</span>
<a name="l00010"></a>00010 <span class="comment">* modify and/ or redistribute the software under the terms of the CeCILL</span>
<a name="l00011"></a>00011 <span class="comment">* license as circulated by CEA, CNRS and INRIA at the following URL</span>
<a name="l00012"></a>00012 <span class="comment">* "http://www.cecill.info".</span>
<a name="l00013"></a>00013 <span class="comment">*</span>
<a name="l00014"></a>00014 <span class="comment">* As a counterpart to the access to the source code and rights to copy,</span>
<a name="l00015"></a>00015 <span class="comment">* modify and redistribute granted by the license, users are provided only</span>
<a name="l00016"></a>00016 <span class="comment">* with a limited warranty and the software's author, the holder of the</span>
<a name="l00017"></a>00017 <span class="comment">* economic rights, and the successive licensors have only limited liability.</span>
<a name="l00018"></a>00018 <span class="comment">*</span>
<a name="l00019"></a>00019 <span class="comment">* In this respect, the user's attention is drawn to the risks associated</span>
<a name="l00020"></a>00020 <span class="comment">* with loading, using, modifying and/or developing or reproducing the</span>
<a name="l00021"></a>00021 <span class="comment">* software by the user in light of its specific status of free software,</span>
<a name="l00022"></a>00022 <span class="comment">* that may mean that it is complicated to manipulate, and that also</span>
<a name="l00023"></a>00023 <span class="comment">* therefore means that it is reserved for developers and experienced</span>
<a name="l00024"></a>00024 <span class="comment">* professionals having in-depth computer knowledge. Users are therefore</span>
<a name="l00025"></a>00025 <span class="comment">* encouraged to load and test the software's suitability as regards their</span>
<a name="l00026"></a>00026 <span class="comment">* requirements in conditions enabling the security of their systems and/or</span>
<a name="l00027"></a>00027 <span class="comment">* data to be ensured and, more generally, to use and operate it in the</span>
<a name="l00028"></a>00028 <span class="comment">* same conditions as regards security.</span>
<a name="l00029"></a>00029 <span class="comment">* The fact that you are presently reading this means that you have had</span>
<a name="l00030"></a>00030 <span class="comment">* knowledge of the CeCILL license and that you accept its terms.</span>
<a name="l00031"></a>00031 <span class="comment">*</span>
<a name="l00032"></a>00032 <span class="comment">* ParadisEO WebSite : http://paradiseo.gforge.inria.fr</span>
<a name="l00033"></a>00033 <span class="comment">* Contact: paradiseo-help@lists.gforge.inria.fr</span>
<a name="l00034"></a>00034 <span class="comment">*</span>
<a name="l00035"></a>00035 <span class="comment">*/</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef __peoParaAlgorithm_h</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define __peoParaAlgorithm_h</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#include "core/runner.h"</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include "core/peo_debug.h"</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a><a class="code" href="classpeoParallelAlgorithmWrapper.html">00047</a> <span class="keyword">class </span><a class="code" href="classpeoParallelAlgorithmWrapper.html">peoParallelAlgorithmWrapper</a> : <span class="keyword">public</span> <a class="code" href="classRunner.html">Runner</a> {
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050
<a name="l00051"></a><a class="code" href="classpeoParallelAlgorithmWrapper.html#e1e1de8b007934080876df1c65c4d8b0">00051</a> <span class="keyword">template</span>&lt; <span class="keyword">typename</span> AlgorithmType &gt; <a class="code" href="classpeoParallelAlgorithmWrapper.html#e1e1de8b007934080876df1c65c4d8b0">peoParallelAlgorithmWrapper</a>( AlgorithmType&amp; externalAlgorithm )
<a name="l00052"></a>00052 : <a class="code" href="classpeoParallelAlgorithmWrapper.html#99f10723f15c63c4822dd6431b9d6d7d">algorithm</a>( new <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html">Algorithm</a>&lt; AlgorithmType, void &gt;( externalAlgorithm ) ) {
<a name="l00053"></a>00053
<a name="l00054"></a>00054 }
<a name="l00055"></a>00055
<a name="l00056"></a><a class="code" href="classpeoParallelAlgorithmWrapper.html#1ebfe70e6826002f6280aba01e141ad5">00056</a> <span class="keyword">template</span>&lt; <span class="keyword">typename</span> AlgorithmType, <span class="keyword">typename</span> AlgorithmDataType &gt; <a class="code" href="classpeoParallelAlgorithmWrapper.html#e1e1de8b007934080876df1c65c4d8b0">peoParallelAlgorithmWrapper</a>( AlgorithmType&amp; externalAlgorithm, AlgorithmDataType&amp; externalData )
<a name="l00057"></a>00057 : <a class="code" href="classpeoParallelAlgorithmWrapper.html#99f10723f15c63c4822dd6431b9d6d7d">algorithm</a>( new <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html">Algorithm</a>&lt; AlgorithmType, AlgorithmDataType &gt;( externalAlgorithm, externalData ) ) {
<a name="l00058"></a>00058
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060
<a name="l00061"></a><a class="code" href="classpeoParallelAlgorithmWrapper.html#0e64f517afe790db467750a6980e1666">00061</a> <a class="code" href="classpeoParallelAlgorithmWrapper.html#0e64f517afe790db467750a6980e1666">~peoParallelAlgorithmWrapper</a>() {
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">delete</span> <a class="code" href="classpeoParallelAlgorithmWrapper.html#99f10723f15c63c4822dd6431b9d6d7d">algorithm</a>;
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="classpeoParallelAlgorithmWrapper.html#4b10b46b4ea2e3f66c660c15f3c98e6c">00066</a> <span class="keywordtype">void</span> <a class="code" href="classpeoParallelAlgorithmWrapper.html#4b10b46b4ea2e3f66c660c15f3c98e6c">run</a>() { <a class="code" href="classpeoParallelAlgorithmWrapper.html#99f10723f15c63c4822dd6431b9d6d7d">algorithm</a>-&gt;operator()(); }
<a name="l00067"></a>00067
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">private</span>:
<a name="l00070"></a>00070
<a name="l00071"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html">00071</a> <span class="keyword">struct </span><a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html">AbstractAlgorithm</a> {
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">// virtual destructor as we will be using inheritance and polymorphism</span>
<a name="l00074"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html#af530b7731cb212f8dd74e5a57484a9e">00074</a> <span class="keyword">virtual</span> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html#af530b7731cb212f8dd74e5a57484a9e">~AbstractAlgorithm</a>() { }
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// operator to be called for executing the algorithm</span>
<a name="l00077"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html#32e08b3810cef49d0b8751645ef79b6f">00077</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html#32e08b3810cef49d0b8751645ef79b6f">operator()</a>() { }
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079
<a name="l00080"></a>00080
<a name="l00081"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html">00081</a> <span class="keyword">template</span>&lt; <span class="keyword">typename</span> AlgorithmType, <span class="keyword">typename</span> AlgorithmDataType &gt; <span class="keyword">struct </span><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html">Algorithm</a> : <span class="keyword">public</span> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html">AbstractAlgorithm</a> {
<a name="l00082"></a>00082
<a name="l00083"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#bdd2048610a35f525d7cef9a9041caba">00083</a> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#bdd2048610a35f525d7cef9a9041caba">Algorithm</a>( AlgorithmType&amp; externalAlgorithm, AlgorithmDataType&amp; externalData )
<a name="l00084"></a>00084 : <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">algorithm</a>( externalAlgorithm ), <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#e812277c85c5b6884d2019849e7eabde">algorithmData</a>( externalData ) {
<a name="l00085"></a>00085
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#a54fa5366a7663491608399ab21ea092">00088</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#a54fa5366a7663491608399ab21ea092">operator()</a>() { <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">algorithm</a>( <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#e812277c85c5b6884d2019849e7eabde">algorithmData</a> ); }
<a name="l00089"></a>00089
<a name="l00090"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">00090</a> AlgorithmType&amp; <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">algorithm</a>;
<a name="l00091"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#e812277c85c5b6884d2019849e7eabde">00091</a> AlgorithmDataType&amp; <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#e812277c85c5b6884d2019849e7eabde">algorithmData</a>;
<a name="l00092"></a>00092 };
<a name="l00093"></a>00093
<a name="l00094"></a>00094
<a name="l00095"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm_3_01AlgorithmType_00_01void_01_4.html">00095</a> <span class="keyword">template</span>&lt; <span class="keyword">typename</span> AlgorithmType &gt; <span class="keyword">struct </span><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html">Algorithm</a>&lt; AlgorithmType, void &gt; : <span class="keyword">public</span> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html">AbstractAlgorithm</a> {
<a name="l00096"></a>00096
<a name="l00097"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm_3_01AlgorithmType_00_01void_01_4.html#c44d45b69accab079e1fb30d7ddf6b4e">00097</a> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#bdd2048610a35f525d7cef9a9041caba">Algorithm</a>( AlgorithmType&amp; externalAlgorithm ) : <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">algorithm</a>( externalAlgorithm ) {
<a name="l00098"></a>00098
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100
<a name="l00101"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm_3_01AlgorithmType_00_01void_01_4.html#27b5bd346932e7f3ba9dd8c9e0dd952b">00101</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#a54fa5366a7663491608399ab21ea092">operator()</a>() { <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">algorithm</a>(); }
<a name="l00102"></a>00102
<a name="l00103"></a><a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm_3_01AlgorithmType_00_01void_01_4.html#7dcb305dd8c78ffac232bd86b913183d">00103</a> AlgorithmType&amp; <a class="code" href="structpeoParallelAlgorithmWrapper_1_1Algorithm.html#91681bf54649f58335c181515a92db7a">algorithm</a>;
<a name="l00104"></a>00104 };
<a name="l00105"></a>00105
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">private</span>:
<a name="l00108"></a>00108
<a name="l00109"></a><a class="code" href="classpeoParallelAlgorithmWrapper.html#99f10723f15c63c4822dd6431b9d6d7d">00109</a> <a class="code" href="structpeoParallelAlgorithmWrapper_1_1AbstractAlgorithm.html">AbstractAlgorithm</a>* <a class="code" href="classpeoParallelAlgorithmWrapper.html#99f10723f15c63c4822dd6431b9d6d7d">algorithm</a>;
<a name="l00110"></a>00110 };
<a name="l00111"></a>00111
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Oct 8 11:16:46 2007 for ParadisEO-PEOMovingObjects 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>
Reference in a new issue View git blame Copy permalink