paradiseo/trunk/paradiseo-mo/docs/man/man3/moEasyCoolSched.3
jboisson 4b78cb81fc Mise à jour de la doc avec les liens vers paradiseo-eo
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@107 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-21 10:03:26 +00:00

90 lines
1.9 KiB
Groff

.TH "moEasyCoolSched" 3 "21 Dec 2006" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moEasyCoolSched \- One of the possible \fBmoCoolSched\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moEasyCoolSched.h>\fP
.PP
Inherits \fBmoCoolSched\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoEasyCoolSched\fP (double __threshold, double __ratio)"
.br
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (double &__temp)"
.br
.RI "\fIFunction which proceeds to the cooling. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "double \fBthreshold\fP"
.br
.RI "\fIThe temperature threhold. \fP"
.ti -1c
.RI "double \fBratio\fP"
.br
.RI "\fIThe decreasing factor of the temperature. \fP"
.in -1c
.SH "Detailed Description"
.PP
One of the possible \fBmoCoolSched\fP.
The simpliest, the temperature decrease according to a ratio until it greater than a threshold.
.PP
Definition at line 22 of file moEasyCoolSched.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "moEasyCoolSched::moEasyCoolSched (double __threshold, double __ratio)\fC [inline]\fP"
.PP
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__threshold\fP the threshold.
.br
\fI__ratio\fP the ratio used to descrease the temperature.
.RE
.PP
.PP
Definition at line 31 of file moEasyCoolSched.h.
.SH "Member Function Documentation"
.PP
.SS "bool moEasyCoolSched::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
Function which proceeds to the cooling.
.PP
Decrease the temperature and indicates if it is greater than the threshold.
.PP
\fBParameters:\fP
.RS 4
\fI__temp\fP the current temperature.
.RE
.PP
\fBReturns:\fP
.RS 4
if the new temperature (current temperature * ratio) is greater than the threshold.
.RE
.PP
.PP
Implements \fBeoUF< double &, bool >\fP.
.PP
Definition at line 44 of file moEasyCoolSched.h.
.PP
References ratio, and threshold.
.SH "Author"
.PP
Generated automatically by Doxygen for PARADISEO-MO from the source code.