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

completed doc

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@665 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2007-10-08 09:41:23 +00:00
commit abc68c9e88
184 changed files with 13542 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

34
trunk/paradiseo-peo/doc/man/man3/DisplayBestRoute.3 Normal file
View file

@ -0,0 +1,34 @@
.TH "DisplayBestRoute" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DisplayBestRoute \-
.SH SYNOPSIS
.br
.PP
Inherits \fBeoUpdater\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDisplayBestRoute\fP (\fBeoPop\fP< \fBRoute\fP > &__pop)"
.br
.ti -1c
.RI "void \fBoperator()\fP ()"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBeoPop\fP< \fBRoute\fP > & \fBpop\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line 46 of file display_best_route.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

24
trunk/paradiseo-peo/doc/man/man3/MergeRouteEval.3 Normal file
View file

@ -0,0 +1,24 @@
.TH "MergeRouteEval" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MergeRouteEval \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoAggEvalFunc< EOT >< eoVector< int, Node > >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBoperator()\fP (\fBRoute\fP &__route, const int &__part_fit)"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line 44 of file merge_route_eval.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

35
trunk/paradiseo-peo/doc/man/man3/RandomExplorationAlgorithm.3 Normal file
View file

@ -0,0 +1,35 @@
.TH "RandomExplorationAlgorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
RandomExplorationAlgorithm \-
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBRandomExplorationAlgorithm\fP (\fBpeoPopEval\fP< \fBRoute\fP > &__popEval, \fBpeoSynchronousMultiStart\fP< \fBRoute\fP > &extParallelExecution)"
.br
.ti -1c
.RI "void \fBoperator()\fP ()"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBpeoPopEval\fP< \fBRoute\fP > & \fBpopEval\fP"
.br
.ti -1c
.RI "\fBpeoSynchronousMultiStart\fP< \fBRoute\fP > & \fBparallelExecution\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line 56 of file LessonParallelAlgorithm/main.cpp.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

53
trunk/paradiseo-peo/doc/man/man3/peoParallelAlgorithmWrapper.3 Normal file
View file

@ -0,0 +1,53 @@
.TH "peoParallelAlgorithmWrapper" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoParallelAlgorithmWrapper \-
.SH SYNOPSIS
.br
.PP
Inherits \fBRunner\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "template<typename AlgorithmType> \fBpeoParallelAlgorithmWrapper\fP (AlgorithmType &externalAlgorithm)"
.br
.ti -1c
.RI "template<typename AlgorithmType, typename AlgorithmDataType> \fBpeoParallelAlgorithmWrapper\fP (AlgorithmType &externalAlgorithm, AlgorithmDataType &externalData)"
.br
.ti -1c
.RI "\fB~peoParallelAlgorithmWrapper\fP ()"
.br
.ti -1c
.RI "void \fBrun\fP ()"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBAbstractAlgorithm\fP * \fBalgorithm\fP"
.br
.in -1c
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBAbstractAlgorithm\fP"
.br
.ti -1c
.RI "struct \fBAlgorithm\fP"
.br
.ti -1c
.RI "struct \fBAlgorithm< AlgorithmType, void >\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line 47 of file peoParallelAlgorithmWrapper.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

27
trunk/paradiseo-peo/doc/man/man3/peoParallelAlgorithmWrapper_AbstractAlgorithm.3 Normal file
View file

@ -0,0 +1,27 @@
.TH "peoParallelAlgorithmWrapper::AbstractAlgorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoParallelAlgorithmWrapper::AbstractAlgorithm \-
.SH SYNOPSIS
.br
.PP
Inherited by \fBpeoParallelAlgorithmWrapper::Algorithm< AlgorithmType, AlgorithmDataType >\fP, and \fBpeoParallelAlgorithmWrapper::Algorithm< AlgorithmType, void >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual \fB~AbstractAlgorithm\fP ()"
.br
.ti -1c
.RI "virtual void \fBoperator()\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line 71 of file peoParallelAlgorithmWrapper.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

41
trunk/paradiseo-peo/doc/man/man3/peoParallelAlgorithmWrapper_Algorithm.3 Normal file
View file

@ -0,0 +1,41 @@
.TH "peoParallelAlgorithmWrapper::Algorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoParallelAlgorithmWrapper::Algorithm \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoParallelAlgorithmWrapper::AbstractAlgorithm\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAlgorithm\fP (AlgorithmType &externalAlgorithm, AlgorithmDataType &externalData)"
.br
.ti -1c
.RI "virtual void \fBoperator()\fP ()"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "AlgorithmType & \fBalgorithm\fP"
.br
.ti -1c
.RI "AlgorithmDataType & \fBalgorithmData\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename AlgorithmType, typename AlgorithmDataType> struct peoParallelAlgorithmWrapper::Algorithm< AlgorithmType, AlgorithmDataType >"
.PP
Definition at line 81 of file peoParallelAlgorithmWrapper.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

