paradiseo/trunk/paradiseo-eo/doc/latex/classeo_pareto_fitness.tex
legrand c3aec878e5 Paradiseo-eo sources added
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-12 14:49:08 +00:00

67 lines
3.1 KiB
TeX

\section{eo\-Pareto\-Fitness$<$ Fitness\-Traits $>$ Class Template Reference}
\label{classeo_pareto_fitness}\index{eoParetoFitness@{eoParetoFitness}}
eo\-Pareto\-Fitness class: std::vector of doubles with overloaded comparison operators.
{\tt \#include $<$eo\-Pareto\-Fitness.h$>$}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef Fitness\-Traits {\bf fitness\_\-traits}\label{classeo_pareto_fitness_w0}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf eo\-Pareto\-Fitness} (std::vector$<$ double $>$ \&\_\-v)\label{classeo_pareto_fitness_a1}
\item
bool {\bf dominates} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a2}
\begin{CompactList}\small\item\em Partial order based on Pareto-dominance. \item\end{CompactList}\item
bool {\bf operator$<$} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a3}
\begin{CompactList}\small\item\em compare $\ast$not$\ast$ on dominance, but on the first, then the second, etc \item\end{CompactList}\item
bool {\bf operator$>$} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a4}
\item
bool {\bf operator$<$=} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a5}
\item
bool {\bf operator$>$=} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a6}
\item
bool {\bf operator==} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a7}
\item
bool {\bf operator!=} (const {\bf eo\-Pareto\-Fitness}$<$ Fitness\-Traits $>$ \&\_\-other) const \label{classeo_pareto_fitness_a8}
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item
void {\bf set\-Up} (unsigned \_\-n, std::vector$<$ bool $>$ \&\_\-b)\label{classeo_pareto_fitness_e0}
\begin{CompactList}\small\item\em access to the traits characteristics (so you don't have to write a lot of typedef's around \item\end{CompactList}\item
bool {\bf maximizing} (unsigned \_\-i)\label{classeo_pareto_fitness_e1}
\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class Fitness\-Traits = eo\-Pareto\-Fitness\-Traits$>$ class eo\-Pareto\-Fitness$<$ Fitness\-Traits $>$}
eo\-Pareto\-Fitness class: std::vector of doubles with overloaded comparison operators.
Comparison is done on pareto dominance. The template argument Fitness\-Traits defaults to {\bf eo\-Pareto\-Fitness\-Traits}{\rm (p.\,\pageref{classeo_pareto_fitness_traits})}, which can be replaces at will by any other class that implements the static functions defined therein.
Note that the comparison defines a partial order, so that !(a $<$ b) \&\& !(b $<$a) does not neccessarily imply that (a==b) The other way around does hold.
Definition at line 108 of file eo\-Pareto\-Fitness.h.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
eo\-Pareto\-Fitness.h\end{CompactItemize}