update doc with new stuffs

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@496 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-07-02 14:04:20 +00:00
commit 7d6ad66977
85 changed files with 9380 additions and 1569 deletions

View file

@ -1,4 +1,4 @@
.TH "MOEO" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "MOEO" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoAchievementFitnessAssignment" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoAchievementFitnessAssignment" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoAdditiveEpsilonBinaryMetric" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoAdditiveEpsilonBinaryMetric" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoAggregativeComparator" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoAggregativeComparator" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoAlgo" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoAlgo" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,7 +10,7 @@ moeoAlgo \- Abstract class for multi-objective algorithms.
.PP
\fC#include <moeoAlgo.h>\fP
.PP
Inherited by \fBmoeoEA< MOEOT >\fP, \fBmoeoLS< MOEOT, Type >\fP, and \fBmoeoLS< MOEOT, MOEOT >\fP.
Inherited by \fBmoeoEA< MOEOT >\fP, \fBmoeoLS< MOEOT, Type >\fP, \fBmoeoLS< MOEOT, eoPop< MOEOT > & >\fP, and \fBmoeoLS< MOEOT, MOEOT >\fP.
.PP
.SH "Detailed Description"
.PP

View file

@ -1,4 +1,4 @@
.TH "moeoArchive" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoArchive" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -137,7 +137,7 @@ Definition at line 95 of file moeoArchive.h.
.PP
References moeoArchive< MOEOT >::comparator.
.PP
Referenced by moeoArchive< MOEOT >::update().
Referenced by moeoIteratedIBMOLS< MOEOT, Move >::operator()(), moeoIBMOLS< MOEOT, Move >::operator()(), and moeoArchive< MOEOT >::update().
.SS "template<class MOEOT> void \fBmoeoArchive\fP< MOEOT >::update (const \fBeoPop\fP< MOEOT > & _pop)\fC [inline]\fP"
.PP
Updates the archive with a given population _pop.
@ -166,6 +166,8 @@ Returns true if the current archive contains the same objective vectors than the
Definition at line 151 of file moeoArchive.h.
.PP
References moeoArchive< MOEOT >::contains().
.PP
Referenced by moeoIBMOLS< MOEOT, Move >::operator()().
.SH "Author"
.PP

View file

@ -1,4 +1,4 @@
.TH "moeoArchiveObjectiveVectorSavingUpdater" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoArchiveObjectiveVectorSavingUpdater" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoArchiveUpdater" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoArchiveUpdater" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -0,0 +1,27 @@
.TH "moeoBinaryIndicatorBasedFitnessAssignment" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoBinaryIndicatorBasedFitnessAssignment \- \fBmoeoIndicatorBasedFitnessAssignment\fP for binary indicators.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoBinaryIndicatorBasedFitnessAssignment.h>\fP
.PP
Inherits \fBmoeoIndicatorBasedFitnessAssignment< MOEOT >< MOEOT >\fP.
.PP
Inherited by \fBmoeoExpBinaryIndicatorBasedFitnessAssignment< MOEOT >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoBinaryIndicatorBasedFitnessAssignment< MOEOT >"
\fBmoeoIndicatorBasedFitnessAssignment\fP for binary indicators.
.PP
Definition at line 22 of file moeoBinaryIndicatorBasedFitnessAssignment.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.

View file

@ -1,4 +1,4 @@
.TH "moeoBinaryMetric" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoBinaryMetric" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoBinaryMetricSavingUpdater" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoBinaryMetricSavingUpdater" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoBitVector" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoBitVector" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -20,6 +20,10 @@ Inherits \fBmoeoVector< MOEOObjectiveVector, MOEOFitness, MOEODiversity, bool >\
.br
.RI "\fICtor. \fP"
.ti -1c
.RI "virtual std::string \fBclassName\fP () const "
.br
.RI "\fIReturns the class name as a std::string. \fP"
.ti -1c
.RI "virtual void \fBprintOn\fP (std::ostream &_os) const "
.br
.RI "\fIWriting object. \fP"
@ -66,7 +70,7 @@ Writing object.
.PP
Reimplemented from \fBmoeoVector< MOEOObjectiveVector, MOEOFitness, MOEODiversity, bool >\fP.
.PP
Definition at line 45 of file moeoBitVector.h.
Definition at line 54 of file moeoBitVector.h.
.SS "template<class MOEOObjectiveVector, class MOEOFitness, class MOEODiversity> virtual void \fBmoeoBitVector\fP< MOEOObjectiveVector, MOEOFitness, MOEODiversity >::readFrom (std::istream & _is)\fC [inline, virtual]\fP"
.PP
Reading object.
@ -80,7 +84,7 @@ Reading object.
.PP
Reimplemented from \fBmoeoVector< MOEOObjectiveVector, MOEOFitness, MOEODiversity, bool >\fP.
.PP
Definition at line 58 of file moeoBitVector.h.
Definition at line 67 of file moeoBitVector.h.
.SH "Author"
.PP

