update for moCoolingSchedule in the documentations

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@273 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-04-18 08:28:51 +00:00
commit aa6f62acd2
6 changed files with 364 additions and 0 deletions

View file

@ -0,0 +1,58 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PARADISEO-MO: moCoolingSchedule Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>moCoolingSchedule Class Reference</h1><!-- doxytag: class="moCoolingSchedule" -->This class gives the description of a cooling schedule.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_cooling_schedule_8h-source.html">moCoolingSchedule.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moCoolingSchedule:
<p><center><img src="classmo_cooling_schedule.png" usemap="#moCoolingSchedule_map" border="0" alt=""></center>
<map name="moCoolingSchedule_map">
<area href="classmo_exponential_cooling_schedule.html" alt="moExponentialCoolingSchedule" shape="rect" coords="0,56,189,80">
<area href="classmo_linear_cooling_schedule.html" alt="moLinearCoolingSchedule" shape="rect" coords="199,56,388,80">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class gives the description of a cooling schedule.
<p>
It is only a description... An object that herits from this class is needed to be used in a <a class="el" href="classmo_s_a.html">moSA</a>. See <a class="el" href="classmo_exponential_cooling_schedule.html">moExponentialCoolingSchedule</a> or <a class="el" href="classmo_linear_cooling_schedule.html">moLinearCoolingSchedule</a> for example.
<p>
<p>
Definition at line <a class="el" href="mo_cooling_schedule_8h-source.html#l00022">22</a> of file <a class="el" href="mo_cooling_schedule_8h-source.html">moCoolingSchedule.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_cooling_schedule_8h-source.html">moCoolingSchedule.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Apr 18 10:15:04 2007 for PARADISEO-MO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 819 B

View file

@ -0,0 +1,51 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PARADISEO-MO: moCoolingSchedule.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<h1>moCoolingSchedule.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-</span>
<a name="l00002"></a>00002
<a name="l00003"></a>00003 <span class="comment">// "moCoolingSchedule.h"</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="comment">// (c) OPAC Team, LIFL, 2003-2007</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="comment">/* LICENCE TEXT</span>
<a name="l00008"></a>00008 <span class="comment"> </span>
<a name="l00009"></a>00009 <span class="comment"> Contact: paradiseo-help@lists.gforge.inria.fr</span>
<a name="l00010"></a>00010 <span class="comment">*/</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef __moCoolingSchedule_h</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define __moCoolingSchedule_h</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;eoFunctor.h&gt;</span>
<a name="l00016"></a>00016
<a name="l00018"></a>00018
<a name="l00022"></a><a class="code" href="classmo_cooling_schedule.html">00022</a> <span class="keyword">class </span><a class="code" href="classmo_cooling_schedule.html">moCoolingSchedule</a>:<span class="keyword">public</span> eoUF &lt; double &amp;, bool &gt;
<a name="l00023"></a>00023 {
<a name="l00024"></a>00024
<a name="l00025"></a>00025 };
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 18 10:15:03 2007 for PARADISEO-MO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>

View file

