nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/docs/html/classmo_it_rand_next_move.html

174 lines
10 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-MO: moItRandNextMove&lt; M &gt; Class Template 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.1 -->
<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>moItRandNextMove&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moItRandNextMove" --><!-- doxytag: inherits="moNextMove" -->One of the possible <a class="el" href="classmo_next_move.html">moNextMove</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_it_rand_next_move_8h-source.html">moItRandNextMove.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moItRandNextMove&lt; M &gt;:
<p><center><img src="classmo_it_rand_next_move.png" usemap="#moItRandNextMove< M >_map" border="0" alt=""></center>
<map name="moItRandNextMove< M >_map">
<area href="classmo_next_move.html" alt="moNextMove< M >" shape="rect" coords="0,0,155,24">
</map>
<a href="classmo_it_rand_next_move-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_it_rand_next_move.html#95ed13e1178f4e44cab7184b040b83d7">moItRandNextMove</a> (<a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;__rand_move, unsigned __max_iter)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor. <a href="#95ed13e1178f4e44cab7184b040b83d7"></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_it_rand_next_move.html#92a2fbbc02a20853b9a309e99018a102">operator()</a> (M &amp;__move, const <a class="el" href="classmo_it_rand_next_move.html#ee666007fc494bf4a5f0cd065e5671cf">EOT</a> &amp;__sol)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generation of a new move. <a href="#92a2fbbc02a20853b9a309e99018a102"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee666007fc494bf4a5f0cd065e5671cf"></a><!-- doxytag: member="moItRandNextMove::EOT" ref="ee666007fc494bf4a5f0cd065e5671cf" args="" -->
typedef M::EOType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_it_rand_next_move.html#ee666007fc494bf4a5f0cd065e5671cf">EOT</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alias for the type. <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="ef9410ec5e7dfa7f002e05967931c459"></a><!-- doxytag: member="moItRandNextMove::rand_move" ref="ef9410ec5e7dfa7f002e05967931c459" args="" -->
<a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_it_rand_next_move.html#ef9410ec5e7dfa7f002e05967931c459">rand_move</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A move generator (generally randomly). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c476f7cc089b171493c52965f920542"></a><!-- doxytag: member="moItRandNextMove::max_iter" ref="3c476f7cc089b171493c52965f920542" args="" -->
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_it_rand_next_move.html#3c476f7cc089b171493c52965f920542">max_iter</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Iteration maximum number. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3551d7910cf351d63f0f3427fc18504"></a><!-- doxytag: member="moItRandNextMove::num_iter" ref="c3551d7910cf351d63f0f3427fc18504" args="" -->
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_it_rand_next_move.html#c3551d7910cf351d63f0f3427fc18504">num_iter</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Iteration current number. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class M&gt;<br>
class moItRandNextMove&lt; M &gt;</h3>
One of the possible <a class="el" href="classmo_next_move.html">moNextMove</a>.
<p>
This class is a move (<a class="el" href="classmo_move.html">moMove</a>) generator with a bound for the maximum number of iterations.
<p>
<p>
Definition at line <a class="el" href="mo_it_rand_next_move_8h-source.html#l00022">22</a> of file <a class="el" href="mo_it_rand_next_move_8h-source.html">moItRandNextMove.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="95ed13e1178f4e44cab7184b040b83d7"></a><!-- doxytag: member="moItRandNextMove::moItRandNextMove" ref="95ed13e1178f4e44cab7184b040b83d7" args="(moRandMove&lt; M &gt; &amp;__rand_move, unsigned __max_iter)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmo_it_rand_next_move.html">moItRandNextMove</a>&lt; M &gt;::<a class="el" href="classmo_it_rand_next_move.html">moItRandNextMove</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>__rand_move</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>__max_iter</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>
The constructor.
<p>
Parameters only for initialising the attributes.<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>__rand_move</em>&nbsp;</td><td>the random move generator. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__max_iter</em>&nbsp;</td><td>the iteration maximum number. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_it_rand_next_move_8h-source.html#l00037">37</a> of file <a class="el" href="mo_it_rand_next_move_8h-source.html">moItRandNextMove.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="92a2fbbc02a20853b9a309e99018a102"></a><!-- doxytag: member="moItRandNextMove::operator()" ref="92a2fbbc02a20853b9a309e99018a102" args="(M &amp;__move, const EOT &amp;__sol)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmo_it_rand_next_move.html">moItRandNextMove</a>&lt; M &gt;::operator() </td>
<td>(</td>
<td class="paramtype">M &amp;&nbsp;</td>
<td class="paramname"> <em>__move</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classmo_it_rand_next_move.html#ee666007fc494bf4a5f0cd065e5671cf">EOT</a> &amp;&nbsp;</td>
<td class="paramname"> <em>__sol</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>
Generation of a new move.
<p>
If the maximum number is not already reached, the current move is forgotten and remplaced by another one.<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>__move</em>&nbsp;</td><td>the current move. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__sol</em>&nbsp;</td><td>the current solution. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE if the maximum number of iteration is reached, else TRUE. </dd></dl>
<p>
Definition at line <a class="el" href="mo_it_rand_next_move_8h-source.html#l00052">52</a> of file <a class="el" href="mo_it_rand_next_move_8h-source.html">moItRandNextMove.h</a>.
<p>
References <a class="el" href="mo_it_rand_next_move_8h-source.html#l00077">moItRandNextMove&lt; M &gt;::max_iter</a>, <a class="el" href="mo_it_rand_next_move_8h-source.html#l00080">moItRandNextMove&lt; M &gt;::num_iter</a>, and <a class="el" href="mo_it_rand_next_move_8h-source.html#l00074">moItRandNextMove&lt; M &gt;::rand_move</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_it_rand_next_move_8h-source.html">moItRandNextMove.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 14:28:37 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.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink