0693358307
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@582 331e1502-861f-0410-8da2-ba01fb791d7f
115 lines
3 KiB
Groff
115 lines
3 KiB
Groff
.TH "moFitSolContinue" 3 "31 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
moFitSolContinue \- One possible stop criterion for a solution-based heuristic.
|
|
|
|
.PP
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <moFitSolContinue.h>\fP
|
|
.PP
|
|
Inherits \fBmoSolContinue< EOT >< EOT >\fP.
|
|
.PP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "typedef EOT::Fitness \fBFitness\fP"
|
|
.br
|
|
.RI "\fIAlias for the fitness. \fP"
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBmoFitSolContinue\fP (\fBFitness\fP __fitness, bool __maximization=true)"
|
|
.br
|
|
.RI "\fIBasic constructor. \fP"
|
|
.ti -1c
|
|
.RI "bool \fBoperator()\fP (const EOT &__sol)"
|
|
.br
|
|
.RI "\fIFunction that activates the stopping criterion. \fP"
|
|
.ti -1c
|
|
.RI "void \fBinit\fP ()"
|
|
.br
|
|
.RI "\fIProcedure which allows to initialise all the stuff needed. \fP"
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBFitness\fP \fBfitness\fP"
|
|
.br
|
|
.RI "\fIFitness target. \fP"
|
|
.ti -1c
|
|
.RI "bool \fBmaximization\fP"
|
|
.br
|
|
.RI "\fIFlag that indicate if there is a maximization (true) or a minimization (false) of the fitness value. \fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<class EOT> class moFitSolContinue< EOT >"
|
|
One possible stop criterion for a solution-based heuristic.
|
|
|
|
The stop criterion corresponds to a fitness threshold gained.
|
|
.PP
|
|
Definition at line 21 of file moFitSolContinue.h.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<class EOT> \fBmoFitSolContinue\fP< EOT >::\fBmoFitSolContinue\fP (\fBFitness\fP __fitness, bool __maximization = \fCtrue\fP)\fC [inline]\fP"
|
|
.PP
|
|
Basic constructor.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI__fitness\fP The fitness to reach.
|
|
.br
|
|
\fI__maximization\fP Indicate if the the aim is to maximize or minimize the fitness.
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Definition at line 34 of file moFitSolContinue.h.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<class EOT> bool \fBmoFitSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
|
|
.PP
|
|
Function that activates the stopping criterion.
|
|
.PP
|
|
Indicates if the fitness threshold has not been yet reached.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI__sol\fP the current solution.
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true or false according to the value of the fitness.
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBeoUF< const EOT &, bool >\fP.
|
|
.PP
|
|
Definition at line 44 of file moFitSolContinue.h.
|
|
.PP
|
|
References moFitSolContinue< EOT >::fitness, and moFitSolContinue< EOT >::maximization.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<class EOT> bool \fBmoFitSolContinue\fP< EOT >::\fBmaximization\fP\fC [private]\fP"
|
|
.PP
|
|
Flag that indicate if there is a maximization (true) or a minimization (false) of the fitness value.
|
|
.PP
|
|
It can be interesting to know this information because some solution-based metaheuristics can generate solution with a fitness that is worse that the best known fitness (in this case, the counter is not reinitialized).
|
|
.PP
|
|
Definition at line 72 of file moFitSolContinue.h.
|
|
.PP
|
|
Referenced by moFitSolContinue< EOT >::operator()().
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for PARADISEO-MO from the source code.
|