paradiseo/trunk/paradiseo-moeo/doc/latex/classmoeoEuclideanDistance.tex
liefooga f58813fd6e doc up-to-date
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@558 331e1502-861f-0410-8da2-ba01fb791d7f
2007-07-06 07:40:50 +00:00

59 lines
2.5 KiB
TeX

\section{moeo\-Euclidean\-Distance$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoEuclideanDistance}\index{moeoEuclideanDistance@{moeoEuclideanDistance}}
A class allowing to compute an euclidian distance between two solutions in the objective space with normalized objective values (i.e.
{\tt \#include $<$moeo\-Euclidean\-Distance.h$>$}
Inheritance diagram for moeo\-Euclidean\-Distance$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoEuclideanDistance}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoEuclideanDistance_d75b1b8695b3eb16f9574496b5822daa}
\begin{CompactList}\small\item\em the objective vector type of the solutions \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
const double \bf{operator()} (const MOEOT \&\_\-moeo1, const MOEOT \&\_\-moeo2)
\begin{CompactList}\small\item\em Returns the euclidian distance between \_\-moeo1 and \_\-moeo2 in the objective space. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Euclidean\-Distance$<$ MOEOT $>$}
A class allowing to compute an euclidian distance between two solutions in the objective space with normalized objective values (i.e.
between 0 and 1). A distance value then lies between 0 and sqrt(n\-Objectives).
Definition at line 24 of file moeo\-Euclidean\-Distance.h.
\subsection{Member Function Documentation}
\index{moeoEuclideanDistance@{moeo\-Euclidean\-Distance}!operator()@{operator()}}
\index{operator()@{operator()}!moeoEuclideanDistance@{moeo\-Euclidean\-Distance}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ const double \bf{moeo\-Euclidean\-Distance}$<$ MOEOT $>$::operator() (const MOEOT \& {\em \_\-moeo1}, const MOEOT \& {\em \_\-moeo2})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEuclideanDistance_20ff559e95da92a46990eb0658f018f1}
Returns the euclidian distance between \_\-moeo1 and \_\-moeo2 in the objective space.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-moeo1}]the first solution \item[{\em \_\-moeo2}]the second solution \end{description}
\end{Desc}
Definition at line 37 of file moeo\-Euclidean\-Distance.h.
References moeo\-Normalized\-Distance$<$ MOEOT $>$::bounds.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Euclidean\-Distance.h\end{CompactItemize}