38
trunk/paradiseo-peo/doc/man/man3/peoParallelAlgorithmWrapper_Algorithm_ AlgorithmType, void _.3 Normal file
View file

@ -0,0 +1,38 @@
.TH "peoParallelAlgorithmWrapper::Algorithm< AlgorithmType, void >" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoParallelAlgorithmWrapper::Algorithm< AlgorithmType, void > \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoParallelAlgorithmWrapper::AbstractAlgorithm\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAlgorithm\fP (AlgorithmType &externalAlgorithm)"
.br
.ti -1c
.RI "virtual void \fBoperator()\fP ()"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "AlgorithmType & \fBalgorithm\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename AlgorithmType> struct peoParallelAlgorithmWrapper::Algorithm< AlgorithmType, void >"
.PP
Definition at line 95 of file peoParallelAlgorithmWrapper.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

117
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart.3 Normal file
View file

@ -0,0 +1,117 @@
.TH "peoSynchronousMultiStart" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart \-
.SH SYNOPSIS
.br
.PP
Inherits \fBService\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "template<typename AlgorithmType> \fBpeoSynchronousMultiStart\fP (AlgorithmType &externalAlgorithm)"
.br
.ti -1c
.RI "template<typename AlgorithmType, typename AggregationFunctionType> \fBpeoSynchronousMultiStart\fP (std::vector< AlgorithmType * > &externalAlgorithms, AggregationFunctionType &externalAggregationFunction)"
.br
.ti -1c
.RI "\fB~peoSynchronousMultiStart\fP ()"
.br
.ti -1c
.RI "template<typename Type> void \fBoperator()\fP (Type &externalData)"
.br
.ti -1c
.RI "template<typename Type> void \fBoperator()\fP (const Type &externalDataBegin, const Type &externalDataEnd)"
.br
.ti -1c
.RI "void \fBpackData\fP ()"
.br
.ti -1c
.RI "void \fBunpackData\fP ()"
.br
.ti -1c
.RI "void \fBexecute\fP ()"
.br
.ti -1c
.RI "void \fBpackResult\fP ()"
.br
.ti -1c
.RI "void \fBunpackResult\fP ()"
.br
.ti -1c
.RI "void \fBnotifySendingData\fP ()"
.br
.ti -1c
.RI "void \fBnotifySendingAllResourceRequests\fP ()"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBAbstractAlgorithm\fP * \fBsingularAlgorithm\fP"
.br
.ti -1c
.RI "std::vector< \fBAbstractAlgorithm\fP * > \fBalgorithms\fP"
.br
.ti -1c
.RI "\fBAbstractAggregationAlgorithm\fP * \fBaggregationFunction\fP"
.br
.ti -1c
.RI "EntityType \fBentityTypeInstance\fP"
.br
.ti -1c
.RI "std::vector< \fBAbstractDataType\fP * > \fBdata\fP"
.br
.ti -1c
.RI "unsigned \fBidx\fP"
.br
.ti -1c
.RI "unsigned \fBnum_term\fP"
.br
.ti -1c
.RI "unsigned \fBdataIndex\fP"
.br
.ti -1c
.RI "unsigned \fBfunctionIndex\fP"
.br
.in -1c
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBAbstractAggregationAlgorithm\fP"
.br
.ti -1c
.RI "struct \fBAbstractAlgorithm\fP"
.br
.ti -1c
.RI "struct \fBAbstractDataType\fP"
.br
.ti -1c
.RI "struct \fBAggregationAlgorithm\fP"
.br
.ti -1c
.RI "struct \fBAlgorithm\fP"
.br
.ti -1c
.RI "struct \fBDataType\fP"
.br
.ti -1c
.RI "struct \fBNoAggregationFunction\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType> class peoSynchronousMultiStart< EntityType >"
.PP
Definition at line 45 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

31
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_AbstractAggregationAlgorithm.3 Normal file
View file

