8a7ec960b3
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@288 331e1502-861f-0410-8da2-ba01fb791d7f
85 lines
3.6 KiB
TeX
85 lines
3.6 KiB
TeX
\section{mo\-Linear\-Cooling\-Schedule Class Reference}
|
|
\label{classmo_linear_cooling_schedule}\index{moLinearCoolingSchedule@{moLinearCoolingSchedule}}
|
|
One of the possible \doxyref{mo\-Cooling\-Schedule}{p.}{classmo_cooling_schedule}.
|
|
|
|
|
|
{\tt \#include $<$mo\-Linear\-Cooling\-Schedule.h$>$}
|
|
|
|
Inheritance diagram for mo\-Linear\-Cooling\-Schedule::\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 mo\-Linear\-Cooling\-Schedule} (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 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{mo\-Cooling\-Schedule}{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 22 of file mo\-Linear\-Cooling\-Schedule.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moLinearCoolingSchedule@{mo\-Linear\-Cooling\-Schedule}!moLinearCoolingSchedule@{moLinearCoolingSchedule}}
|
|
\index{moLinearCoolingSchedule@{moLinearCoolingSchedule}!moLinearCoolingSchedule@{mo\-Linear\-Cooling\-Schedule}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}mo\-Linear\-Cooling\-Schedule::mo\-Linear\-Cooling\-Schedule (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 31 of file mo\-Linear\-Cooling\-Schedule.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moLinearCoolingSchedule@{mo\-Linear\-Cooling\-Schedule}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!moLinearCoolingSchedule@{mo\-Linear\-Cooling\-Schedule}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool mo\-Linear\-Cooling\-Schedule::operator() (double \& {\em \_\-\_\-temp})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_linear_cooling_schedule_814b109fdfd9426a92a5444b05014da3}
|
|
|
|
|
|
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 eo\-UF$<$ double \&, bool $>$}.
|
|
|
|
Definition at line 41 of file mo\-Linear\-Cooling\-Schedule.h.
|
|
|
|
References quantity, and threshold.
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
mo\-Linear\-Cooling\-Schedule.h\end{CompactItemize}
|