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

105
branches/paradiseo-moeo-1.0/doc/man/man3/moeoObjectiveVectorTraits.3 Normal file
View file

@ -0,0 +1,105 @@
.TH "moeoObjectiveVectorTraits" 3 "26 Jun 2007" "Version 1.0" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoObjectiveVectorTraits \- A traits class for \fBmoeoObjectiveVector\fP to specify the number of objectives and which ones have to be minimized or maximized.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoObjectiveVectorTraits.h>\fP
.PP
.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. \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"
.ti -1c
.RI "static double \fBtolerance\fP ()"
.br
.RI "\fIReturns the tolerance value (to compare solutions). \fP"
.in -1c
.SS "Static Private Attributes"
.in +1c
.ti -1c
.RI "static unsigned int \fBnObj\fP"
.br
.RI "\fIThe number of objectives. \fP"
.ti -1c
.RI "static std::vector< bool > \fBbObj\fP"
.br
.RI "\fIThe min/max vector. \fP"
.in -1c
.SH "Detailed Description"
.PP
A traits class for \fBmoeoObjectiveVector\fP to specify the number of objectives and which ones have to be minimized or maximized.
.PP
Definition at line 23 of file moeoObjectiveVectorTraits.h.
.SH "Member Function Documentation"
.PP
.SS "static void moeoObjectiveVectorTraits::setup (unsigned int _nObjectives, std::vector< bool > & _bObjectives)\fC [inline, static]\fP"
.PP
\fBParameters\fP setting.
.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 32 of file moeoObjectiveVectorTraits.h.
.PP
References bObj, and nObj.
.SS "static bool moeoObjectiveVectorTraits::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 67 of file moeoObjectiveVectorTraits.h.
.PP
References bObj.
.PP
Referenced by maximizing().
.SS "static bool moeoObjectiveVectorTraits::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 80 of file moeoObjectiveVectorTraits.h.
.PP
References minimizing().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.