nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-moeo/docs/html/classmoeoObjectiveVectorTraits.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

183 lines
11 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: moeoObjectiveVectorTraits 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.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>moeoObjectiveVectorTraits Class Reference</h1><!-- doxytag: class="moeoObjectiveVectorTraits" -->A traits class for <a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a> to specify the number of objectives and which ones have to be minimized or maximized.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoObjectiveVectorTraits_8h-source.html">moeoObjectiveVectorTraits.h</a>&gt;</code>
<p>
<a href="classmoeoObjectiveVectorTraits-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="classmoeoObjectiveVectorTraits.html#52264fa9e700c4ff183dd90f6965d9fc">setup</a> (unsigned _nObjectives, std::vector&lt; bool &gt; &amp;_bObjectives)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parameters setting. <a href="#52264fa9e700c4ff183dd90f6965d9fc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7b3047536f5ba2f7d0da3f19b00f4d3"></a><!-- doxytag: member="moeoObjectiveVectorTraits::nObjectives" ref="b7b3047536f5ba2f7d0da3f19b00f4d3" args="()" -->
static unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVectorTraits.html#b7b3047536f5ba2f7d0da3f19b00f4d3">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="classmoeoObjectiveVectorTraits.html#5cb7975e5ea32809e01b7078313d326d">minimizing</a> (unsigned _i)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the _ith objective have to be minimized. <a href="#5cb7975e5ea32809e01b7078313d326d"></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="classmoeoObjectiveVectorTraits.html#b76148b68b28d41600065b9d82e815b5">maximizing</a> (unsigned _i)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the _ith objective have to be maximized. <a href="#b76148b68b28d41600065b9d82e815b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1199e4f019ec88a0365db81e9ab8d1f"></a><!-- doxytag: member="moeoObjectiveVectorTraits::tolerance" ref="c1199e4f019ec88a0365db81e9ab8d1f" args="()" -->
static double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVectorTraits.html#c1199e4f019ec88a0365db81e9ab8d1f">tolerance</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the tolerance value (to compare solutions). <br></td></tr>
<tr><td colspan="2"><br><h2>Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cac944804ce067ae62ca9b6bc139db03"></a><!-- doxytag: member="moeoObjectiveVectorTraits::nObj" ref="cac944804ce067ae62ca9b6bc139db03" args="" -->
static unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVectorTraits.html#cac944804ce067ae62ca9b6bc139db03">nObj</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of objectives. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db329d416c75711f671c9d7cffb06299"></a><!-- doxytag: member="moeoObjectiveVectorTraits::bObj" ref="db329d416c75711f671c9d7cffb06299" args="" -->
static std::vector&lt; bool &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoObjectiveVectorTraits.html#db329d416c75711f671c9d7cffb06299">bObj</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The min/max vector. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A traits class for <a class="el" href="classmoeoObjectiveVector.html">moeoObjectiveVector</a> to specify the number of objectives and which ones have to be minimized or maximized.
<p>
<p>
Definition at line <a class="el" href="moeoObjectiveVectorTraits_8h-source.html#l00023">23</a> of file <a class="el" href="moeoObjectiveVectorTraits_8h-source.html">moeoObjectiveVectorTraits.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="52264fa9e700c4ff183dd90f6965d9fc"></a><!-- doxytag: member="moeoObjectiveVectorTraits::setup" ref="52264fa9e700c4ff183dd90f6965d9fc" args="(unsigned _nObjectives, std::vector&lt; bool &gt; &amp;_bObjectives)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void moeoObjectiveVectorTraits::setup </td>
<td>(</td>
<td class="paramtype">unsigned&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>
Parameters setting.
<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="moeoObjectiveVectorTraits_8h-source.html#l00032">32</a> of file <a class="el" href="moeoObjectiveVectorTraits_8h-source.html">moeoObjectiveVectorTraits.h</a>.
<p>
References <a class="el" href="moeoObjectiveVectorTraits_8h-source.html#l00095">bObj</a>, and <a class="el" href="moeoObjectiveVectorTraits_8h-source.html#l00093">nObj</a>.
</div>
</div><p>
<a class="anchor" name="5cb7975e5ea32809e01b7078313d326d"></a><!-- doxytag: member="moeoObjectiveVectorTraits::minimizing" ref="5cb7975e5ea32809e01b7078313d326d" args="(unsigned _i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool moeoObjectiveVectorTraits::minimizing </td>
<td>(</td>
<td class="paramtype">unsigned&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="moeoObjectiveVectorTraits_8h-source.html#l00065">65</a> of file <a class="el" href="moeoObjectiveVectorTraits_8h-source.html">moeoObjectiveVectorTraits.h</a>.
<p>
References <a class="el" href="moeoObjectiveVectorTraits_8h-source.html#l00095">bObj</a>.
<p>
Referenced by <a class="el" href="moeoObjectiveVectorTraits_8h-source.html#l00077">maximizing()</a>.
</div>
</div><p>
<a class="anchor" name="b76148b68b28d41600065b9d82e815b5"></a><!-- doxytag: member="moeoObjectiveVectorTraits::maximizing" ref="b76148b68b28d41600065b9d82e815b5" args="(unsigned _i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool moeoObjectiveVectorTraits::maximizing </td>
<td>(</td>
<td class="paramtype">unsigned&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="moeoObjectiveVectorTraits_8h-source.html#l00077">77</a> of file <a class="el" href="moeoObjectiveVectorTraits_8h-source.html">moeoObjectiveVectorTraits.h</a>.
<p>
References <a class="el" href="moeoObjectiveVectorTraits_8h-source.html#l00065">minimizing()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoObjectiveVectorTraits_8h-source.html">moeoObjectiveVectorTraits.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 17 16:53:22 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>
Reference in a new issue View git blame Copy permalink