350bdfc7de
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1277 331e1502-861f-0410-8da2-ba01fb791d7f
105 lines
2.7 KiB
Groff
105 lines
2.7 KiB
Groff
.TH "moGenSolContinue" 3 "16 Jan 2008" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
moGenSolContinue \- One possible stop criterion for a solution-based heuristic.
|
|
|
|
.PP
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <moGenSolContinue.h>\fP
|
|
.PP
|
|
Inherits \fBmoSolContinue< EOT >< EOT >\fP.
|
|
.PP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBmoGenSolContinue\fP (unsigned int _generationMaximumNumber)"
|
|
.br
|
|
.RI "\fISimple constructor. \fP"
|
|
.ti -1c
|
|
.RI "bool \fBoperator()\fP (const EOT &_solution)"
|
|
.br
|
|
.RI "\fI\fBFunction\fP that activates the stop criterion. \fP"
|
|
.ti -1c
|
|
.RI "void \fBinit\fP ()"
|
|
.br
|
|
.RI "\fIProcedure which allows to initialise the generation counter. \fP"
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "unsigned int \fBgenerationMaximumNumber\fP"
|
|
.br
|
|
.RI "\fIIteration maximum number. \fP"
|
|
.ti -1c
|
|
.RI "unsigned int \fBgenerationNumber\fP"
|
|
.br
|
|
.RI "\fIIteration current number. \fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<class EOT> class moGenSolContinue< EOT >"
|
|
One possible stop criterion for a solution-based heuristic.
|
|
|
|
The stop criterion corresponds to a maximum number of iteration.
|
|
.PP
|
|
Definition at line 46 of file moGenSolContinue.h.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<class EOT> \fBmoGenSolContinue\fP< EOT >::\fBmoGenSolContinue\fP (unsigned int _generationMaximumNumber)\fC [inline]\fP"
|
|
.PP
|
|
Simple constructor.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI_generationMaximumNumber\fP The maximum number of generations.
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Definition at line 54 of file moGenSolContinue.h.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & _solution)\fC [inline, virtual]\fP"
|
|
.PP
|
|
\fBFunction\fP that activates the stop criterion.
|
|
.PP
|
|
Increments the counter and returns TRUE if the current number of iteration is lower than the given maximum number of iterations.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI_solution\fP The current solution.
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true or false according to the current generation number.
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBeoUF< const EOT &, bool >\fP.
|
|
.PP
|
|
Definition at line 66 of file moGenSolContinue.h.
|
|
.PP
|
|
References moGenSolContinue< EOT >::generationMaximumNumber, and moGenSolContinue< EOT >::generationNumber.
|
|
.SS "template<class EOT> void \fBmoGenSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
|
|
.PP
|
|
Procedure which allows to initialise the generation counter.
|
|
.PP
|
|
It can also be used to reset the iteration counter.
|
|
.PP
|
|
Implements \fBmoSolContinue< EOT >\fP.
|
|
.PP
|
|
Definition at line 78 of file moGenSolContinue.h.
|
|
.PP
|
|
References moGenSolContinue< EOT >::generationNumber.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.
|