350bdfc7de
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1277 331e1502-861f-0410-8da2-ba01fb791d7f
128 lines
3.3 KiB
Groff
128 lines
3.3 KiB
Groff
.TH "moBestImprSelect" 3 "16 Jan 2008" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
moBestImprSelect \- One of the possible \fBmoMoveSelect\fP.
|
|
|
|
.PP
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <moBestImprSelect.h>\fP
|
|
.PP
|
|
Inherits \fBmoMoveSelect< M >< M >\fP.
|
|
.PP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "typedef M::EOType::Fitness \fBFitness\fP"
|
|
.br
|
|
.RI "\fIAlias for the fitness. \fP"
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "void \fBinit\fP (const \fBFitness\fP &_fitness)"
|
|
.br
|
|
.RI "\fIProcedure which initialise the exploration. \fP"
|
|
.ti -1c
|
|
.RI "bool \fBupdate\fP (const M &_move, const \fBFitness\fP &_fitness)"
|
|
.br
|
|
.RI "\fI\fBFunction\fP that indicates if the current move has not improved the fitness. \fP"
|
|
.ti -1c
|
|
.RI "void \fBoperator()\fP (M &_move, \fBFitness\fP &_fitness)"
|
|
.br
|
|
.RI "\fIProcedure which saved the best move and fitness. \fP"
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBfirst_time\fP"
|
|
.br
|
|
.RI "\fIAllowing to know if at least one move has been generated. \fP"
|
|
.ti -1c
|
|
.RI "M \fBbest_move\fP"
|
|
.br
|
|
.RI "\fIThe best move. \fP"
|
|
.ti -1c
|
|
.RI "\fBFitness\fP \fBbest_fitness\fP"
|
|
.br
|
|
.RI "\fIThe best fitness. \fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<class M> class moBestImprSelect< M >"
|
|
One of the possible \fBmoMoveSelect\fP.
|
|
|
|
All neighbors are considered, and the movement which enables the best improvement is selected.
|
|
.PP
|
|
Definition at line 47 of file moBestImprSelect.h.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<class M> void \fBmoBestImprSelect\fP< M >::init (const \fBFitness\fP & _fitness)\fC [inline, virtual]\fP"
|
|
.PP
|
|
Procedure which initialise the exploration.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI_fitness\fP The current fitness.
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBmoMoveSelect< M >\fP.
|
|
.PP
|
|
Definition at line 58 of file moBestImprSelect.h.
|
|
.PP
|
|
References moBestImprSelect< M >::first_time.
|
|
.SS "template<class M> bool \fBmoBestImprSelect\fP< M >::update (const M & _move, const \fBFitness\fP & _fitness)\fC [inline, virtual]\fP"
|
|
.PP
|
|
\fBFunction\fP that indicates if the current move has not improved the fitness.
|
|
.PP
|
|
If the given fitness enables an improvment, the move (\fBmoMove\fP) and the fitness linked to this move are saved.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI_move\fP a move.
|
|
.br
|
|
\fI_fitness\fP a fitness linked to the move.
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
TRUE if the move does not improve the fitness.
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBmoMoveSelect< M >\fP.
|
|
.PP
|
|
Definition at line 76 of file moBestImprSelect.h.
|
|
.PP
|
|
References moBestImprSelect< M >::best_fitness, moBestImprSelect< M >::best_move, and moBestImprSelect< M >::first_time.
|
|
.SS "template<class M> void \fBmoBestImprSelect\fP< M >::operator() (M & _move, \fBFitness\fP & _fitness)\fC [inline, virtual]\fP"
|
|
.PP
|
|
Procedure which saved the best move and fitness.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fI_move\fP the current move (result of the procedure).
|
|
.br
|
|
\fI_fitness\fP the current fitness (result of the procedure).
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
|
|
.PP
|
|
Definition at line 94 of file moBestImprSelect.h.
|
|
.PP
|
|
References moBestImprSelect< M >::best_fitness, moBestImprSelect< M >::best_move, and moBestImprSelect< M >::first_time.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.
|