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

update doc with new stuffs

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@497 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-07-02 14:05:51 +00:00
commit 320c6b06ff
287 changed files with 262 additions and 3094 deletions
Download patch file Download diff file Expand all files Collapse all files

126
trunk/paradiseo-moeo/doc/man/man3/moeoCrowdingDistanceDiversityAssignment.3
View file

@ -1,126 +0,0 @@
.TH "moeoCrowdingDistanceDiversityAssignment" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoCrowdingDistanceDiversityAssignment \- Diversity assignment sheme based on crowding distance proposed in: K.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoCrowdingDistanceDiversityAssignment.h>\fP
.PP
Inherits \fBmoeoDiversityAssignment< MOEOT >< MOEOT >\fP.
.PP
Inherited by \fBmoeoFrontByFrontCrowdingDistanceDiversityAssignment< 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 moeoCrowdingDistanceDiversityAssignment< MOEOT >"
Diversity assignment sheme based on crowding distance 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 moeoCrowdingDistanceDiversityAssignment.h.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> void \fBmoeoCrowdingDistanceDiversityAssignment\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 moeoCrowdingDistanceDiversityAssignment.h.
.PP
References moeoCrowdingDistanceDiversityAssignment< MOEOT >::inf(), and moeoCrowdingDistanceDiversityAssignment< MOEOT >::setDistances().
.SS "template<class MOEOT> void \fBmoeoCrowdingDistanceDiversityAssignment\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 \fBmoeoFrontByFrontCrowdingDistanceDiversityAssignment< MOEOT >\fP.
.PP
Definition at line 78 of file moeoCrowdingDistanceDiversityAssignment.h.
.SS "template<class MOEOT> virtual void \fBmoeoCrowdingDistanceDiversityAssignment\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 \fBmoeoFrontByFrontCrowdingDistanceDiversityAssignment< MOEOT >\fP.
.PP
Definition at line 90 of file moeoCrowdingDistanceDiversityAssignment.h.
.PP
References moeoCrowdingDistanceDiversityAssignment< MOEOT >::inf().
.PP
Referenced by moeoCrowdingDistanceDiversityAssignment< MOEOT >::operator()().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.

112
trunk/paradiseo-moeo/doc/man/man3/moeoFrontByFrontCrowdingDistanceDiversityAssignment.3
View file

@ -1,112 +0,0 @@
.TH "moeoFrontByFrontCrowdingDistanceDiversityAssignment" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoFrontByFrontCrowdingDistanceDiversityAssignment \- Diversity assignment sheme based on crowding distance proposed in: K.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoFrontByFrontCrowdingDistanceDiversityAssignment.h>\fP
.PP
Inherits \fBmoeoCrowdingDistanceDiversityAssignment< MOEOT >< 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 "void \fBupdateByDeleting\fP (\fBeoPop\fP< MOEOT > &_pop, \fBObjectiveVector\fP &_objVec)"
.br
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "void \fBsetDistances\fP (\fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fISets the distance values. \fP"
.ti -1c
.RI "unsigned int \fBlastIndex\fP (\fBeoPop\fP< MOEOT > &_pop, unsigned int _start)"
.br
.RI "\fIReturns the index of the last individual having the same fitness value than _pop[_start]. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoFrontByFrontCrowdingDistanceDiversityAssignment< MOEOT >"
Diversity assignment sheme based on crowding distance 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). Tis strategy assigns diversity values FRONT BY FRONT. It is, for instance, used in NSGA-II.
.PP
Definition at line 25 of file moeoFrontByFrontCrowdingDistanceDiversityAssignment.h.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> void \fBmoeoFrontByFrontCrowdingDistanceDiversityAssignment\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
Reimplemented from \fBmoeoCrowdingDistanceDiversityAssignment< MOEOT >\fP.
.PP
Definition at line 40 of file moeoFrontByFrontCrowdingDistanceDiversityAssignment.h.
.SS "template<class MOEOT> void \fBmoeoFrontByFrontCrowdingDistanceDiversityAssignment\fP< MOEOT >::setDistances (\fBeoPop\fP< MOEOT > & _pop)\fC [inline, private, virtual]\fP"
.PP
Sets the distance values.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.RE
.PP
.PP
Reimplemented from \fBmoeoCrowdingDistanceDiversityAssignment< MOEOT >\fP.
.PP
Definition at line 55 of file moeoFrontByFrontCrowdingDistanceDiversityAssignment.h.
.PP
References moeoCrowdingDistanceDiversityAssignment< MOEOT >::inf(), moeoFrontByFrontCrowdingDistanceDiversityAssignment< MOEOT >::lastIndex(), and moeoCrowdingDistanceDiversityAssignment< MOEOT >::tiny().
.SS "template<class MOEOT> unsigned int \fBmoeoFrontByFrontCrowdingDistanceDiversityAssignment\fP< MOEOT >::lastIndex (\fBeoPop\fP< MOEOT > & _pop, unsigned int _start)\fC [inline, private]\fP"
.PP
Returns the index of the last individual having the same fitness value than _pop[_start].
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.br
\fI_start\fP the index to start from
.RE
.PP
.PP
Definition at line 121 of file moeoFrontByFrontCrowdingDistanceDiversityAssignment.h.
.PP
Referenced by moeoFrontByFrontCrowdingDistanceDiversityAssignment< MOEOT >::setDistances().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.

