96 lines
4.2 KiB
TeX
96 lines
4.2 KiB
TeX
\section{mo\-It\-Rand\-Next\-Move$<$ M $>$ Class Template Reference}
|
|
\label{classmo_it_rand_next_move}\index{moItRandNextMove@{moItRandNextMove}}
|
|
One of the possible \doxyref{mo\-Next\-Move}{p.}{classmo_next_move}.
|
|
|
|
|
|
{\tt \#include $<$mo\-It\-Rand\-Next\-Move.h$>$}
|
|
|
|
Inheritance diagram for mo\-It\-Rand\-Next\-Move$<$ M $>$::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2cm]{classmo_it_rand_next_move}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
{\bf mo\-It\-Rand\-Next\-Move} ({\bf mo\-Rand\-Move}$<$ M $>$ \&\_\-\_\-rand\_\-move, unsigned \_\-\_\-max\_\-iter)
|
|
\begin{CompactList}\small\item\em The constructor. \item\end{CompactList}\item
|
|
bool {\bf operator()} (M \&\_\-\_\-move, const {\bf EOT} \&\_\-\_\-sol)
|
|
\begin{CompactList}\small\item\em Generation of a new move. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Private Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef M::EOType {\bf EOT}\label{classmo_it_rand_next_move_ee666007fc494bf4a5f0cd065e5671cf}
|
|
|
|
\begin{CompactList}\small\item\em Alias for the type. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Private Attributes}
|
|
\begin{CompactItemize}
|
|
\item
|
|
{\bf mo\-Rand\-Move}$<$ M $>$ \& {\bf rand\_\-move}\label{classmo_it_rand_next_move_ef9410ec5e7dfa7f002e05967931c459}
|
|
|
|
\begin{CompactList}\small\item\em A move generator (generally randomly). \item\end{CompactList}\item
|
|
unsigned {\bf max\_\-iter}\label{classmo_it_rand_next_move_3c476f7cc089b171493c52965f920542}
|
|
|
|
\begin{CompactList}\small\item\em Iteration maximum number. \item\end{CompactList}\item
|
|
unsigned {\bf num\_\-iter}\label{classmo_it_rand_next_move_c3551d7910cf351d63f0f3427fc18504}
|
|
|
|
\begin{CompactList}\small\item\em Iteration current number. \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class M$>$ class mo\-It\-Rand\-Next\-Move$<$ M $>$}
|
|
|
|
One of the possible \doxyref{mo\-Next\-Move}{p.}{classmo_next_move}.
|
|
|
|
This class is a move (\doxyref{mo\-Move}{p.}{classmo_move}) generator with a bound for the maximum number of iterations.
|
|
|
|
|
|
|
|
Definition at line 22 of file mo\-It\-Rand\-Next\-Move.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moItRandNextMove@{mo\-It\-Rand\-Next\-Move}!moItRandNextMove@{moItRandNextMove}}
|
|
\index{moItRandNextMove@{moItRandNextMove}!moItRandNextMove@{mo\-It\-Rand\-Next\-Move}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ {\bf mo\-It\-Rand\-Next\-Move}$<$ M $>$::{\bf mo\-It\-Rand\-Next\-Move} ({\bf mo\-Rand\-Move}$<$ M $>$ \& {\em \_\-\_\-rand\_\-move}, unsigned {\em \_\-\_\-max\_\-iter})\hspace{0.3cm}{\tt [inline]}}\label{classmo_it_rand_next_move_95ed13e1178f4e44cab7184b040b83d7}
|
|
|
|
|
|
The constructor.
|
|
|
|
Parameters only for initialising the attributes.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-\_\-rand\_\-move}]the random move generator. \item[{\em \_\-\_\-max\_\-iter}]the iteration maximum number. \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 37 of file mo\-It\-Rand\-Next\-Move.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moItRandNextMove@{mo\-It\-Rand\-Next\-Move}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!moItRandNextMove@{mo\-It\-Rand\-Next\-Move}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ bool {\bf mo\-It\-Rand\-Next\-Move}$<$ M $>$::operator() (M \& {\em \_\-\_\-move}, const {\bf EOT} \& {\em \_\-\_\-sol})\hspace{0.3cm}{\tt [inline]}}\label{classmo_it_rand_next_move_92a2fbbc02a20853b9a309e99018a102}
|
|
|
|
|
|
Generation of a new move.
|
|
|
|
If the maximum number is not already reached, the current move is forgotten and remplaced by another one.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-\_\-move}]the current move. \item[{\em \_\-\_\-sol}]the current solution. \end{description}
|
|
\end{Desc}
|
|
\begin{Desc}
|
|
\item[Returns:]FALSE if the maximum number of iteration is reached, else TRUE. \end{Desc}
|
|
|
|
|
|
Definition at line 52 of file mo\-It\-Rand\-Next\-Move.h.
|
|
|
|
References mo\-It\-Rand\-Next\-Move$<$ M $>$::max\_\-iter, mo\-It\-Rand\-Next\-Move$<$ M $>$::num\_\-iter, and mo\-It\-Rand\-Next\-Move$<$ M $>$::rand\_\-move.
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
mo\-It\-Rand\-Next\-Move.h\end{CompactItemize}
|