@ -0,0 +1,203 @@
%!PS-Adobe-2.0 EPSF-2.0
%%Title: ClassName
%%Creator: Doxygen
%%CreationDate: Time
%%For:
%Magnification: 1.00
%%Orientation: Portrait
%%BoundingBox: 0 0 500 101.523
%%Pages: 0
%%BeginSetup
%%EndSetup
%%EndComments
% ----- variables -----
/boxwidth 0 def
/boxheight 40 def
/fontheight 24 def
/marginwidth 10 def
/distx 20 def
/disty 40 def
/boundaspect 4.925 def % aspect ratio of the BoundingBox (width/height)
/boundx 500 def
/boundy boundx boundaspect div def
/xspacing 0 def
/yspacing 0 def
/rows 2 def
/cols 2 def
/scalefactor 0 def
/boxfont /Times-Roman findfont fontheight scalefont def
% ----- procedures -----
/dotted { [1 4] 0 setdash } def
/dashed { [5] 0 setdash } def
/solid { [] 0 setdash } def
/max % result = MAX(arg1,arg2)
{
/a exch def
/b exch def
a b gt {a} {b} ifelse
} def
/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2)
{
0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max
} def
/cw % boxwidth = MAX(boxwidth, stringwidth(arg1))
{
/str exch def
/boxwidth boxwidth str stringwidth pop max def
} def
/box % draws a box with text `arg1' at grid pos (arg2,arg3)
{ gsave
2 setlinewidth
newpath
exch xspacing mul xoffset add
exch yspacing mul
moveto
boxwidth 0 rlineto
0 boxheight rlineto
boxwidth neg 0 rlineto
0 boxheight neg rlineto
closepath
dup stringwidth pop neg boxwidth add 2 div
boxheight fontheight 2 div sub 2 div
rmoveto show stroke
grestore
} def
/mark
{ newpath
exch xspacing mul xoffset add boxwidth add
exch yspacing mul
moveto
0 boxheight 4 div rlineto
boxheight neg 4 div boxheight neg 4 div rlineto
closepath
eofill
stroke
} def
/arrow
{ newpath
moveto
3 -8 rlineto
-6 0 rlineto
3 8 rlineto
closepath
eofill
stroke
} def
/out % draws an output connector for the block at (arg1,arg2)
{
newpath
exch xspacing mul xoffset add boxwidth 2 div add
exch yspacing mul boxheight add
/y exch def
/x exch def
x y moveto
0 disty 2 div rlineto
stroke
1 eq { x y disty 2 div add arrow } if
} def
/in % draws an input connector for the block at (arg1,arg2)
{
newpath
exch xspacing mul xoffset add boxwidth 2 div add
exch yspacing mul disty 2 div sub
/y exch def
/x exch def
x y moveto
0 disty 2 div rlineto
stroke
1 eq { x y disty 2 div add arrow } if
} def
/hedge
{
exch xspacing mul xoffset add boxwidth 2 div add
exch yspacing mul boxheight 2 div sub
/y exch def
/x exch def
newpath
x y moveto
boxwidth 2 div distx add 0 rlineto
stroke
1 eq
{ newpath x boxwidth 2 div distx add add y moveto
-8 3 rlineto
0 -6 rlineto
8 3 rlineto
closepath
eofill
stroke
} if
} def
/vedge
{
/ye exch def
/ys exch def
/xs exch def
newpath
xs xspacing mul xoffset add boxwidth 2 div add dup
ys yspacing mul boxheight 2 div sub
moveto
ye yspacing mul boxheight 2 div sub
lineto
stroke
} def
/conn % connections the blocks from col `arg1' to `arg2' of row `arg3'
{
/ys exch def
/xe exch def
/xs exch def
newpath
xs xspacing mul xoffset add boxwidth 2 div add
ys yspacing mul disty 2 div sub
moveto
xspacing xe xs sub mul 0
rlineto
stroke
} def
% ----- main ------
boxfont setfont
1 boundaspect scale
(moCoolingSchedule) cw
(moExponentialCoolingSchedule) cw
(moLinearCoolingSchedule) cw
/boxwidth boxwidth marginwidth 2 mul add def
/xspacing boxwidth distx add def
/yspacing boxheight disty add def
/scalefactor
boxwidth cols mul distx cols 1 sub mul add
boxheight rows mul disty rows 1 sub mul add boundaspect mul
max def
boundx scalefactor div boundy scalefactor div scale
% ----- classes -----
(moCoolingSchedule) 0.5 1 box
(moExponentialCoolingSchedule) 0 0 box
(moLinearCoolingSchedule) 1 0 box
% ----- relations -----
solid
1 0.5 0.25 out
solid
0 1 1 conn
solid
0 0 0.75 in
solid
0 1 0.75 in

View file

@ -0,0 +1,27 @@
\section{mo\-Cooling\-Schedule Class Reference}
\label{classmo_cooling_schedule}\index{moCoolingSchedule@{moCoolingSchedule}}
This class gives the description of a cooling schedule.
{\tt \#include $<$mo\-Cooling\-Schedule.h$>$}
Inheritance diagram for mo\-Cooling\-Schedule::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classmo_cooling_schedule}
\end{center}
\end{figure}
\subsection{Detailed Description}
This class gives the description of a cooling schedule.
It is only a description... An object that herits from this class is needed to be used in a \doxyref{mo\-SA}{p.}{classmo_s_a}. See \doxyref{mo\-Exponential\-Cooling\-Schedule}{p.}{classmo_exponential_cooling_schedule} or \doxyref{mo\-Linear\-Cooling\-Schedule}{p.}{classmo_linear_cooling_schedule} for example.
Definition at line 22 of file mo\-Cooling\-Schedule.h.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
mo\-Cooling\-Schedule.h\end{CompactItemize}

View file

@ -0,0 +1,25 @@
.TH "moCoolingSchedule" 3 "18 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moCoolingSchedule \- This class gives the description of a cooling schedule.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moCoolingSchedule.h>\fP
.PP
Inherited by \fBmoExponentialCoolingSchedule\fP, and \fBmoLinearCoolingSchedule\fP.
.PP
.SH "Detailed Description"
.PP
This class gives the description of a cooling schedule.
It is only a description... An object that herits from this class is needed to be used in a \fBmoSA\fP. See \fBmoExponentialCoolingSchedule\fP or \fBmoLinearCoolingSchedule\fP for example.
.PP
Definition at line 22 of file moCoolingSchedule.h.
.SH "Author"
.PP
Generated automatically by Doxygen for PARADISEO-MO from the source code.