doc update

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@157 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-01-15 14:01:11 +00:00
commit b0351ae298
301 changed files with 27492 additions and 0 deletions

View file

@ -0,0 +1,91 @@
.TH "eoAdditiveBinaryEpsilonIndicator" 3 "22 Dec 2006" "Version 0.1" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eoAdditiveBinaryEpsilonIndicator \- Functor Additive binary epsilon indicator for \fBeoParetoFitness\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <eoBinaryQualityIndicator.h>\fP
.PP
Inherits \fBeoBinaryQualityIndicator< EOFitness >< EOFitness >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBeoAdditiveBinaryEpsilonIndicator\fP ()"
.br
.RI "\fIconstructor \fP"
.ti -1c
.RI "double \fBoperator()\fP (const EOFitness &_fitness_eo1, const EOFitness &_fitness_eo2)"
.br
.RI "\fIcomputation of the maximum epsilon value by which individual _eo1 must be decreased in all objectives such that individual _eo2 is weakly dominated (do not forget to set the bounds before the call of this function) \fP"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef EOFitness::fitness_traits \fBtraits\fP"
.br
.RI "\fIfitness traits \fP"
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "double \fBepsilonValue\fP (const EOFitness &_fitness_eo1, const EOFitness &_fitness_eo2, const unsigned _iObj)"
.br
.RI "\fIcomputation of the epsilon value by which individual _eo1 must be decreased in the objective _iObj such that individual _eo2 is weakly dominated \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOFitness> class eoAdditiveBinaryEpsilonIndicator< EOFitness >"
Functor Additive binary epsilon indicator for \fBeoParetoFitness\fP.
.PP
Definition at line 126 of file eoBinaryQualityIndicator.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOFitness> double \fBeoAdditiveBinaryEpsilonIndicator\fP< EOFitness >::operator() (const EOFitness & _fitness_eo1, const EOFitness & _fitness_eo2)\fC [inline, virtual]\fP"
.PP
computation of the maximum epsilon value by which individual _eo1 must be decreased in all objectives such that individual _eo2 is weakly dominated (do not forget to set the bounds before the call of this function)
.PP
\fBParameters:\fP
.RS 4
\fIEOFitness\fP & _fitness_eo1 the fitness of the first individual
.br
\fIEOFitness\fP & _fitness_eo2 the fitness of the second individual
.RE
.PP
.PP
Implements \fBeoBF< const EOFitness &, const EOFitness &, double >\fP.
.PP
Definition at line 149 of file eoBinaryQualityIndicator.h.
.PP
References eoAdditiveBinaryEpsilonIndicator< EOFitness >::epsilonValue().
.SS "template<class EOFitness> double \fBeoAdditiveBinaryEpsilonIndicator\fP< EOFitness >::epsilonValue (const EOFitness & _fitness_eo1, const EOFitness & _fitness_eo2, const unsigned _iObj)\fC [inline, private]\fP"
.PP
computation of the epsilon value by which individual _eo1 must be decreased in the objective _iObj such that individual _eo2 is weakly dominated
.PP
\fBParameters:\fP
.RS 4
\fIEOFitness\fP & _fitness_eo1 the fitness of the first individual
.br
\fIEOFitness\fP & _fitness_eo2 the fitness of the second individual
.br
\fIunsigned\fP _iObj the index of the objective
.RE
.PP
.PP
Definition at line 181 of file eoBinaryQualityIndicator.h.
.PP
Referenced by eoAdditiveBinaryEpsilonIndicator< EOFitness >::operator()().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.