c3aec878e5
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
122 lines
12 KiB
HTML
122 lines
12 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>EO: eoGeneralRealBounds Class Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3.9.1 -->
|
|
<div class="qindex"> <form class="search" action="search.php" method="get">
|
|
<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
|
|
<h1>eoGeneralRealBounds Class Reference</h1>A class that encapsulate all possible <a class="el" href="classeo_int_bounds.html">eoIntBounds</a>.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="eo_real_bounds_8h-source.html">eoRealBounds.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for eoGeneralRealBounds:
|
|
<p><center><img src="classeo_general_real_bounds.png" usemap="#eoGeneralRealBounds_map" border="0" alt=""></center>
|
|
<map name="eoGeneralRealBounds_map">
|
|
<area href="classeo_real_bounds.html" alt="eoRealBounds" shape="rect" coords="0,112,138,136">
|
|
<area href="classeo_persistent.html" alt="eoPersistent" shape="rect" coords="0,56,138,80">
|
|
<area href="classeo_printable.html" alt="eoPrintable" shape="rect" coords="0,0,138,24">
|
|
</map>
|
|
<a href="classeo_general_real_bounds-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"><a class="anchor" name="a0" doxytag="eoGeneralRealBounds::eoGeneralRealBounds"></a>
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a0">eoGeneralRealBounds</a> (std::string _s="[-infinity,+infinity]")</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ctor: from a string, chooses the type of bound. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="eoGeneralRealBounds::eoGeneralRealBounds"></a>
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a1">eoGeneralRealBounds</a> (const <a class="el" href="classeo_general_real_bounds.html">eoGeneralRealBounds</a> &_b)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Need a Cpy Ctor because we are allocating memory. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="eoGeneralRealBounds::operator="></a>
|
|
<a class="el" href="classeo_general_real_bounds.html">eoGeneralRealBounds</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classeo_general_real_bounds.html">eoGeneralRealBounds</a> &_b)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="eoGeneralRealBounds::~eoGeneralRealBounds"></a>
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a3">~eoGeneralRealBounds</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Need a Dtor because we allocate an actual bound. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="eoGeneralRealBounds::isBounded"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a4">isBounded</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-Test: true if ***both*** a min and a max. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="eoGeneralRealBounds::hasNoBoundAtAll"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a5">hasNoBoundAtAll</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-Test: true if no min ***and*** no max hence no further need to test/truncate/fold anything. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="eoGeneralRealBounds::isMinBounded"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a6">isMinBounded</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-Test: bounded from below??? <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="eoGeneralRealBounds::isMaxBounded"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a7">isMaxBounded</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-Test: bounded from above??? <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="eoGeneralRealBounds::isInBounds"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a8">isInBounds</a> (double _x) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test on a value: is it in bounds? <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="eoGeneralRealBounds::foldsInBounds"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a9">foldsInBounds</a> (double &_x) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put value back into bounds - by folding back and forth. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="eoGeneralRealBounds::truncate"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a10">truncate</a> (double &_x) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put value back into bounds - by truncating to a boundary value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="eoGeneralRealBounds::minimum"></a>
|
|
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a11">minimum</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get minimum value ::exception if does not exist <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12" doxytag="eoGeneralRealBounds::maximum"></a>
|
|
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a12">maximum</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get maximum value ::exception if does not exist <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="eoGeneralRealBounds::range"></a>
|
|
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a13">range</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">get range ::exception if unbounded <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="eoGeneralRealBounds::uniform"></a>
|
|
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a14">uniform</a> (<a class="el" href="classeo_rng.html">eoRng</a> &_rng=eo::rng) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">random generator of uniform numbers in bounds ::exception if unbounded <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15" doxytag="eoGeneralRealBounds::dup"></a>
|
|
virtual <a class="el" href="classeo_real_bounds.html">eoRealBounds</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a15">dup</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">for memory managements - ugly <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a16" doxytag="eoGeneralRealBounds::theBounds"></a>
|
|
const <a class="el" href="classeo_real_bounds.html">eoRealBounds</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a16">theBounds</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">for efficiency, it's better to use the embedded boud directly <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a17" doxytag="eoGeneralRealBounds::printOn"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a17">printOn</a> (std::ostream &_os) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">don't forget the printOn method - again that of the embedded bound <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18" doxytag="eoGeneralRealBounds::readFrom"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#a18">readFrom</a> (std::istream &_is)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">no readFrom ??? Have to check that later <br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0" doxytag="eoGeneralRealBounds::getBoundsFromString"></a>
|
|
<a class="el" href="classeo_real_bounds.html">eoRealBounds</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_general_real_bounds.html#d0">getBoundsFromString</a> (std::string)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">the constructor for eoGeneralRealBound - from a string very similar to the <a class="el" href="classeo_real_vector_bounds.html#a7">eoRealVectorBounds::readFrom</a> above but was written much later so the readFrom does not call this one as it should do <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="r0" doxytag="eoGeneralRealBounds::repBound"></a>
|
|
<a class="el" href="classeo_real_bounds.html">eoRealBounds</a> * </td><td class="memItemRight" valign="bottom"><b>repBound</b></td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
A class that encapsulate all possible <a class="el" href="classeo_int_bounds.html">eoIntBounds</a>.
|
|
<p>
|
|
Mandatory in order to read through the parser
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="eo_real_bounds_8h-source.html#l00506">506</a> of file <a class="el" href="eo_real_bounds_8h-source.html">eoRealBounds.h</a>.<hr>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="eo_real_bounds_8h-source.html">eoRealBounds.h</a><li><a class="el" href="eo_real_bounds_8cpp-source.html">eoRealBounds.cpp</a></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:49 2006 for EO by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
|
|
</body>
|
|
</html>
|