57ab34591c
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@889 331e1502-861f-0410-8da2-ba01fb791d7f
83 lines
3.6 KiB
TeX
83 lines
3.6 KiB
TeX
\section{moExponentialCoolingSchedule Class Reference}
|
|
\label{classmo_exponential_cooling_schedule}\index{moExponentialCoolingSchedule@{moExponentialCoolingSchedule}}
|
|
One of the possible \doxyref{moCoolingSchedule}{p.}{classmo_cooling_schedule}.
|
|
|
|
|
|
{\tt \#include $<$moExponentialCoolingSchedule.h$>$}
|
|
|
|
Inheritance diagram for moExponentialCoolingSchedule::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=4cm]{classmo_exponential_cooling_schedule}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
{\bf moExponentialCoolingSchedule} (double \_\-threshold, double \_\-ratio)
|
|
\begin{CompactList}\small\item\em Simple constructor. \item\end{CompactList}\item
|
|
bool {\bf operator()} (double \&\_\-temperature)
|
|
\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_exponential_cooling_schedule_8d4327c0bb33b7121a322279eea97f84}
|
|
|
|
\begin{CompactList}\small\item\em The temperature threhold. \item\end{CompactList}\item
|
|
double {\bf ratio}\label{classmo_exponential_cooling_schedule_e8f3f87417c1c7253efb938a740846fa}
|
|
|
|
\begin{CompactList}\small\item\em The decreasing factor of the temperature. \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
One of the possible \doxyref{moCoolingSchedule}{p.}{classmo_cooling_schedule}.
|
|
|
|
An other very simple cooling schedule, the temperature decrease according to a ratio while the temperature is greater than a given threshold.
|
|
|
|
Definition at line 46 of file moExponentialCoolingSchedule.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moExponentialCoolingSchedule@{moExponentialCoolingSchedule}!moExponentialCoolingSchedule@{moExponentialCoolingSchedule}}
|
|
\index{moExponentialCoolingSchedule@{moExponentialCoolingSchedule}!moExponentialCoolingSchedule@{moExponentialCoolingSchedule}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}moExponentialCoolingSchedule::moExponentialCoolingSchedule (double {\em \_\-threshold}, double {\em \_\-ratio})\hspace{0.3cm}{\tt [inline]}}\label{classmo_exponential_cooling_schedule_e60ce9eb5e632f4758ea96ae92a52774}
|
|
|
|
|
|
Simple constructor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-threshold}]the threshold. \item[{\em \_\-ratio}]the ratio used to descrease the temperature. \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 55 of file moExponentialCoolingSchedule.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moExponentialCoolingSchedule@{moExponentialCoolingSchedule}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!moExponentialCoolingSchedule@{moExponentialCoolingSchedule}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool moExponentialCoolingSchedule::operator() (double \& {\em \_\-temperature})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_exponential_cooling_schedule_95b075e9786a5cc984ef1bb59a2107e4}
|
|
|
|
|
|
{\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 \_\-temperature}]the current temperature. \end{description}
|
|
\end{Desc}
|
|
\begin{Desc}
|
|
\item[Returns:]if the new temperature (current temperature $\ast$ ratio) is greater than the threshold. \end{Desc}
|
|
|
|
|
|
Implements {\bf eoUF$<$ double \&, bool $>$}.
|
|
|
|
Definition at line 65 of file moExponentialCoolingSchedule.h.
|
|
|
|
References ratio, and threshold.
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
moExponentialCoolingSchedule.h\end{CompactItemize}
|