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

Updated doc links

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@593 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2007-09-18 15:44:04 +00:00
commit 520b5a08e4
224 changed files with 3673 additions and 2476 deletions
Download patch file Download diff file Expand all files Collapse all files

30
trunk/paradiseo-mo/doc/man/man3/moGenSolContinue.3
View file

@ -1,8 +1,8 @@
.TH "moGenSolContinue" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moGenSolContinue" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moGenSolContinue \- One possible stopping criterion for a solution-based heuristic.
moGenSolContinue \- One possible stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
@ -18,7 +18,7 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.ti -1c
.RI "\fBmoGenSolContinue\fP (unsigned int __maxNumGen)"
.br
.RI "\fIBasic constructor. \fP"
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
@ -26,7 +26,7 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which allows to initialise all the stuff needed. \fP"
.RI "\fIProcedure which allows to initialise the generation counter. \fP"
.in -1c
.SS "Private Attributes"
@ -44,16 +44,16 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.PP
.SS "template<class EOT> class moGenSolContinue< EOT >"
One possible stopping criterion for a solution-based heuristic.
One possible stop criterion for a solution-based heuristic.
The stopping criterion corresponds to a maximum number of iteration.
The stop criterion corresponds to a maximum number of iteration.
.PP
Definition at line 21 of file moGenSolContinue.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOT> \fBmoGenSolContinue\fP< EOT >::\fBmoGenSolContinue\fP (unsigned int __maxNumGen)\fC [inline]\fP"
.PP
Basic constructor.
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
@ -65,11 +65,11 @@ Basic constructor.
Definition at line 30 of file moGenSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline]\fP"
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.PP
Function 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.
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
@ -78,23 +78,25 @@ Increments the counter and returns true if the current number of iteration is lo
.PP
\fBReturns:\fP
.RS 4
true or false according to the current generation number.
TRUE or FALSE according to the current generation number.
.RE
.PP
.PP
Definition at line 42 of file moGenSolContinue.h.
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 44 of file moGenSolContinue.h.
.PP
References moGenSolContinue< EOT >::maxNumGen, and moGenSolContinue< EOT >::numGen.
.SS "template<class EOT> void \fBmoGenSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise all the stuff needed.
Procedure which allows to initialise the generation counter.
.PP
It can be also used to reinitialize the counter all the needed things.
It can also be used to reset the iteration counter.
.PP
Implements \fBmoSolContinue< EOT >\fP.
.PP
Definition at line 51 of file moGenSolContinue.h.
Definition at line 54 of file moGenSolContinue.h.
.PP
References moGenSolContinue< EOT >::numGen.