179
trunk/paradiseo-moeo/doc/man/man3/moeoObjectiveVectorDouble.3
View file

@ -1,179 +0,0 @@
.TH "moeoObjectiveVectorDouble" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoObjectiveVectorDouble \- This class allows to represent a solution in the objective space (phenotypic representation) by a std::vector of doubles, i.e.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoObjectiveVectorDouble.h>\fP
.PP
Inherits \fBmoeoObjectiveVector< ObjectiveVectorTraits, double >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoObjectiveVectorDouble\fP (double _value=0.0)"
.br
.RI "\fICtor. \fP"
.ti -1c
.RI "\fBmoeoObjectiveVectorDouble\fP (std::vector< double > &_v)"
.br
.RI "\fICtor from a vector of doubles. \fP"
.ti -1c
.RI "bool \fBdominates\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector dominates _other according to the Pareto dominance relation (but it's better to use a \fBmoeoObjectiveVectorComparator\fP object to compare solutions). \fP"
.ti -1c
.RI "bool \fBoperator==\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector is equal to _other (according to a tolerance value). \fP"
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector is different than _other (according to a tolerance value). \fP"
.ti -1c
.RI "bool \fBoperator<\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector is smaller than _other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \fP"
.ti -1c
.RI "bool \fBoperator>\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector is greater than _other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \fP"
.ti -1c
.RI "bool \fBoperator<=\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector is smaller than or equal to _other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \fP"
.ti -1c
.RI "bool \fBoperator>=\fP (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > &_other) const "
.br
.RI "\fIReturns true if the current objective vector is greater than or equal to _other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class ObjectiveVectorTraits> class moeoObjectiveVectorDouble< ObjectiveVectorTraits >"
This class allows to represent a solution in the objective space (phenotypic representation) by a std::vector of doubles, i.e.
that an objective value is represented using a double, and this for any objective.
.PP
Definition at line 27 of file moeoObjectiveVectorDouble.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class ObjectiveVectorTraits> \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::\fBmoeoObjectiveVectorDouble\fP (std::vector< double > & _v)\fC [inline]\fP"
.PP
Ctor from a vector of doubles.
.PP
\fBParameters:\fP
.RS 4
\fI_v\fP the std::vector < double >
.RE
.PP
.PP
Definition at line 45 of file moeoObjectiveVectorDouble.h.
.SH "Member Function Documentation"
.PP
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::dominates (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector dominates _other according to the Pareto dominance relation (but it's better to use a \fBmoeoObjectiveVectorComparator\fP object to compare solutions).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 54 of file moeoObjectiveVectorDouble.h.
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::operator== (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector is equal to _other (according to a tolerance value).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 65 of file moeoObjectiveVectorDouble.h.
.PP
Referenced by moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator!=(), and moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator>=().
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::operator!= (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector is different than _other (according to a tolerance value).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 82 of file moeoObjectiveVectorDouble.h.
.PP
References moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator==().
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::operator< (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector is smaller than _other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 93 of file moeoObjectiveVectorDouble.h.
.PP
Referenced by moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator<=().
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::operator> (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector is greater than _other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 105 of file moeoObjectiveVectorDouble.h.
.PP
Referenced by moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator>=().
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::operator<= (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector is smaller than or equal to _other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 116 of file moeoObjectiveVectorDouble.h.
.PP
References moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator<().
.SS "template<class ObjectiveVectorTraits> bool \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits >::operator>= (const \fBmoeoObjectiveVectorDouble\fP< ObjectiveVectorTraits > & _other) const\fC [inline]\fP"
.PP
Returns true if the current objective vector is greater than or equal to _other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
.PP
\fBParameters:\fP
.RS 4
\fI_other\fP the other \fBmoeoObjectiveVectorDouble\fP object to compare with
.RE
.PP
.PP
Definition at line 127 of file moeoObjectiveVectorDouble.h.
.PP
References moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator==(), and moeoObjectiveVectorDouble< ObjectiveVectorTraits >::operator>().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.

15
trunk/paradiseo-moeo/doc/man/man3/webpages.3
View file

@ -1,15 +0,0 @@
.TH "webpages" 3 "26 Jun 2007" "Version 1.0-beta" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
webpages \- Related webpages
.IP "\(bu" 2
ParadisEO \fChomepage\fP
.IP "\(bu" 2
INRIA GForge \fCproject page\fP
.IP "\(bu" 2
\fCREADME\fP
.IP "\(bu" 2
\fCNEWS\fP
.PP