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

New docs are included

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@882 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2008-01-15 16:06:58 +00:00
commit 6f2c04931b
285 changed files with 27160 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

83
trunk/paradiseo-mo/doc/man/man3/moLSCheckPoint.3 Normal file
View file

@ -0,0 +1,83 @@
.TH "moLSCheckPoint" 3 "15 Jan 2008" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moLSCheckPoint \- Class which allows a checkpointing system.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moLSCheckPoint.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType &, void >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBoperator()\fP (const M &_move, const typename M::EOType &_solution)"
.br
.RI "\fI\fBFunction\fP which launches the checkpointing. \fP"
.ti -1c
.RI "void \fBadd\fP (\fBeoBF\fP< const M &, const typename M::EOType &, void > &_function)"
.br
.RI "\fIProcedure which add a new function to the function vector. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::vector< \fBeoBF\fP< const M &, const typename M::EOType &, void > * > \fBfunctions\fP"
.br
.RI "\fIVector of functions. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moLSCheckPoint< M >"
Class which allows a checkpointing system.
Thanks to this class, at each iteration, additionnal function can be used (and not only one).
.PP
Definition at line 46 of file moLSCheckPoint.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> void \fBmoLSCheckPoint\fP< M >::operator() (const M & _move, const typename M::EOType & _solution)\fC [inline]\fP"
.PP
\fBFunction\fP which launches the checkpointing.
.PP
Each saved function is used on the current move and the current solution.
.PP
\fBParameters:\fP
.RS 4
\fI_move\fP a move.
.br
\fI_solution\fP a solution.
.RE
.PP
.PP
Definition at line 57 of file moLSCheckPoint.h.
.PP
References moLSCheckPoint< M >::functions.
.SS "template<class M> void \fBmoLSCheckPoint\fP< M >::add (\fBeoBF\fP< const M &, const typename M::EOType &, void > & _function)\fC [inline]\fP"
.PP
Procedure which add a new function to the function vector.
.PP
The new function is added at the end of the vector.
.PP
\fBParameters:\fP
.RS 4
\fI_function\fP a new function to add.
.RE
.PP
.PP
Definition at line 72 of file moLSCheckPoint.h.
.PP
References moLSCheckPoint< M >::functions.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.