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

add doc

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-06-26 13:13:33 +00:00
commit b1d6dd41c0
575 changed files with 57465 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

123
branches/paradiseo-moeo-1.0/doc/man/man3/moeoObjectiveVector.3 Normal file
View file

@ -0,0 +1,123 @@
.TH "moeoObjectiveVector" 3 "26 Jun 2007" "Version 1.0" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoObjectiveVector \- Abstract class allowing to represent a solution in the objective space (phenotypic representation).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoObjectiveVector.h>\fP
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef ObjectiveVectorTraits \fBTraits\fP"
.br
.RI "\fIThe traits of objective vectors. \fP"
.ti -1c
.RI "typedef ObjectiveVectorType \fBType\fP"
.br
.RI "\fIThe type of an objective value. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoObjectiveVector\fP (\fBType\fP _value=\fBType\fP())"
.br
.RI "\fICtor. \fP"
.ti -1c
.RI "\fBmoeoObjectiveVector\fP (std::vector< \fBType\fP > &_v)"
.br
.RI "\fICtor from a vector of Type. \fP"
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static void \fBsetup\fP (unsigned int _nObjectives, std::vector< bool > &_bObjectives)"
.br
.RI "\fI\fBParameters\fP setting (for the objective vector of any solution). \fP"
.ti -1c
.RI "static unsigned int \fBnObjectives\fP ()"
.br
.RI "\fIReturns the number of objectives. \fP"
.ti -1c
.RI "static bool \fBminimizing\fP (unsigned int _i)"
.br
.RI "\fIReturns true if the _ith objective have to be minimized. \fP"
.ti -1c
.RI "static bool \fBmaximizing\fP (unsigned int _i)"
.br
.RI "\fIReturns true if the _ith objective have to be maximized. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class ObjectiveVectorTraits, class ObjectiveVectorType> class moeoObjectiveVector< ObjectiveVectorTraits, ObjectiveVectorType >"
Abstract class allowing to represent a solution in the objective space (phenotypic representation).
The template argument ObjectiveVectorTraits defaults to \fBmoeoObjectiveVectorTraits\fP, but it can be replaced at will by any other class that implements the static functions defined therein. Some static funtions to access to the traits characteristics are re-defined in order not to write a lot of typedef's.
.PP
Definition at line 25 of file moeoObjectiveVector.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class ObjectiveVectorTraits, class ObjectiveVectorType> \fBmoeoObjectiveVector\fP< ObjectiveVectorTraits, ObjectiveVectorType >::\fBmoeoObjectiveVector\fP (std::vector< \fBType\fP > & _v)\fC [inline]\fP"
.PP
Ctor from a vector of Type.
.PP
\fBParameters:\fP
.RS 4
\fI_v\fP the std::vector < Type >
.RE
.PP
.PP
Definition at line 46 of file moeoObjectiveVector.h.
.SH "Member Function Documentation"
.PP
.SS "template<class ObjectiveVectorTraits, class ObjectiveVectorType> static void \fBmoeoObjectiveVector\fP< ObjectiveVectorTraits, ObjectiveVectorType >::setup (unsigned int _nObjectives, std::vector< bool > & _bObjectives)\fC [inline, static]\fP"
.PP
\fBParameters\fP setting (for the objective vector of any solution).
.PP
\fBParameters:\fP
.RS 4
\fI_nObjectives\fP the number of objectives
.br
\fI_bObjectives\fP the min/max vector (true = min / false = max)
.RE
.PP
.PP
Definition at line 55 of file moeoObjectiveVector.h.
.SS "template<class ObjectiveVectorTraits, class ObjectiveVectorType> static bool \fBmoeoObjectiveVector\fP< ObjectiveVectorTraits, ObjectiveVectorType >::minimizing (unsigned int _i)\fC [inline, static]\fP"
.PP
Returns true if the _ith objective have to be minimized.
.PP
\fBParameters:\fP
.RS 4
\fI_i\fP the index
.RE
.PP
.PP
Definition at line 74 of file moeoObjectiveVector.h.
.SS "template<class ObjectiveVectorTraits, class ObjectiveVectorType> static bool \fBmoeoObjectiveVector\fP< ObjectiveVectorTraits, ObjectiveVectorType >::maximizing (unsigned int _i)\fC [inline, static]\fP"
.PP
Returns true if the _ith objective have to be maximized.
.PP
\fBParameters:\fP
.RS 4
\fI_i\fP the index
.RE
.PP
.PP
Definition at line 84 of file moeoObjectiveVector.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.