nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-eo/doc/html/classeo_int_interval.html
legrand c3aec878e5 Paradiseo-eo sources added 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-12 14:49:08 +00:00

186 lines
12 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>EO: eoIntInterval 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&nbsp;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&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>eoIntInterval Class Reference</h1>fully bounded eoIntBound == interval
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_int_bounds_8h-source.html">eoIntBounds.h</a>&gt;</code>
<p>
<p>Inheritance diagram for eoIntInterval:
<p><center><img src="classeo_int_interval.png" usemap="#eoIntInterval_map" border="0" alt=""></center>
<map name="eoIntInterval_map">
<area href="classeo_int_bounds.html" alt="eoIntBounds" shape="rect" coords="0,112,81,136">
<area href="classeo_persistent.html" alt="eoPersistent" shape="rect" coords="0,56,81,80">
<area href="classeo_printable.html" alt="eoPrintable" shape="rect" coords="0,0,81,24">
</map>
<a href="classeo_int_interval-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="a1" doxytag="eoIntInterval::eoIntInterval"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a1">eoIntInterval</a> (long int _min=0, long int _max=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple bounds = minimum and maximum (allowed). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="eoIntInterval::minimum"></a>
virtual long int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a2">minimum</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a3" doxytag="eoIntInterval::maximum"></a>
virtual long int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a3">maximum</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a4" doxytag="eoIntInterval::range"></a>
virtual long int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a4">range</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a5" doxytag="eoIntInterval::isBounded"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a5">isBounded</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a6" doxytag="eoIntInterval::hasNoBoundAtAll"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a6">hasNoBoundAtAll</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a7" doxytag="eoIntInterval::isMinBounded"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a7">isMinBounded</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a8" doxytag="eoIntInterval::isMaxBounded"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a8">isMaxBounded</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a9" doxytag="eoIntInterval::uniform"></a>
virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a9">uniform</a> (<a class="el" href="classeo_rng.html">eoRng</a> &amp;_rng=eo::rng) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random generator of uniform numbers in bounds uses same naming convention than eo::rng ::exception if unbounded <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="eoIntInterval::random"></a>
virtual long int&nbsp;</td><td class="memItemRight" valign="bottom"><b>random</b> (<a class="el" href="classeo_rng.html">eoRng</a> &amp;_rng=eo::rng) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="eoIntInterval::isInBounds"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a11">isInBounds</a> (double _r) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a12" doxytag="eoIntInterval::foldsInBounds"></a>
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a12">foldsInBounds</a> (double &amp;_r) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a13" doxytag="eoIntInterval::truncate"></a>
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a13">truncate</a> (double &amp;_r) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a14">readFrom</a> (std::istream &amp;_is)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read object. <a href="#a14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a15">printOn</a> (std::ostream &amp;_os) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write object. <a href="#a15"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a16" doxytag="eoIntInterval::dup"></a>
virtual <a class="el" href="classeo_int_bounds.html">eoIntBounds</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_int_interval.html#a16">dup</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for memory managements - ugly <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="eoIntInterval::repMinimum"></a>
long int&nbsp;</td><td class="memItemRight" valign="bottom"><b>repMinimum</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r1" doxytag="eoIntInterval::repMaximum"></a>
long int&nbsp;</td><td class="memItemRight" valign="bottom"><b>repMaximum</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r2" doxytag="eoIntInterval::repRange"></a>
long int&nbsp;</td><td class="memItemRight" valign="bottom"><b>repRange</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
fully bounded eoIntBound == interval
<p>
<p>
Definition at line <a class="el" href="eo_int_bounds_8h-source.html#l00223">223</a> of file <a class="el" href="eo_int_bounds_8h-source.html">eoIntBounds.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a14" doxytag="eoIntInterval::readFrom"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void eoIntInterval::readFrom </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">std::istream &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>_is</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Read object.
<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>_is</em>&nbsp;</td><td>A std::istream. but reading should not be done here, because of bound problems see eoIntVectorBounds </td></tr>
</table>
</dl>
<p>
Implements <a class="el" href="classeo_persistent.html#a1">eoPersistent</a>.
<p>
Definition at line <a class="el" href="eo_int_bounds_8h-source.html#l00315">315</a> of file <a class="el" href="eo_int_bounds_8h-source.html">eoIntBounds.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a15" doxytag="eoIntInterval::printOn"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void eoIntInterval::printOn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">std::ostream &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>_os</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write object.
<p>
It's called printOn since it prints the object on a stream. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_os</em>&nbsp;</td><td>A std::ostream. </td></tr>
</table>
</dl>
<p>
Implements <a class="el" href="classeo_printable.html#a1">eoPrintable</a>.
<p>
Definition at line <a class="el" href="eo_int_bounds_8h-source.html#l00324">324</a> of file <a class="el" href="eo_int_bounds_8h-source.html">eoIntBounds.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="eo_int_bounds_8h-source.html">eoIntBounds.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:50 2006 for EO by&nbsp;
<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>
Reference in a new issue View git blame Copy permalink