nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Paradiseo-eo sources added

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2006-12-12 14:49:08 +00:00
commit c3aec878e5
3609 changed files with 342772 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

129
trunk/paradiseo-eo/doc/man/man3/eoIntBelowBound.3 Normal file
View file

@ -0,0 +1,129 @@
.TH "eoIntBelowBound" 3 "19 Oct 2006" "Version 0.9.4-cvs" "EO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eoIntBelowBound \- an eoIntBound bounded from below only
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <eoIntBounds.h>\fP
.PP
Inherits \fBeoIntBounds\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBeoIntBelowBound\fP (long int _min=0)"
.br
.RI "\fISimple bounds = minimum. \fP"
.ti -1c
.RI "virtual long int \fBminimum\fP () const "
.br
.RI "\fIget minimum value ::exception if does not exist \fP"
.ti -1c
.RI "virtual long int \fBmaximum\fP () const "
.br
.RI "\fIget maximum value ::exception if does not exist \fP"
.ti -1c
.RI "virtual long int \fBrange\fP () const "
.br
.RI "\fIget range ::exception if unbounded \fP"
.ti -1c
.RI "virtual double \fBuniform\fP (\fBeoRng\fP &_rng=eo::rng) const "
.br
.RI "\fIrandom generator of uniform numbers in bounds uses same naming convention than eo::rng ::exception if unbounded \fP"
.ti -1c
.RI "virtual long int \fBrandom\fP (\fBeoRng\fP &_rng=eo::rng) const "
.br
.ti -1c
.RI "virtual bool \fBisBounded\fP (void) const "
.br
.RI "\fISelf-Test: true if ***both*** a min and a max. \fP"
.ti -1c
.RI "virtual bool \fBhasNoBoundAtAll\fP (void) const "
.br
.RI "\fISelf-Test: true if no min ***and*** no max hence no further need to test/truncate/fold anything. \fP"
.ti -1c
.RI "virtual bool \fBisMinBounded\fP (void) const "
.br
.RI "\fISelf-Test: bounded from below??? \fP"
.ti -1c
.RI "virtual bool \fBisMaxBounded\fP (void) const "
.br
.RI "\fISelf-Test: bounded from above??? \fP"
.ti -1c
.RI "virtual bool \fBisInBounds\fP (double _r) const "
.br
.RI "\fITest on a value: is it in bounds? \fP"
.ti -1c
.RI "virtual void \fBfoldsInBounds\fP (double &_r) const "
.br
.RI "\fIPut value back into bounds - by folding back and forth. \fP"
.ti -1c
.RI "virtual void \fBtruncate\fP (double &_r) const "
.br
.RI "\fIPut value back into bounds - by truncating to a boundary value. \fP"
.ti -1c
.RI "virtual void \fBreadFrom\fP (std::istream &_is)"
.br
.RI "\fIRead object. \fP"
.ti -1c
.RI "virtual void \fBprintOn\fP (std::ostream &_os) const "
.br
.RI "\fIWrite object. \fP"
.ti -1c
.RI "virtual \fBeoIntBounds\fP * \fBdup\fP () const "
.br
.RI "\fIfor memory managements - ugly \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "long int \fBrepMinimum\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
an eoIntBound bounded from below only
.PP
Definition at line 344 of file eoIntBounds.h.
.SH "Member Function Documentation"
.PP
.SS "virtual void eoIntBelowBound::readFrom (std::istream & _is)\fC [inline, virtual]\fP"
.PP
Read object.
.PP
\fBParameters:\fP
.RS 4
\fI_is\fP A std::istream. but reading should not be done here, because of bound problems see eoIntVectorBounds
.RE
.PP
.PP
Implements \fBeoPersistent\fP.
.PP
Definition at line 414 of file eoIntBounds.h.
.SS "virtual void eoIntBelowBound::printOn (std::ostream & _os) const\fC [inline, virtual]\fP"
.PP
Write object.
.PP
It's called printOn since it prints the object on a stream.
.PP
\fBParameters:\fP
.RS 4
\fI_os\fP A std::ostream.
.RE
.PP
.PP
Implements \fBeoPrintable\fP.
.PP
Definition at line 423 of file eoIntBounds.h.
.SH "Author"
.PP
Generated automatically by Doxygen for EO from the source code.