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

117 lines
6.2 KiB
TeX

\hypertarget{classeo_parallel}{}\doxysection{eo\+Parallel Class Reference}
\label{classeo_parallel}\index{eoParallel@{eoParallel}}
{\ttfamily \#include $<$eo\+Parallel.\+h$>$}
Inheritance diagram for eo\+Parallel\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=145pt]{classeo_parallel__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for eo\+Parallel\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=145pt]{classeo_parallel__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
virtual std\+::string \mbox{\hyperlink{classeo_parallel_a7d2a782ae8e6d50600436e6e4333c972}{class\+Name}} () const
\item
\mbox{\Hypertarget{classeo_parallel_af385cfce7a30eade18e564f9ac39bdfc}\label{classeo_parallel_af385cfce7a30eade18e564f9ac39bdfc}}
bool {\bfseries is\+Enabled} () const
\item
\mbox{\Hypertarget{classeo_parallel_a37330ab716273e911eac87de2ebd235a}\label{classeo_parallel_a37330ab716273e911eac87de2ebd235a}}
bool {\bfseries is\+Dynamic} () const
\item
\mbox{\Hypertarget{classeo_parallel_a2fd17a66be07928a7630eb7d03623d00}\label{classeo_parallel_a2fd17a66be07928a7630eb7d03623d00}}
std\+::string {\bfseries prefix} () const
\item
\mbox{\Hypertarget{classeo_parallel_aa25b05f6f8abc006e8855d345a8cc637}\label{classeo_parallel_aa25b05f6f8abc006e8855d345a8cc637}}
unsigned int {\bfseries nthreads} () const
\item
\mbox{\Hypertarget{classeo_parallel_a6cf49925e40b3856140cd1bd1d1f3f94}\label{classeo_parallel_a6cf49925e40b3856140cd1bd1d1f3f94}}
bool {\bfseries enable\+Results} () const
\item
\mbox{\Hypertarget{classeo_parallel_aee3df0c43bc4f44d7277e5907519c498}\label{classeo_parallel_aee3df0c43bc4f44d7277e5907519c498}}
bool {\bfseries do\+Measure} () const
\item
virtual std\+::string \mbox{\hyperlink{classeo_parallel_aa81252d9098d06cb6bd66a2d5237f1d2}{class\+Name}} () const
\item
\mbox{\Hypertarget{classeo_parallel_af385cfce7a30eade18e564f9ac39bdfc}\label{classeo_parallel_af385cfce7a30eade18e564f9ac39bdfc}}
bool {\bfseries is\+Enabled} () const
\item
\mbox{\Hypertarget{classeo_parallel_a37330ab716273e911eac87de2ebd235a}\label{classeo_parallel_a37330ab716273e911eac87de2ebd235a}}
bool {\bfseries is\+Dynamic} () const
\item
\mbox{\Hypertarget{classeo_parallel_a2fd17a66be07928a7630eb7d03623d00}\label{classeo_parallel_a2fd17a66be07928a7630eb7d03623d00}}
std\+::string {\bfseries prefix} () const
\item
\mbox{\Hypertarget{classeo_parallel_aa25b05f6f8abc006e8855d345a8cc637}\label{classeo_parallel_aa25b05f6f8abc006e8855d345a8cc637}}
unsigned int {\bfseries nthreads} () const
\item
\mbox{\Hypertarget{classeo_parallel_a8d7f3a1470b0de9ca6bc878d892f7490}\label{classeo_parallel_a8d7f3a1470b0de9ca6bc878d892f7490}}
unsigned int {\bfseries packet\+Size} () const
\item
\mbox{\Hypertarget{classeo_parallel_a6cf49925e40b3856140cd1bd1d1f3f94}\label{classeo_parallel_a6cf49925e40b3856140cd1bd1d1f3f94}}
bool {\bfseries enable\+Results} () const
\item
\mbox{\Hypertarget{classeo_parallel_aee3df0c43bc4f44d7277e5907519c498}\label{classeo_parallel_aee3df0c43bc4f44d7277e5907519c498}}
bool {\bfseries do\+Measure} () const
\end{DoxyCompactItemize}
\doxysubsection*{Friends}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classeo_parallel_a10892ca0339654c8886897921256571e}\label{classeo_parallel_a10892ca0339654c8886897921256571e}}
void {\bfseries make\+\_\+parallel} (\mbox{\hyperlink{classeo_parser}{eo\+Parser}} \&)
\item
\mbox{\Hypertarget{classeo_parallel_a10892ca0339654c8886897921256571e}\label{classeo_parallel_a10892ca0339654c8886897921256571e}}
void {\bfseries make\+\_\+parallel} (\mbox{\hyperlink{classeo_parser}{eo\+Parser}} \&)
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classeo_parallel}{eo\+Parallel}} Class providing parameters for parallelization Use of a global variable eo\+::parallel to easily use the parallelization parameters anywhere
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classeo_parallel_aa81252d9098d06cb6bd66a2d5237f1d2}\label{classeo_parallel_aa81252d9098d06cb6bd66a2d5237f1d2}}
\index{eoParallel@{eoParallel}!className@{className}}
\index{className@{className}!eoParallel@{eoParallel}}
\doxysubsubsection{\texorpdfstring{className()}{className()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual std\+::string eo\+Parallel\+::class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
Return the class id. This should be redefined in each class. Only \char`\"{}leaf\char`\"{} classes can be non-\/virtual.
Maarten\+: removed the default implementation as this proved to be too error-\/prone\+: I found several classes that had a typo in class\+Name (like classname), which would print \mbox{\hyperlink{classeo_object}{eo\+Object}} instead of their own. Having it pure will force the implementor to provide a name.
Implements \mbox{\hyperlink{classeo_object_a1c02745db786e7bb46dea93b560fe685}{eo\+Object}}.
\mbox{\Hypertarget{classeo_parallel_a7d2a782ae8e6d50600436e6e4333c972}\label{classeo_parallel_a7d2a782ae8e6d50600436e6e4333c972}}
\index{eoParallel@{eoParallel}!className@{className}}
\index{className@{className}!eoParallel@{eoParallel}}
\doxysubsubsection{\texorpdfstring{className()}{className()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily std\+::string eo\+Parallel\+::class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
Return the class id. This should be redefined in each class. Only \char`\"{}leaf\char`\"{} classes can be non-\/virtual.
Maarten\+: removed the default implementation as this proved to be too error-\/prone\+: I found several classes that had a typo in class\+Name (like classname), which would print \mbox{\hyperlink{classeo_object}{eo\+Object}} instead of their own. Having it pure will force the implementor to provide a name.
Implements \mbox{\hyperlink{classeo_object_a1c02745db786e7bb46dea93b560fe685}{eo\+Object}}.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
deprecated/eo/src/utils/eo\+Parallel.\+h\item
deprecated/eo/src/utils/eo\+Parallel.\+cpp\end{DoxyCompactItemize}