git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@28 331e1502-861f-0410-8da2-ba01fb791d7f

trunk/docs/latex/classmo_tabu_list.tex

@@ -0,0 +1,69 @@
+\section{mo\-Tabu\-List$<$ M $>$ Class Template Reference}
+\label{classmo_tabu_list}\index{moTabuList@{moTabuList}}
+Class describing a tabu list that a \doxyref{mo\-TS}{p.}{classmo_t_s} uses.  
+
+
+{\tt \#include $<$mo\-Tabu\-List.h$>$}
+
+\subsection*{Public Types}
+\begin{CompactItemize}
+\item 
+typedef M::EOType {\bf EOT}\label{classmo_tabu_list_e219715cc3fdd5626764bc50ce6357df}
+
+\begin{CompactList}\small\item\em Alias for the type. \item\end{CompactList}\end{CompactItemize}
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+virtual void {\bf add} (const M \&\_\-\_\-move, const {\bf EOT} \&\_\-\_\-sol)=0
+\begin{CompactList}\small\item\em Procedure to add a move in the tabu list. \item\end{CompactList}\item 
+virtual void {\bf update} ()=0
+\begin{CompactList}\small\item\em Procedure that updates the tabu list content. \item\end{CompactList}\item 
+virtual void {\bf init} ()=0
+\begin{CompactList}\small\item\em Procedure which initialises the tabu list. \item\end{CompactList}\end{CompactItemize}
+
+
+\subsection{Detailed Description}
+\subsubsection*{template$<$class M$>$ class mo\-Tabu\-List$<$ M $>$}
+
+Class describing a tabu list that a \doxyref{mo\-TS}{p.}{classmo_t_s} uses. 
+
+It is only a description, does nothing... A new object that herits from this class has to be defined in order to be used in a \doxyref{mo\-TS}{p.}{classmo_t_s}. 
+
+
+
+Definition at line 22 of file mo\-Tabu\-List.h.
+
+\subsection{Member Function Documentation}
+\index{moTabuList@{mo\-Tabu\-List}!add@{add}}
+\index{add@{add}!moTabuList@{mo\-Tabu\-List}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ virtual void {\bf mo\-Tabu\-List}$<$ M $>$::add (const M \& {\em \_\-\_\-move}, const {\bf EOT} \& {\em \_\-\_\-sol})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classmo_tabu_list_d279d72cb486d812da1ad3d24a69c286}
+
+
+Procedure to add a move in the tabu list. 
+
+The two parameters have not to be modified so they are constant parameters
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em \_\-\_\-move}]a new tabu move \item[{\em \_\-\_\-sol}]the solution associated to this move \end{description}
+\end{Desc}
+\index{moTabuList@{mo\-Tabu\-List}!update@{update}}
+\index{update@{update}!moTabuList@{mo\-Tabu\-List}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ virtual void {\bf mo\-Tabu\-List}$<$ M $>$::update ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classmo_tabu_list_a2e5d1132f064093c8ed57046405f5ca}
+
+
+Procedure that updates the tabu list content. 
+
+Generally, a counter associated to each saved move is decreased by one. \index{moTabuList@{mo\-Tabu\-List}!init@{init}}
+\index{init@{init}!moTabuList@{mo\-Tabu\-List}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ virtual void {\bf mo\-Tabu\-List}$<$ M $>$::init ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classmo_tabu_list_0a06c459d56e8e2b408a8f3c6aec4e57}
+
+
+Procedure which initialises the tabu list. 
+
+Can be useful if the data structure needs to be allocated before being used. 
+
+The documentation for this class was generated from the following file:\begin{CompactItemize}
+\item 
+mo\-Tabu\-List.h\end{CompactItemize}