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

added good doc files

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@683 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2007-10-08 14:49:10 +00:00
commit 04b12455d0
152 changed files with 14307 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

155
trunk/paradiseo-moeo/doc/man/man3/moeoReferencePointIndicatorBasedFitnessAssignment.3 Normal file
View file

@ -0,0 +1,155 @@
.TH "moeoReferencePointIndicatorBasedFitnessAssignment" 3 "8 Oct 2007" "Version 1.0" "ParadisEO-MOEOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoReferencePointIndicatorBasedFitnessAssignment \- Fitness assignment sheme based a Reference Point and a Quality Indicator.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoReferencePointIndicatorBasedFitnessAssignment.h>\fP
.PP
Inherits \fBmoeoFitnessAssignment< MOEOT >< MOEOT >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef MOEOT::ObjectiveVector \fBObjectiveVector\fP"
.br
.RI "\fIThe type of objective vector. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP (\fBObjectiveVector\fP &_refPoint, \fBmoeoNormalizedSolutionVsSolutionBinaryMetric\fP< \fBObjectiveVector\fP, double > &_metric)"
.br
.RI "\fICtor. \fP"
.ti -1c
.RI "void \fBoperator()\fP (\fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fISets the fitness values for every solution contained in the population _pop. \fP"
.ti -1c
.RI "void \fBupdateByDeleting\fP (\fBeoPop\fP< MOEOT > &_pop, \fBObjectiveVector\fP &_objVec)"
.br
.RI "\fIUpdates the fitness values of the whole population _pop by taking the deletion of the objective vector _objVec into account. \fP"
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBsetup\fP (const \fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fISets the bounds for every objective using the min and the max value for every objective vector of _pop (and the reference point). \fP"
.ti -1c
.RI "void \fBsetFitnesses\fP (\fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fISets the fitness of every individual contained in the population _pop. \fP"
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "\fBObjectiveVector\fP & \fBrefPoint\fP"
.br
.RI "\fIthe reference point \fP"
.ti -1c
.RI "\fBmoeoNormalizedSolutionVsSolutionBinaryMetric\fP< \fBObjectiveVector\fP, double > & \fBmetric\fP"
.br
.RI "\fIthe quality indicator \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >"
Fitness assignment sheme based a Reference Point and a Quality Indicator.
.PP
Definition at line 25 of file moeoReferencePointIndicatorBasedFitnessAssignment.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class MOEOT> \fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP< MOEOT >::\fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP (\fBObjectiveVector\fP & _refPoint, \fBmoeoNormalizedSolutionVsSolutionBinaryMetric\fP< \fBObjectiveVector\fP, double > & _metric)\fC [inline]\fP"
.PP
Ctor.
.PP
\fBParameters:\fP
.RS 4
\fI_refPoint\fP the reference point
.br
\fI_metric\fP the quality indicator
.RE
.PP
.PP
Definition at line 37 of file moeoReferencePointIndicatorBasedFitnessAssignment.h.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> void \fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP< MOEOT >::operator() (\fBeoPop\fP< MOEOT > & _pop)\fC [inline, virtual]\fP"
.PP
Sets the fitness 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 46 of file moeoReferencePointIndicatorBasedFitnessAssignment.h.
.PP
References moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::setFitnesses(), and moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::setup().
.SS "template<class MOEOT> void \fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP< MOEOT >::updateByDeleting (\fBeoPop\fP< MOEOT > & _pop, \fBObjectiveVector\fP & _objVec)\fC [inline, virtual]\fP"
.PP
Updates the fitness values of the whole population _pop by taking the deletion of the objective vector _objVec into account.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.br
\fI_objVec\fP the objective vector
.RE
.PP
.PP
Implements \fBmoeoFitnessAssignment< MOEOT >\fP.
.PP
Definition at line 60 of file moeoReferencePointIndicatorBasedFitnessAssignment.h.
.SS "template<class MOEOT> void \fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP< MOEOT >::setup (const \fBeoPop\fP< MOEOT > & _pop)\fC [inline, protected]\fP"
.PP
Sets the bounds for every objective using the min and the max value for every objective vector of _pop (and the reference point).
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.RE
.PP
.PP
Definition at line 78 of file moeoReferencePointIndicatorBasedFitnessAssignment.h.
.PP
References moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::metric, moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::refPoint, and moeoNormalizedSolutionVsSolutionBinaryMetric< ObjectiveVector, R >::setup().
.PP
Referenced by moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::operator()().
.SS "template<class MOEOT> void \fBmoeoReferencePointIndicatorBasedFitnessAssignment\fP< MOEOT >::setFitnesses (\fBeoPop\fP< MOEOT > & _pop)\fC [inline, protected]\fP"
.PP
Sets the fitness of every individual contained in the population _pop.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.RE
.PP
.PP
Definition at line 99 of file moeoReferencePointIndicatorBasedFitnessAssignment.h.
.PP
References moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::metric, and moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::refPoint.
.PP
Referenced by moeoReferencePointIndicatorBasedFitnessAssignment< MOEOT >::operator()().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEOMovingObjects from the source code.