paradiseo/branches/paradiseo-moeo-1.0/doc/man/man3/moeoElitistReplacement.3
liefooga b1d6dd41c0 add doc
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
2007-06-26 13:13:33 +00:00

163 lines
5.6 KiB
Groff

.TH "moeoElitistReplacement" 3 "26 Jun 2007" "Version 1.0" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoElitistReplacement \- Elitist replacement strategy that consists in keeping the N best individuals.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoElitistReplacement.h>\fP
.PP
Inherits \fBmoeoReplacement< MOEOT >< MOEOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > &_fitnessAssignment, \fBmoeoDiversityAssignment\fP< MOEOT > &_diversityAssignment, \fBmoeoComparator\fP< MOEOT > &_comparator)"
.br
.RI "\fIFull constructor. \fP"
.ti -1c
.RI "\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > &_fitnessAssignment, \fBmoeoDiversityAssignment\fP< MOEOT > &_diversityAssignment)"
.br
.RI "\fIConstructor without comparator. \fP"
.ti -1c
.RI "\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > &_fitnessAssignment, \fBmoeoComparator\fP< MOEOT > &_comparator)"
.br
.RI "\fIConstructor without moeoDiversityAssignement. \fP"
.ti -1c
.RI "\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > &_fitnessAssignment)"
.br
.RI "\fIConstructor without moeoDiversityAssignement nor \fBmoeoComparator\fP. \fP"
.ti -1c
.RI "void \fBoperator()\fP (\fBeoPop\fP< MOEOT > &_parents, \fBeoPop\fP< MOEOT > &_offspring)"
.br
.RI "\fIReplaces the first population by adding the individuals of the second one, sorting with a \fBmoeoComparator\fP and resizing the whole population obtained. \fP"
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "\fBmoeoFitnessAssignment\fP< MOEOT > & \fBfitnessAssignment\fP"
.br
.RI "\fIthe fitness assignment strategy \fP"
.ti -1c
.RI "\fBmoeoDiversityAssignment\fP< MOEOT > & \fBdiversityAssignment\fP"
.br
.RI "\fIthe diversity assignment strategy \fP"
.ti -1c
.RI "\fBmoeoDummyDiversityAssignment\fP< MOEOT > \fBdefaultDiversity\fP"
.br
.RI "\fIa dummy diversity assignment can be used as default \fP"
.ti -1c
.RI "\fBmoeoFitnessThenDiversityComparator\fP< MOEOT > \fBdefaultComparator\fP"
.br
.RI "\fIa fitness then diversity comparator can be used as default \fP"
.ti -1c
.RI "\fBmoeoElitistReplacement::Cmp\fP \fBcomparator\fP"
.br
.RI "\fIthis object is used to compare solutions in order to sort the population \fP"
.in -1c
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBCmp\fP"
.br
.RI "\fIthis object is used to compare solutions in order to sort the population \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoElitistReplacement< MOEOT >"
Elitist replacement strategy that consists in keeping the N best individuals.
.PP
Definition at line 26 of file moeoElitistReplacement.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class MOEOT> \fBmoeoElitistReplacement\fP< MOEOT >::\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > & _fitnessAssignment, \fBmoeoDiversityAssignment\fP< MOEOT > & _diversityAssignment, \fBmoeoComparator\fP< MOEOT > & _comparator)\fC [inline]\fP"
.PP
Full constructor.
.PP
\fBParameters:\fP
.RS 4
\fI_fitnessAssignment\fP the fitness assignment strategy
.br
\fI_diversityAssignment\fP the diversity assignment strategy
.br
\fI_comparator\fP the comparator (used to compare 2 individuals)
.RE
.PP
.PP
Definition at line 36 of file moeoElitistReplacement.h.
.SS "template<class MOEOT> \fBmoeoElitistReplacement\fP< MOEOT >::\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > & _fitnessAssignment, \fBmoeoDiversityAssignment\fP< MOEOT > & _diversityAssignment)\fC [inline]\fP"
.PP
Constructor without comparator.
.PP
A moeoFitThenDivComparator is used as default.
.PP
\fBParameters:\fP
.RS 4
\fI_fitnessAssignment\fP the fitness assignment strategy
.br
\fI_diversityAssignment\fP the diversity assignment strategy
.RE
.PP
.PP
Definition at line 46 of file moeoElitistReplacement.h.
.SS "template<class MOEOT> \fBmoeoElitistReplacement\fP< MOEOT >::\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > & _fitnessAssignment, \fBmoeoComparator\fP< MOEOT > & _comparator)\fC [inline]\fP"
.PP
Constructor without moeoDiversityAssignement.
.PP
A dummy diversity is used as default.
.PP
\fBParameters:\fP
.RS 4
\fI_fitnessAssignment\fP the fitness assignment strategy
.br
\fI_comparator\fP the comparator (used to compare 2 individuals)
.RE
.PP
.PP
Definition at line 56 of file moeoElitistReplacement.h.
.SS "template<class MOEOT> \fBmoeoElitistReplacement\fP< MOEOT >::\fBmoeoElitistReplacement\fP (\fBmoeoFitnessAssignment\fP< MOEOT > & _fitnessAssignment)\fC [inline]\fP"
.PP
Constructor without moeoDiversityAssignement nor \fBmoeoComparator\fP.
.PP
A moeoFitThenDivComparator and a dummy diversity are used as default.
.PP
\fBParameters:\fP
.RS 4
\fI_fitnessAssignment\fP the fitness assignment strategy
.RE
.PP
.PP
Definition at line 66 of file moeoElitistReplacement.h.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> void \fBmoeoElitistReplacement\fP< MOEOT >::operator() (\fBeoPop\fP< MOEOT > & _parents, \fBeoPop\fP< MOEOT > & _offspring)\fC [inline]\fP"
.PP
Replaces the first population by adding the individuals of the second one, sorting with a \fBmoeoComparator\fP and resizing the whole population obtained.
.PP
\fBParameters:\fP
.RS 4
\fI_parents\fP the population composed of the parents (the population you want to replace)
.br
\fI_offspring\fP the offspring population
.RE
.PP
.PP
Definition at line 76 of file moeoElitistReplacement.h.
.PP
References moeoElitistReplacement< MOEOT >::comparator, moeoElitistReplacement< MOEOT >::diversityAssignment, and moeoElitistReplacement< MOEOT >::fitnessAssignment.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.