javadoc/and/Mapping/Algo.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_0) on Tue Feb 02 14:44:19 CET 2010 -->
   6 <TITLE>
   7 Algo
   8 </TITLE>
   9
  10 <META NAME="date" CONTENT="2010-02-02">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     if (location.href.indexOf('is-external=true') == -1) {
  18         parent.document.title="Algo";
  19     }
  20 }
  21 </SCRIPT>
  22 <NOSCRIPT>
  23 </NOSCRIPT>
  24
  25 </HEAD>
  26
  27 <BODY BGCOLOR="white" onload="windowTitle();">
  28 <HR>
  29
  30
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <A NAME="navbar_top"><!-- --></A>
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35 <TR>
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37 <A NAME="navbar_top_firstrow"><!-- --></A>
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39   <TR ALIGN="center" VALIGN="top">
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../and/Mapping/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Algo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  47   </TR>
  48 </TABLE>
  49 </TD>
  50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  51 </EM>
  52 </TD>
  53 </TR>
  54
  55 <TR>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57 &nbsp;PREV CLASS&nbsp;
  58 &nbsp;<A HREF="../../and/Mapping/Architecture.html" title="class in and.Mapping"><B>NEXT CLASS</B></A></FONT></TD>
  59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  60   <A HREF="../../index.html?and/Mapping/Algo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  61 &nbsp;<A HREF="Algo.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  62 &nbsp;<SCRIPT type="text/javascript">
  63   <!--
  64   if(window==top) {
  65     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  66   }
  67   //-->
  68 </SCRIPT>
  69 <NOSCRIPT>
  70   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  71 </NOSCRIPT>
  72
  73
  74 </FONT></TD>
  75 </TR>
  76 <TR>
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  78   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  81 </TR>
  82 </TABLE>
  83 <A NAME="skip-navbar_top"></A>
  84 <!-- ========= END OF TOP NAVBAR ========= -->
  85
  86 <HR>
  87 <!-- ======== START OF CLASS DATA ======== -->
  88 <H2>
  89 <FONT SIZE="-1">
  90 and.Mapping</FONT>
  91 <BR>
  92 Class Algo</H2>
  93 <PRE>
  94 java.lang.Object
  95   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>and.Mapping.Algo</B>
  96 </PRE>
  97 <DL>
  98 <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
  99 </DL>
 100 <DL>
 101 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../and/Mapping/DefaultMapping.html" title="class in and.Mapping">DefaultMapping</A>, <A HREF="../../and/Mapping/LSM.html" title="class in and.Mapping">LSM</A>, <A HREF="../../and/Mapping/QM.html" title="class in and.Mapping">QM</A>, <A HREF="../../and/Mapping/Simple.html" title="class in and.Mapping">Simple</A></DD>
 102 </DL>
 103 <HR>
 104 <DL>
 105 <DT><PRE>public abstract class <B>Algo</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
 106 </PRE>
 107
 108 <P>
 109 Abstract class defining the structure for mapping algorithms
 110 <P>
 111
 112 <P>
 113 <DL>
 114 <DT><B>Author:</B></DT>
 115   <DD>S&eacute;bastien Miqu&eacute;e</DD>
 116 <DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#and.Mapping.Algo">Serialized Form</A></DL>
 117 <HR>
 118
 119 <P>
 120
 121 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 122
 123 <A NAME="constructor_summary"><!-- --></A>
 124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 127 <B>Constructor Summary</B></FONT></TH>
 128 </TR>
 129 <TR BGCOLOR="white" CLASS="TableRowColor">
 130 <TD><CODE><B><A HREF="../../and/Mapping/Algo.html#Algo()">Algo</A></B>()</CODE>
 131
 132 <BR>
 133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor.</TD>
 134 </TR>
 135 <TR BGCOLOR="white" CLASS="TableRowColor">
 136 <TD><CODE><B><A HREF="../../and/Mapping/Algo.html#Algo(and.Mapping.Graph, and.Mapping.Grid)">Algo</A></B>(<A HREF="../../and/Mapping/Graph.html" title="class in and.Mapping">Graph</A>&nbsp;_gr,
 137      <A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A>&nbsp;_gl)</CODE>
 138
 139 <BR>
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
 141 </TR>
 142 </TABLE>
 143 &nbsp;
 144 <!-- ========== METHOD SUMMARY =========== -->
 145
 146 <A NAME="method_summary"><!-- --></A>
 147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 148 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 149 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 150 <B>Method Summary</B></FONT></TH>
 151 </TR>
 152 <TR BGCOLOR="white" CLASS="TableRowColor">
 153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 154 <CODE>&nbsp;<A HREF="../../and/Mapping/Mapping.html" title="class in and.Mapping">Mapping</A></CODE></FONT></TD>
 155 <TD><CODE><B><A HREF="../../and/Mapping/Algo.html#getMapping()">getMapping</A></B>()</CODE>
 156
 157 <BR>
 158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return mapping done.</TD>
 159 </TR>
 160 <TR BGCOLOR="white" CLASS="TableRowColor">
 161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 162 <CODE>abstract &nbsp;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A></CODE></FONT></TD>
 163 <TD><CODE><B><A HREF="../../and/Mapping/Algo.html#getOtherGNode()">getOtherGNode</A></B>()</CODE>
 164
 165 <BR>
 166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Find a new node, which may not takes part into the computation process.</TD>
 167 </TR>
 168 <TR BGCOLOR="white" CLASS="TableRowColor">
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 170 <CODE>abstract &nbsp;void</CODE></FONT></TD>
 171 <TD><CODE><B><A HREF="../../and/Mapping/Algo.html#map()">map</A></B>()</CODE>
 172
 173 <BR>
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mapping function.</TD>
 175 </TR>
 176 <TR BGCOLOR="white" CLASS="TableRowColor">
 177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 178 <CODE>abstract &nbsp;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A></CODE></FONT></TD>
 179 <TD><CODE><B><A HREF="../../and/Mapping/Algo.html#replaceNode(and.Mapping.GNode, java.util.ArrayList)">replaceNode</A></B>(<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A>&nbsp;_dead,
 180             java.util.ArrayList&lt;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A>&gt;&nbsp;_ag)</CODE>
 181
 182 <BR>
 183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replace a fallen node by a new one, according to the mapping policy.</TD>
 184 </TR>
 185 </TABLE>
 186 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 188 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 189 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 190 </TR>
 191 <TR BGCOLOR="white" CLASS="TableRowColor">
 192 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 193 </TR>
 194 </TABLE>
 195 &nbsp;
 196 <P>
 197
 198 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 199
 200 <A NAME="constructor_detail"><!-- --></A>
 201 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 202 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 203 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 204 <B>Constructor Detail</B></FONT></TH>
 205 </TR>
 206 </TABLE>
 207
 208 <A NAME="Algo()"><!-- --></A><H3>
 209 Algo</H3>
 210 <PRE>
 211 public <B>Algo</B>()</PRE>
 212 <DL>
 213 <DD>Default constructor.
 214 <P>
 215 </DL>
 216 <HR>
 217
 218 <A NAME="Algo(and.Mapping.Graph, and.Mapping.Grid)"><!-- --></A><H3>
 219 Algo</H3>
 220 <PRE>
 221 public <B>Algo</B>(<A HREF="../../and/Mapping/Graph.html" title="class in and.Mapping">Graph</A>&nbsp;_gr,
 222             <A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A>&nbsp;_gl)</PRE>
 223 <DL>
 224 <DD>Constructor.
 225 <P>
 226 <DL>
 227 <DT><B>Parameters:</B><DD><CODE>_gr</CODE> - Tasks graph to be mapped<DD><CODE>_gl</CODE> - Grid graph</DL>
 228 </DL>
 229
 230 <!-- ============ METHOD DETAIL ========== -->
 231
 232 <A NAME="method_detail"><!-- --></A>
 233 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 234 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 235 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 236 <B>Method Detail</B></FONT></TH>
 237 </TR>
 238 </TABLE>
 239
 240 <A NAME="map()"><!-- --></A><H3>
 241 map</H3>
 242 <PRE>
 243 public abstract void <B>map</B>()</PRE>
 244 <DL>
 245 <DD>Mapping function.
 246 <P>
 247 <DD><DL>
 248 </DL>
 249 </DD>
 250 <DD><DL>
 251 </DL>
 252 </DD>
 253 </DL>
 254 <HR>
 255
 256 <A NAME="replaceNode(and.Mapping.GNode, java.util.ArrayList)"><!-- --></A><H3>
 257 replaceNode</H3>
 258 <PRE>
 259 public abstract <A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A> <B>replaceNode</B>(<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A>&nbsp;_dead,
 260                                   java.util.ArrayList&lt;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A>&gt;&nbsp;_ag)</PRE>
 261 <DL>
 262 <DD>Replace a fallen node by a new one, according to the mapping policy.
 263 <P>
 264 <DD><DL>
 265 </DL>
 266 </DD>
 267 <DD><DL>
 268 <DT><B>Parameters:</B><DD><CODE>_dead</CODE> - The fallen node to be replaced<DD><CODE>_ag</CODE> - The list of all available computing nodes
 269 <DT><B>Returns:</B><DD>The new node</DL>
 270 </DD>
 271 </DL>
 272 <HR>
 273
 274 <A NAME="getOtherGNode()"><!-- --></A><H3>
 275 getOtherGNode</H3>
 276 <PRE>
 277 public abstract <A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A> <B>getOtherGNode</B>()</PRE>
 278 <DL>
 279 <DD>Find a new node, which may not takes part into the computation process.
 280  Typically such kind of node is used to create a new spawner or a new super-node,
 281  in order to bring fault tolerance.
 282 <P>
 283 <DD><DL>
 284 </DL>
 285 </DD>
 286 <DD><DL>
 287
 288 <DT><B>Returns:</B><DD>Another node which will not compute</DL>
 289 </DD>
 290 </DL>
 291 <HR>
 292
 293 <A NAME="getMapping()"><!-- --></A><H3>
 294 getMapping</H3>
 295 <PRE>
 296 public <A HREF="../../and/Mapping/Mapping.html" title="class in and.Mapping">Mapping</A> <B>getMapping</B>()</PRE>
 297 <DL>
 298 <DD>Return mapping done.
 299 <P>
 300 <DD><DL>
 301 </DL>
 302 </DD>
 303 <DD><DL>
 304
 305 <DT><B>Returns:</B><DD>The mapping done</DL>
 306 </DD>
 307 </DL>
 308 <!-- ========= END OF CLASS DATA ========= -->
 309 <HR>
 310
 311
 312 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 313 <A NAME="navbar_bottom"><!-- --></A>
 314 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 315 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 316 <TR>
 317 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 318 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 319 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 320   <TR ALIGN="center" VALIGN="top">
 321   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../and/Mapping/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 322   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 323   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Algo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 324   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 325   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 326   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 327   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 328   </TR>
 329 </TABLE>
 330 </TD>
 331 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 332 </EM>
 333 </TD>
 334 </TR>
 335
 336 <TR>
 337 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 338 &nbsp;PREV CLASS&nbsp;
 339 &nbsp;<A HREF="../../and/Mapping/Architecture.html" title="class in and.Mapping"><B>NEXT CLASS</B></A></FONT></TD>
 340 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 341   <A HREF="../../index.html?and/Mapping/Algo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 342 &nbsp;<A HREF="Algo.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 343 &nbsp;<SCRIPT type="text/javascript">
 344   <!--
 345   if(window==top) {
 346     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 347   }
 348   //-->
 349 </SCRIPT>
 350 <NOSCRIPT>
 351   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 352 </NOSCRIPT>
 353
 354
 355 </FONT></TD>
 356 </TR>
 357 <TR>
 358 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 359   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 360 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 361 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 362 </TR>
 363 </TABLE>
 364 <A NAME="skip-navbar_bottom"></A>
 365 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 366
 367 <HR>
 368
 369 </BODY>
 370 </HTML>