paradiseo/trunk/paradiseo-moeo/docs/man/man3/moeoBinaryHypervolumeIndicator.3
liefooga 011075c26a update docs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@166 331e1502-861f-0410-8da2-ba01fb791d7f
2007-01-16 14:51:25 +00:00

169 lines
6.9 KiB
Groff

.TH "moeoBinaryHypervolumeIndicator" 3 "16 Jan 2007" "Version 0.1" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoBinaryHypervolumeIndicator \- Functor Binary hypervolume indicator for \fBeoParetoFitness\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoBinaryQualityIndicator.h>\fP
.PP
Inherits \fBmoeoBinaryQualityIndicator< EOFitness >< EOFitness >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoBinaryHypervolumeIndicator\fP (double _rho)"
.br
.RI "\fIconstructor \fP"
.ti -1c
.RI "double \fBoperator()\fP (const EOFitness &_fitness_eo1, const EOFitness &_fitness_eo2)"
.br
.RI "\fIindicator value of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 (don't 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 \fBhypervolumeIndicatorValue\fP (const EOFitness &_fitness_eo1, const EOFitness &_fitness_eo2, const unsigned _iObj, const bool _flag=false)"
.br
.RI "\fIcomputation of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 \fP"
.ti -1c
.RI "double \fBhypervolumeIndicatorValueMin\fP (const EOFitness &_fitness_eo1, const EOFitness &_fitness_eo2, const unsigned _iObj, const bool _flag)"
.br
.RI "\fIcomputation of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 in case of a minimization on the objective _iObj \fP"
.ti -1c
.RI "double \fBhypervolumeIndicatorValueMax\fP (const EOFitness &_fitness_eo1, const EOFitness &_fitness_eo2, const unsigned _iObj, const bool _flag)"
.br
.RI "\fIcomputation of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 in case of a maximization on the objective _iObj \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "double \fBrho\fP"
.br
.RI "\fIreference point for the hypervolume calculation \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOFitness> class moeoBinaryHypervolumeIndicator< EOFitness >"
Functor Binary hypervolume indicator for \fBeoParetoFitness\fP.
.PP
Definition at line 206 of file moeoBinaryQualityIndicator.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOFitness> \fBmoeoBinaryHypervolumeIndicator\fP< EOFitness >::\fBmoeoBinaryHypervolumeIndicator\fP (double _rho)\fC [inline]\fP"
.PP
constructor
.PP
\fBParameters:\fP
.RS 4
\fIdouble\fP _rho reference point for the hypervolume calculation (rho must not be smaller than 1)
.RE
.PP
.PP
Definition at line 216 of file moeoBinaryQualityIndicator.h.
.PP
References moeoBinaryHypervolumeIndicator< EOFitness >::rho.
.SH "Member Function Documentation"
.PP
.SS "template<class EOFitness> double \fBmoeoBinaryHypervolumeIndicator\fP< EOFitness >::operator() (const EOFitness & _fitness_eo1, const EOFitness & _fitness_eo2)\fC [inline]\fP"
.PP
indicator value of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 (don't 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
Definition at line 239 of file moeoBinaryQualityIndicator.h.
.PP
References moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValue().
.SS "template<class EOFitness> double \fBmoeoBinaryHypervolumeIndicator\fP< EOFitness >::hypervolumeIndicatorValue (const EOFitness & _fitness_eo1, const EOFitness & _fitness_eo2, const unsigned _iObj, const bool _flag = \fCfalse\fP)\fC [inline, private]\fP"
.PP
computation of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2
.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 number of objectives (used for iteration)
.br
\fIbool\fP _flag = false (only used for iteration)
.RE
.PP
.PP
Definition at line 274 of file moeoBinaryQualityIndicator.h.
.PP
References moeoBinaryQualityIndicator< EOFitness >::bounds, moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValueMax(), and moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValueMin().
.PP
Referenced by moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValueMax(), moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValueMin(), and moeoBinaryHypervolumeIndicator< EOFitness >::operator()().
.SS "template<class EOFitness> double \fBmoeoBinaryHypervolumeIndicator\fP< EOFitness >::hypervolumeIndicatorValueMin (const EOFitness & _fitness_eo1, const EOFitness & _fitness_eo2, const unsigned _iObj, const bool _flag)\fC [inline, private]\fP"
.PP
computation of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 in case of a minimization on the objective _iObj
.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 index of the objective
.br
\fIbool\fP _flag (only used for iteration)
.RE
.PP
.PP
Definition at line 309 of file moeoBinaryQualityIndicator.h.
.PP
References moeoBinaryQualityIndicator< EOFitness >::bounds, moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValue(), and moeoBinaryHypervolumeIndicator< EOFitness >::rho.
.PP
Referenced by moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValue().
.SS "template<class EOFitness> double \fBmoeoBinaryHypervolumeIndicator\fP< EOFitness >::hypervolumeIndicatorValueMax (const EOFitness & _fitness_eo1, const EOFitness & _fitness_eo2, const unsigned _iObj, const bool _flag)\fC [inline, private]\fP"
.PP
computation of the hypervolume of the portion of the objective space that is dominated by individual _eo1 but not by individual _eo2 in case of a maximization on the objective _iObj
.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 index of the objective
.br
\fIbool\fP _flag (only used for iteration)
.RE
.PP
.PP
Definition at line 363 of file moeoBinaryQualityIndicator.h.
.PP
References moeoBinaryQualityIndicator< EOFitness >::bounds, moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValue(), and moeoBinaryHypervolumeIndicator< EOFitness >::rho.
.PP
Referenced by moeoBinaryHypervolumeIndicator< EOFitness >::hypervolumeIndicatorValue().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.