nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

New doc is made

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@742 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-10-23 13:38:14 +00:00
commit 25cf44c291
296 changed files with 28291 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

85
trunk/paradiseo-mo/doc/latex/classmo_linear_cooling_schedule.tex Normal file
View file

@ -0,0 +1,85 @@
\section{moLinearCoolingSchedule Class Reference}
\label{classmo_linear_cooling_schedule}\index{moLinearCoolingSchedule@{moLinearCoolingSchedule}}
One of the possible \doxyref{moCoolingSchedule}{p.}{classmo_cooling_schedule}.
{\tt \#include $<$moLinearCoolingSchedule.h$>$}
Inheritance diagram for moLinearCoolingSchedule::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classmo_linear_cooling_schedule}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moLinearCoolingSchedule} (double \_\-\_\-threshold, double \_\-\_\-quantity)
\begin{CompactList}\small\item\em Simple constructor. \item\end{CompactList}\item
bool {\bf operator()} (double \&\_\-\_\-temp)
\begin{CompactList}\small\item\em {\bf Function} which proceeds to the cooling. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
double {\bf threshold}\label{classmo_linear_cooling_schedule_e7f539f986801ea71392c4a55ba08a76}
\begin{CompactList}\small\item\em The temperature threhold. \item\end{CompactList}\item
double {\bf quantity}\label{classmo_linear_cooling_schedule_6159dc39ceda89b23ffdab3d6ce8d8ed}
\begin{CompactList}\small\item\em The quantity that allows the temperature to decrease. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
One of the possible \doxyref{moCoolingSchedule}{p.}{classmo_cooling_schedule}.
An another very simple cooling schedule, the temperature decrease according to a quantity while the temperature is greater than a threshold.
Definition at line 47 of file moLinearCoolingSchedule.h.
\subsection{Constructor \& Destructor Documentation}
\index{moLinearCoolingSchedule@{moLinearCoolingSchedule}!moLinearCoolingSchedule@{moLinearCoolingSchedule}}
\index{moLinearCoolingSchedule@{moLinearCoolingSchedule}!moLinearCoolingSchedule@{moLinearCoolingSchedule}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}moLinearCoolingSchedule::moLinearCoolingSchedule (double {\em \_\-\_\-threshold}, double {\em \_\-\_\-quantity})\hspace{0.3cm}{\tt [inline]}}\label{classmo_linear_cooling_schedule_2fdde7b1520d5a41251627e81cc9c13d}
Simple constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-\_\-threshold}]the threshold. \item[{\em \_\-\_\-quantity}]the quantity used to descrease the temperature. \end{description}
\end{Desc}
Definition at line 56 of file moLinearCoolingSchedule.h.
\subsection{Member Function Documentation}
\index{moLinearCoolingSchedule@{moLinearCoolingSchedule}!operator()@{operator()}}
\index{operator()@{operator()}!moLinearCoolingSchedule@{moLinearCoolingSchedule}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool moLinearCoolingSchedule::operator() (double \& {\em \_\-\_\-temp})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_linear_cooling_schedule_814b109fdfd9426a92a5444b05014da3}
{\bf Function} which proceeds to the cooling.
It decreases the temperature and indicates if it is greater than the threshold.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-\_\-temp}]the current temperature. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]if the new temperature (current temperature - quantity) is greater than the threshold. \end{Desc}
Implements {\bf eoUF$<$ double \&, bool $>$}.
Definition at line 66 of file moLinearCoolingSchedule.h.
References quantity, and threshold.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moLinearCoolingSchedule.h\end{CompactItemize}