@ -0,0 +1,31 @@
.TH "peoSynchronousMultiStart::AbstractAggregationAlgorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::AbstractAggregationAlgorithm \-
.SH SYNOPSIS
.br
.PP
Inherited by \fBpeoSynchronousMultiStart< EntityType >::AggregationAlgorithm< AggregationAlgorithmType >\fP, and \fBpeoSynchronousMultiStart< EntityType >::NoAggregationFunction\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual \fB~AbstractAggregationAlgorithm\fP ()"
.br
.ti -1c
.RI "virtual void \fBoperator()\fP (\fBAbstractDataType\fP &dataTypeInstanceA, \fBAbstractDataType\fP &dataTypeInstanceB)"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType> struct peoSynchronousMultiStart< EntityType >::AbstractAggregationAlgorithm"
.PP
Definition at line 157 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

31
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_AbstractAlgorithm.3 Normal file
View file

@ -0,0 +1,31 @@
.TH "peoSynchronousMultiStart::AbstractAlgorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::AbstractAlgorithm \-
.SH SYNOPSIS
.br
.PP
Inherited by \fBpeoSynchronousMultiStart< EntityType >::Algorithm< AlgorithmType >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual \fB~AbstractAlgorithm\fP ()"
.br
.ti -1c
.RI "virtual void \fBoperator()\fP (\fBAbstractDataType\fP &dataTypeInstance)"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType> struct peoSynchronousMultiStart< EntityType >::AbstractAlgorithm"
.PP
Definition at line 139 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

31
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_AbstractDataType.3 Normal file
View file

@ -0,0 +1,31 @@
.TH "peoSynchronousMultiStart::AbstractDataType" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::AbstractDataType \-
.SH SYNOPSIS
.br
.PP
Inherited by \fBpeoSynchronousMultiStart< EntityType >::DataType< Type >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual \fB~AbstractDataType\fP ()"
.br
.ti -1c
.RI "template<typename Type> \fBoperator Type &\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType> struct peoSynchronousMultiStart< EntityType >::AbstractDataType"
.PP
Definition at line 122 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

38
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_AggregationAlgorithm.3 Normal file
View file

@ -0,0 +1,38 @@
.TH "peoSynchronousMultiStart::AggregationAlgorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::AggregationAlgorithm \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoSynchronousMultiStart< EntityType >::AbstractAggregationAlgorithm\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAggregationAlgorithm\fP (AggregationAlgorithmType &externalAggregationAlgorithm)"
.br
.ti -1c
.RI "void \fBoperator()\fP (\fBAbstractDataType\fP &dataTypeInstanceA, \fBAbstractDataType\fP &dataTypeInstanceB)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "AggregationAlgorithmType & \fBaggregationAlgorithm\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType>template<typename AggregationAlgorithmType> struct peoSynchronousMultiStart< EntityType >::AggregationAlgorithm< AggregationAlgorithmType >"
.PP
Definition at line 164 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

38
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_Algorithm.3 Normal file
View file

@ -0,0 +1,38 @@
.TH "peoSynchronousMultiStart::Algorithm" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::Algorithm \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoSynchronousMultiStart< EntityType >::AbstractAlgorithm\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAlgorithm\fP (AlgorithmType &externalAlgorithm)"
.br
.ti -1c
.RI "void \fBoperator()\fP (\fBAbstractDataType\fP &dataTypeInstance)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "AlgorithmType & \fBalgorithm\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType>template<typename AlgorithmType> struct peoSynchronousMultiStart< EntityType >::Algorithm< AlgorithmType >"
.PP
Definition at line 146 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

35
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_DataType.3 Normal file
View file

@ -0,0 +1,35 @@
.TH "peoSynchronousMultiStart::DataType" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::DataType \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoSynchronousMultiStart< EntityType >::AbstractDataType\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDataType\fP (Type &externalData)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "Type & \fBdata\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType>template<typename Type> struct peoSynchronousMultiStart< EntityType >::DataType< Type >"
.PP
Definition at line 132 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.

28
trunk/paradiseo-peo/doc/man/man3/peoSynchronousMultiStart_NoAggregationFunction.3 Normal file
View file

@ -0,0 +1,28 @@
.TH "peoSynchronousMultiStart::NoAggregationFunction" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-PEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
peoSynchronousMultiStart::NoAggregationFunction \-
.SH SYNOPSIS
.br
.PP
Inherits \fBpeoSynchronousMultiStart< EntityType >::AbstractAggregationAlgorithm\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBoperator()\fP (\fBAbstractDataType\fP &dataTypeInstanceA, \fBAbstractDataType\fP &dataTypeInstanceB)"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EntityType> struct peoSynchronousMultiStart< EntityType >::NoAggregationFunction"
.PP
Definition at line 176 of file peoSynchronousMultiStart.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-PEOMovingObjects from the source code.