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

194 lines
13 KiB
TeX

\hypertarget{classmo_rnd_without_repl_neighborhood}{}\doxysection{mo\+Rnd\+Without\+Repl\+Neighborhood$<$ Neighbor $>$ Class Template Reference}
\label{classmo_rnd_without_repl_neighborhood}\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
{\ttfamily \#include $<$mo\+Rnd\+Without\+Repl\+Neighborhood.\+h$>$}
Inheritance diagram for mo\+Rnd\+Without\+Repl\+Neighborhood$<$ Neighbor $>$\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classmo_rnd_without_repl_neighborhood__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for mo\+Rnd\+Without\+Repl\+Neighborhood$<$ Neighbor $>$\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classmo_rnd_without_repl_neighborhood__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item
typedef \mbox{\hyperlink{classeo_bit}{Neighbor\+::\+E\+OT}} \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_a85dc72dfdcbb70b06c2c347f4029ff4a}{E\+OT}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_a1a1fe18d892abb4679e3974b06187b10}{mo\+Rnd\+Without\+Repl\+Neighborhood}} (unsigned int \+\_\+neighborhood\+Size)
\item
virtual bool \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_a3a382f17be3077482c39baa2d74478f4}{has\+Neighbor}} (\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&\+\_\+solution)
\item
virtual void \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_acccaf01a188dedfcc162065b68682a18}{init}} (\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&\+\_\+solution, \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} \&\+\_\+neighbor)
\item
virtual void \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_a36ebaaed819456c4f372aa5df48d2e28}{next}} (\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&\+\_\+solution, \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} \&\+\_\+neighbor)
\item
virtual bool \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_a0497897d7ae24ca73c62dec513444d7a}{cont}} (\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&\+\_\+solution)
\item
unsigned int \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_ab950bd0d88346d3d3ebf202d7426e66c}{position}} ()
\item
virtual std\+::string \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood_aa2ef6029814156e7c6ddf6450475bc40}{class\+Name}} () const
\end{DoxyCompactItemize}
\doxysubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a77a56ea57f83ddc116c4254554376e88}\label{classmo_rnd_without_repl_neighborhood_a77a56ea57f83ddc116c4254554376e88}}
unsigned int {\bfseries max\+Index}
\item
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a5cbedd77f3978bf042fb5a36ce544a7b}\label{classmo_rnd_without_repl_neighborhood_a5cbedd77f3978bf042fb5a36ce544a7b}}
std\+::vector$<$ unsigned int $>$ {\bfseries index\+Vector}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\subsubsection*{template$<$class Neighbor$>$\newline
class mo\+Rnd\+Without\+Repl\+Neighborhood$<$ Neighbor $>$}
A Random without replacement Neighborhood
\doxysubsection{Member Typedef Documentation}
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a85dc72dfdcbb70b06c2c347f4029ff4a}\label{classmo_rnd_without_repl_neighborhood_a85dc72dfdcbb70b06c2c347f4029ff4a}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!EOT@{EOT}}
\index{EOT@{EOT}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{EOT}{EOT}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
typedef \mbox{\hyperlink{classeo_bit}{Neighbor\+::\+E\+OT}} \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}}}
Define type of a solution corresponding to Neighbor
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a1a1fe18d892abb4679e3974b06187b10}\label{classmo_rnd_without_repl_neighborhood_a1a1fe18d892abb4679e3974b06187b10}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!moRndWithoutReplNeighborhood@{moRndWithoutReplNeighborhood}}
\index{moRndWithoutReplNeighborhood@{moRndWithoutReplNeighborhood}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{moRndWithoutReplNeighborhood()}{moRndWithoutReplNeighborhood()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
\mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::\mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}} (\begin{DoxyParamCaption}\item[{unsigned int}]{\+\_\+neighborhood\+Size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Constructor
\begin{DoxyParams}{Parameters}
{\em \+\_\+neighborhood\+Size} & the size of the neighborhood \\
\hline
\end{DoxyParams}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_aa2ef6029814156e7c6ddf6450475bc40}\label{classmo_rnd_without_repl_neighborhood_aa2ef6029814156e7c6ddf6450475bc40}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!className@{className}}
\index{className@{className}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{className()}{className()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
virtual std\+::string \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Return the class Name \begin{DoxyReturn}{Returns}
the class name as a std\+::string
\end{DoxyReturn}
Reimplemented from \mbox{\hyperlink{classmo_index_neighborhood_a56936b46687cf0529bcd59aa7eebaeed}{mo\+Index\+Neighborhood$<$ Neighbor $>$}}.
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a0497897d7ae24ca73c62dec513444d7a}\label{classmo_rnd_without_repl_neighborhood_a0497897d7ae24ca73c62dec513444d7a}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!cont@{cont}}
\index{cont@{cont}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{cont()}{cont()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
virtual bool \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::cont (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&}]{\+\_\+solution }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
test if all neighbors are explore or not,if false, there is no neighbor left to explore max\+Index is number of neighbors
\begin{DoxyParams}{Parameters}
{\em \+\_\+solution} & the solution to explore \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if there is again a neighbor to explore
\end{DoxyReturn}
Implements \mbox{\hyperlink{classmo_neighborhood_a4093914507138339f3756ff5edaf6531}{mo\+Neighborhood$<$ Neighbor $>$}}.
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a3a382f17be3077482c39baa2d74478f4}\label{classmo_rnd_without_repl_neighborhood_a3a382f17be3077482c39baa2d74478f4}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!hasNeighbor@{hasNeighbor}}
\index{hasNeighbor@{hasNeighbor}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{hasNeighbor()}{hasNeighbor()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
virtual bool \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::has\+Neighbor (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&}]{\+\_\+solution }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
\mbox{\hyperlink{struct_test}{Test}} if it exist a neighbor
\begin{DoxyParams}{Parameters}
{\em \+\_\+solution} & the solution to explore \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if the neighborhood was not empty
\end{DoxyReturn}
Implements \mbox{\hyperlink{classmo_neighborhood_a9a4b6ca2bcf76697145509eb35baf3be}{mo\+Neighborhood$<$ Neighbor $>$}}.
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_acccaf01a188dedfcc162065b68682a18}\label{classmo_rnd_without_repl_neighborhood_acccaf01a188dedfcc162065b68682a18}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!init@{init}}
\index{init@{init}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{init()}{init()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
virtual void \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::init (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&}]{\+\_\+solution, }\item[{\mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} \&}]{\+\_\+neighbor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Initialization of the neighborhood
\begin{DoxyParams}{Parameters}
{\em \+\_\+solution} & the solution to explore \\
\hline
{\em \+\_\+neighbor} & the first neighbor \\
\hline
\end{DoxyParams}
Implements \mbox{\hyperlink{classmo_neighborhood_a0022065ea8d42fa00768896648badf5c}{mo\+Neighborhood$<$ Neighbor $>$}}.
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_a36ebaaed819456c4f372aa5df48d2e28}\label{classmo_rnd_without_repl_neighborhood_a36ebaaed819456c4f372aa5df48d2e28}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!next@{next}}
\index{next@{next}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{next()}{next()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
virtual void \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::next (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classmo_index_neighborhood_a0c7c82d0bc5cf6c39c66254f219b78a7}{E\+OT}} \&}]{\+\_\+solution, }\item[{\mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} \&}]{\+\_\+neighbor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Give the next neighbor
\begin{DoxyParams}{Parameters}
{\em \+\_\+solution} & the solution to explore \\
\hline
{\em \+\_\+neighbor} & the next neighbor \\
\hline
\end{DoxyParams}
Implements \mbox{\hyperlink{classmo_neighborhood_a984c484c44c9852d0f971856d12092ed}{mo\+Neighborhood$<$ Neighbor $>$}}.
\mbox{\Hypertarget{classmo_rnd_without_repl_neighborhood_ab950bd0d88346d3d3ebf202d7426e66c}\label{classmo_rnd_without_repl_neighborhood_ab950bd0d88346d3d3ebf202d7426e66c}}
\index{moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}!position@{position}}
\index{position@{position}!moRndWithoutReplNeighborhood$<$ Neighbor $>$@{moRndWithoutReplNeighborhood$<$ Neighbor $>$}}
\doxysubsubsection{\texorpdfstring{position()}{position()}}
{\footnotesize\ttfamily template$<$class Neighbor $>$ \\
unsigned int \mbox{\hyperlink{classmo_rnd_without_repl_neighborhood}{mo\+Rnd\+Without\+Repl\+Neighborhood}}$<$ \mbox{\hyperlink{classmo_bit_neighbor}{Neighbor}} $>$\+::position (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Getter \begin{DoxyReturn}{Returns}
the position in the Neighborhood
\end{DoxyReturn}
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item
mo/src/neighborhood/mo\+Rnd\+Without\+Repl\+Neighborhood.\+h\end{DoxyCompactItemize}