View file

@ -1,4 +1,4 @@
.TH "moeoCombinedLS" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoCombinedLS" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoComparator" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoComparator" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoContributionMetric" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoContributionMetric" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoConvertPopToObjectiveVectors" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoConvertPopToObjectiveVectors" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoCriterionBasedFitnessAssignment" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoCriterionBasedFitnessAssignment" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -0,0 +1,126 @@
.TH "moeoCrowdingDiversityAssignment" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoCrowdingDiversityAssignment \- Diversity assignment sheme based on crowding proposed in: K.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoCrowdingDiversityAssignment.h>\fP
.PP
Inherits \fBmoeoDiversityAssignment< MOEOT >< MOEOT >\fP.
.PP
Inherited by \fBmoeoFrontByFrontCrowdingDiversityAssignment< MOEOT >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef MOEOT::ObjectiveVector \fBObjectiveVector\fP"
.br
.RI "\fIthe objective vector type of the solutions \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "double \fBinf\fP () const "
.br
.RI "\fIReturns a big value (regarded as infinite). \fP"
.ti -1c
.RI "double \fBtiny\fP () const "
.br
.RI "\fIReturns a very small value that can be used to avoid extreme cases (where the min bound == the max bound). \fP"
.ti -1c
.RI "void \fBoperator()\fP (\fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fIComputes diversity values for every solution contained in the population _pop. \fP"
.ti -1c
.RI "void \fBupdateByDeleting\fP (\fBeoPop\fP< MOEOT > &_pop, \fBObjectiveVector\fP &_objVec)"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBsetDistances\fP (\fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fISets the distance values. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoCrowdingDiversityAssignment< MOEOT >"
Diversity assignment sheme based on crowding proposed in: K.
Deb, A. Pratap, S. Agarwal, T. Meyarivan, 'A Fast and Elitist Multi-Objective Genetic Algorithm: NSGA-II', IEEE Transactions on Evolutionary Computation, vol. 6, no. 2 (2002).
.PP
Definition at line 25 of file moeoCrowdingDiversityAssignment.h.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> void \fBmoeoCrowdingDiversityAssignment\fP< MOEOT >::operator() (\fBeoPop\fP< MOEOT > & _pop)\fC [inline, virtual]\fP"
.PP
Computes diversity values for every solution contained in the population _pop.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.RE
.PP
.PP
Implements \fBeoUF< eoPop< MOEOT > &, void >\fP.
.PP
Definition at line 55 of file moeoCrowdingDiversityAssignment.h.
.PP
References moeoCrowdingDiversityAssignment< MOEOT >::inf(), and moeoCrowdingDiversityAssignment< MOEOT >::setDistances().
.SS "template<class MOEOT> void \fBmoeoCrowdingDiversityAssignment\fP< MOEOT >::updateByDeleting (\fBeoPop\fP< MOEOT > & _pop, \fBObjectiveVector\fP & _objVec)\fC [inline, virtual]\fP"
.PP
\fBWarning:\fP
.RS 4
NOT IMPLEMENTED, DO NOTHING ! Updates the diversity values of the whole population _pop by taking the deletion of the objective vector _objVec into account.
.RE
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.br
\fI_objVec\fP the objective vector
.RE
.PP
\fBWarning:\fP
.RS 4
NOT IMPLEMENTED, DO NOTHING !
.RE
.PP
.PP
Implements \fBmoeoDiversityAssignment< MOEOT >\fP.
.PP
Reimplemented in \fBmoeoFrontByFrontCrowdingDiversityAssignment< MOEOT >\fP.
.PP
Definition at line 78 of file moeoCrowdingDiversityAssignment.h.
.SS "template<class MOEOT> virtual void \fBmoeoCrowdingDiversityAssignment\fP< MOEOT >::setDistances (\fBeoPop\fP< MOEOT > & _pop)\fC [inline, protected, virtual]\fP"
.PP
Sets the distance values.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.RE
.PP
.PP
Reimplemented in \fBmoeoFrontByFrontCrowdingDiversityAssignment< MOEOT >\fP.
.PP
Definition at line 90 of file moeoCrowdingDiversityAssignment.h.
.PP
References moeoCrowdingDiversityAssignment< MOEOT >::inf().
.PP
Referenced by moeoCrowdingDiversityAssignment< MOEOT >::operator()().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.

View file

@ -1,4 +1,4 @@
.TH "moeoDetTournamentSelect" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoDetTournamentSelect" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moeoDistance" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.TH "moeoDistance" 3 "2 Jul 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

Some files were not shown because too many files have changed in this diff Show more