paradiseo/Doxygen doc/latex/classeo_initializer.tex
aaziz-alaoui e79679b3c9 adding the problem configuration interface to irace interface
problem_config_mapping created
2020-10-01 15:55:30 +02:00

177 lines
12 KiB
TeX

\hypertarget{classeo_initializer}{}\doxysection{eo\+Initializer$<$ P\+OT $>$ Class Template Reference}
\label{classeo_initializer}\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
{\ttfamily \#include $<$eo\+Initializer.\+h$>$}
Inheritance diagram for eo\+Initializer$<$ P\+OT $>$\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=196pt]{classeo_initializer__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for eo\+Initializer$<$ P\+OT $>$\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=196pt]{classeo_initializer__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classeo_initializer_a26eb1737dab8d4ae2440abae8ff15ed5}{eo\+Initializer}} (\mbox{\hyperlink{classeo_u_f}{eo\+UF}}$<$ P\+OT \&, void $>$ \&\+\_\+proc, \mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Velo, \mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Best, \mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, \mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&\+\_\+pop)
\item
\mbox{\hyperlink{classeo_initializer_a725f1e27c2ee0012796b051ed25500cb}{eo\+Initializer}} (\mbox{\hyperlink{classeo_pop_eval_func}{eo\+Pop\+Eval\+Func}}$<$ P\+OT $>$ \&\+\_\+proc, \mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Velo, \mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Best, \mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, \mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&\+\_\+pop)
\item
virtual std\+::string \mbox{\hyperlink{classeo_initializer_a2faed2da61bd3a39c4f1b754dffcacd6}{class\+Name}} (void) const
\item
\mbox{\Hypertarget{classeo_initializer_acbe9cf4414125f553b50f7d0442f414c}\label{classeo_initializer_acbe9cf4414125f553b50f7d0442f414c}}
virtual void {\bfseries operator()} ()
\item
\mbox{\hyperlink{classeo_initializer_a26eb1737dab8d4ae2440abae8ff15ed5}{eo\+Initializer}} (\mbox{\hyperlink{classeo_u_f}{eo\+UF}}$<$ P\+OT \&, void $>$ \&\+\_\+proc, \mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Velo, \mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Best, \mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, \mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&\+\_\+pop)
\item
\mbox{\hyperlink{classeo_initializer_a725f1e27c2ee0012796b051ed25500cb}{eo\+Initializer}} (\mbox{\hyperlink{classeo_pop_eval_func}{eo\+Pop\+Eval\+Func}}$<$ P\+OT $>$ \&\+\_\+proc, \mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Velo, \mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&\+\_\+init\+Best, \mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&\+\_\+topology, \mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&\+\_\+pop)
\item
virtual std\+::string \mbox{\hyperlink{classeo_initializer_a2faed2da61bd3a39c4f1b754dffcacd6}{class\+Name}} (void) const
\item
\mbox{\Hypertarget{classeo_initializer_acbe9cf4414125f553b50f7d0442f414c}\label{classeo_initializer_acbe9cf4414125f553b50f7d0442f414c}}
virtual void {\bfseries operator()} ()
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\subsubsection*{template$<$class P\+OT$>$\newline
class eo\+Initializer$<$ P\+O\+T $>$}
Base (name) class for Initialization of algorithm P\+SO
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{classeo_initializer_base}{eo\+Initializer\+Base}} \mbox{\hyperlink{classeo_u_f}{eo\+UF}} \mbox{\hyperlink{group___utilities_gac678eec2c602083572edfb85ad72f408}{apply}}
\end{DoxySeeAlso}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classeo_initializer_a26eb1737dab8d4ae2440abae8ff15ed5}\label{classeo_initializer_a26eb1737dab8d4ae2440abae8ff15ed5}}
\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}!eoInitializer@{eoInitializer}}
\index{eoInitializer@{eoInitializer}!eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
\doxysubsubsection{\texorpdfstring{eoInitializer()}{eoInitializer()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_u_f}{eo\+UF}}$<$ P\+OT \&, void $>$ \&}]{\+\_\+proc, }\item[{\mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Velo, }\item[{\mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Best, }\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{\mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&}]{\+\_\+pop }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Constructor
\begin{DoxyParams}{Parameters}
{\em \+\_\+proc} & Evaluation function \\
\hline
{\em \+\_\+init\+Velo} & Initialization of the velocity \\
\hline
{\em \+\_\+init\+Best} & Initialization of the best \\
\hline
{\em \+\_\+topology} & the topology to use \\
\hline
{\em \+\_\+pop} & Population \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classeo_initializer_a725f1e27c2ee0012796b051ed25500cb}\label{classeo_initializer_a725f1e27c2ee0012796b051ed25500cb}}
\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}!eoInitializer@{eoInitializer}}
\index{eoInitializer@{eoInitializer}!eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
\doxysubsubsection{\texorpdfstring{eoInitializer()}{eoInitializer()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_pop_eval_func}{eo\+Pop\+Eval\+Func}}$<$ P\+OT $>$ \&}]{\+\_\+proc, }\item[{\mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Velo, }\item[{\mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Best, }\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{\mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&}]{\+\_\+pop }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Constructor for parallel evaluation
\begin{DoxyParams}{Parameters}
{\em \+\_\+proc} & Evaluation function \\
\hline
{\em \+\_\+init\+Velo} & Initialization of the velocity \\
\hline
{\em \+\_\+init\+Best} & Initialization of the best \\
\hline
{\em \+\_\+topology} & the topology to use \\
\hline
{\em \+\_\+pop} & Population \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classeo_initializer_a26eb1737dab8d4ae2440abae8ff15ed5}\label{classeo_initializer_a26eb1737dab8d4ae2440abae8ff15ed5}}
\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}!eoInitializer@{eoInitializer}}
\index{eoInitializer@{eoInitializer}!eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
\doxysubsubsection{\texorpdfstring{eoInitializer()}{eoInitializer()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_u_f}{eo\+UF}}$<$ P\+OT \&, void $>$ \&}]{\+\_\+proc, }\item[{\mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Velo, }\item[{\mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Best, }\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{\mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&}]{\+\_\+pop }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Constructor
\begin{DoxyParams}{Parameters}
{\em \+\_\+proc} & Evaluation function \\
\hline
{\em \+\_\+init\+Velo} & Initialization of the velocity \\
\hline
{\em \+\_\+init\+Best} & Initialization of the best \\
\hline
{\em \+\_\+topology} & the topology to use \\
\hline
{\em \+\_\+pop} & Population \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classeo_initializer_a725f1e27c2ee0012796b051ed25500cb}\label{classeo_initializer_a725f1e27c2ee0012796b051ed25500cb}}
\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}!eoInitializer@{eoInitializer}}
\index{eoInitializer@{eoInitializer}!eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
\doxysubsubsection{\texorpdfstring{eoInitializer()}{eoInitializer()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}}$<$ P\+OT $>$\+::\mbox{\hyperlink{classeo_initializer}{eo\+Initializer}} (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classeo_pop_eval_func}{eo\+Pop\+Eval\+Func}}$<$ P\+OT $>$ \&}]{\+\_\+proc, }\item[{\mbox{\hyperlink{classeo_velocity_init}{eo\+Velocity\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Velo, }\item[{\mbox{\hyperlink{classeo_particle_best_init}{eo\+Particle\+Best\+Init}}$<$ P\+OT $>$ \&}]{\+\_\+init\+Best, }\item[{\mbox{\hyperlink{classeo_topology}{eo\+Topology}}$<$ P\+OT $>$ \&}]{\+\_\+topology, }\item[{\mbox{\hyperlink{classeo_pop}{eo\+Pop}}$<$ P\+OT $>$ \&}]{\+\_\+pop }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Constructor for parallel evaluation
\begin{DoxyParams}{Parameters}
{\em \+\_\+proc} & Evaluation function \\
\hline
{\em \+\_\+init\+Velo} & Initialization of the velocity \\
\hline
{\em \+\_\+init\+Best} & Initialization of the best \\
\hline
{\em \+\_\+topology} & the topology to use \\
\hline
{\em \+\_\+pop} & Population \\
\hline
\end{DoxyParams}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classeo_initializer_a2faed2da61bd3a39c4f1b754dffcacd6}\label{classeo_initializer_a2faed2da61bd3a39c4f1b754dffcacd6}}
\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}!className@{className}}
\index{className@{className}!eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
\doxysubsubsection{\texorpdfstring{className()}{className()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
virtual std\+::string \mbox{\hyperlink{classeo_initializer}{eo\+Initializer}}$<$ P\+OT $>$\+::class\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Give the name of the class \begin{DoxyReturn}{Returns}
The name of the class
\end{DoxyReturn}
Reimplemented from \mbox{\hyperlink{classeo_functor_base}{eo\+Functor\+Base}}.
\mbox{\Hypertarget{classeo_initializer_a2faed2da61bd3a39c4f1b754dffcacd6}\label{classeo_initializer_a2faed2da61bd3a39c4f1b754dffcacd6}}
\index{eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}!className@{className}}
\index{className@{className}!eoInitializer$<$ POT $>$@{eoInitializer$<$ POT $>$}}
\doxysubsubsection{\texorpdfstring{className()}{className()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily template$<$class P\+OT $>$ \\
virtual std\+::string \mbox{\hyperlink{classeo_initializer}{eo\+Initializer}}$<$ P\+OT $>$\+::class\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Give the name of the class \begin{DoxyReturn}{Returns}
The name of the class
\end{DoxyReturn}
Reimplemented from \mbox{\hyperlink{classeo_functor_base}{eo\+Functor\+Base}}.
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item
deprecated/eo/src/eo\+Initializer.\+h\end{DoxyCompactItemize}