nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/branches/paradiseo-moeo-1.0/doc/html/classmoeoObjectiveVector.html
liefooga b1d6dd41c0 add doc 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
2007-06-26 13:13:33 +00:00

222 lines
14 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-MOEO: moeoObjectiveVector&lt; ObjectiveVectorTraits, ObjectiveVectorType &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.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>moeoObjectiveVector&lt; ObjectiveVectorTraits, ObjectiveVectorType &gt; Class Template Reference</h1><!-- doxytag: class="moeoObjectiveVector" -->Abstract class allowing to represent a solution in the objective space (phenotypic representation).
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a>&gt;</code>
<p>
<a href="classmoeoObjectiveVector-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21ee0475420b613951b96a550e814fbb"></a><!-- doxytag: member="moeoObjectiveVector::Traits" ref="21ee0475420b613951b96a550e814fbb" args="" -->
typedef ObjectiveVectorTraits&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#21ee0475420b613951b96a550e814fbb">Traits</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The traits of objective vectors. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e86f199692cae43bc346be63130eb993"></a><!-- doxytag: member="moeoObjectiveVector::Type" ref="e86f199692cae43bc346be63130eb993" args="" -->
typedef ObjectiveVectorType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#e86f199692cae43bc346be63130eb993">Type</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of an objective value. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="084e9d2cecbf9ea66e4b68537457109f"></a><!-- doxytag: member="moeoObjectiveVector::moeoObjectiveVector" ref="084e9d2cecbf9ea66e4b68537457109f" args="(Type _value=Type())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#084e9d2cecbf9ea66e4b68537457109f">moeoObjectiveVector</a> (<a class="el" href="classmoeoObjectiveVector.html#e86f199692cae43bc346be63130eb993">Type</a> _value=<a class="el" href="classmoeoObjectiveVector.html#e86f199692cae43bc346be63130eb993">Type</a>())</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#c504cb6a2086a80aaaf41978032c8ce7">moeoObjectiveVector</a> (std::vector&lt; <a class="el" href="classmoeoObjectiveVector.html#e86f199692cae43bc346be63130eb993">Type</a> &gt; &amp;_v)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor from a vector of Type. <a href="#c504cb6a2086a80aaaf41978032c8ce7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#0593e2d91be697d9b255513236cb207f">setup</a> (unsigned int _nObjectives, std::vector&lt; bool &gt; &amp;_bObjectives)</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_parameters.html">Parameters</a> setting (for the objective vector of any solution). <a href="#0593e2d91be697d9b255513236cb207f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c9a17116e0a95b4e3191f299e10fc9d"></a><!-- doxytag: member="moeoObjectiveVector::nObjectives" ref="4c9a17116e0a95b4e3191f299e10fc9d" args="()" -->
static unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#4c9a17116e0a95b4e3191f299e10fc9d">nObjectives</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of objectives. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#decaf6e3b9a9ac97461d2b271facfc5f">minimizing</a> (unsigned int _i)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the _ith objective have to be minimized. <a href="#decaf6e3b9a9ac97461d2b271facfc5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVector.html#b62231b0e1c6bb6bab43d6d058871ce3">maximizing</a> (unsigned int _i)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the _ith objective have to be maximized. <a href="#b62231b0e1c6bb6bab43d6d058871ce3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ObjectiveVectorTraits, class ObjectiveVectorType&gt;<br>
class moeoObjectiveVector&lt; ObjectiveVectorTraits, ObjectiveVectorType &gt;</h3>
Abstract class allowing to represent a solution in the objective space (phenotypic representation).
<p>
The template argument ObjectiveVectorTraits defaults to <a class="el" href="classmoeoObjectiveVectorTraits.html">moeoObjectiveVectorTraits</a>, but it can be replaced at will by any other class that implements the static functions defined therein. Some static funtions to access to the traits characteristics are re-defined in order not to write a lot of typedef's.
<p>
<p>
Definition at line <a class="el" href="moeoObjectiveVector_8h-source.html#l00025">25</a> of file <a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c504cb6a2086a80aaaf41978032c8ce7"></a><!-- doxytag: member="moeoObjectiveVector::moeoObjectiveVector" ref="c504cb6a2086a80aaaf41978032c8ce7" args="(std::vector&lt; Type &gt; &amp;_v)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVectorTraits, class ObjectiveVectorType&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a>&lt; ObjectiveVectorTraits, ObjectiveVectorType &gt;::<a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a> </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classmoeoObjectiveVector.html#e86f199692cae43bc346be63130eb993">Type</a> &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_v</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ctor from a vector of Type.
<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>_v</em>&nbsp;</td><td>the std::vector &lt; Type &gt; </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoObjectiveVector_8h-source.html#l00046">46</a> of file <a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0593e2d91be697d9b255513236cb207f"></a><!-- doxytag: member="moeoObjectiveVector::setup" ref="0593e2d91be697d9b255513236cb207f" args="(unsigned int _nObjectives, std::vector&lt; bool &gt; &amp;_bObjectives)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVectorTraits, class ObjectiveVectorType&gt; </div>
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a>&lt; ObjectiveVectorTraits, ObjectiveVectorType &gt;::setup </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>_nObjectives</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; bool &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_bObjectives</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, static]</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_parameters.html">Parameters</a> setting (for the objective vector of any solution).
<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>_nObjectives</em>&nbsp;</td><td>the number of objectives </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_bObjectives</em>&nbsp;</td><td>the min/max vector (true = min / false = max) </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoObjectiveVector_8h-source.html#l00055">55</a> of file <a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a>.
</div>
</div><p>
<a class="anchor" name="decaf6e3b9a9ac97461d2b271facfc5f"></a><!-- doxytag: member="moeoObjectiveVector::minimizing" ref="decaf6e3b9a9ac97461d2b271facfc5f" args="(unsigned int _i)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVectorTraits, class ObjectiveVectorType&gt; </div>
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a>&lt; ObjectiveVectorTraits, ObjectiveVectorType &gt;::minimizing </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>_i</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the _ith objective have to be minimized.
<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>_i</em>&nbsp;</td><td>the index </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoObjectiveVector_8h-source.html#l00074">74</a> of file <a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a>.
</div>
</div><p>
<a class="anchor" name="b62231b0e1c6bb6bab43d6d058871ce3"></a><!-- doxytag: member="moeoObjectiveVector::maximizing" ref="b62231b0e1c6bb6bab43d6d058871ce3" args="(unsigned int _i)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVectorTraits, class ObjectiveVectorType&gt; </div>
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a>&lt; ObjectiveVectorTraits, ObjectiveVectorType &gt;::maximizing </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>_i</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the _ith objective have to be maximized.
<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>_i</em>&nbsp;</td><td>the index </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoObjectiveVector_8h-source.html#l00084">84</a> of file <a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoObjectiveVector_8h-source.html">moeoObjectiveVector.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jun 26 15:13:04 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.4.7 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink