javadoc/and/Mapping/Utils.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 Utils
   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="Utils";
  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/Utils.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;<A HREF="../../and/Mapping/Simple.html" title="class in and.Mapping"><B>PREV CLASS</B></A>&nbsp;
  58 &nbsp;NEXT CLASS</FONT></TD>
  59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  60   <A HREF="../../index.html?and/Mapping/Utils.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  61 &nbsp;<A HREF="Utils.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 Utils</H2>
  93 <PRE>
  94 java.lang.Object
  95   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>and.Mapping.Utils</B>
  96 </PRE>
  97 <HR>
  98 <DL>
  99 <DT><PRE>public class <B>Utils</B><DT>extends java.lang.Object</DL>
 100 </PRE>
 101
 102 <P>
 103 Class providing some tools to the library
 104 <P>
 105
 106 <P>
 107 <DL>
 108 <DT><B>Author:</B></DT>
 109   <DD>S&eacute;astien Miqu&eacute;e</DD>
 110 </DL>
 111 <HR>
 112
 113 <P>
 114
 115 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 116
 117 <A NAME="constructor_summary"><!-- --></A>
 118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 120 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 121 <B>Constructor Summary</B></FONT></TH>
 122 </TR>
 123 <TR BGCOLOR="white" CLASS="TableRowColor">
 124 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#Utils()">Utils</A></B>()</CODE>
 125
 126 <BR>
 127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 128 </TR>
 129 </TABLE>
 130 &nbsp;
 131 <!-- ========== METHOD SUMMARY =========== -->
 132
 133 <A NAME="method_summary"><!-- --></A>
 134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 135 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 136 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 137 <B>Method Summary</B></FONT></TH>
 138 </TR>
 139 <TR BGCOLOR="white" CLASS="TableRowColor">
 140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 141 <CODE>static&nbsp;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A></CODE></FONT></TD>
 142 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#createGNode()">createGNode</A></B>()</CODE>
 143
 144 <BR>
 145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creation of the representation of the node in the Mapping point of view.</TD>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 149 <CODE>static&nbsp;<A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A></CODE></FONT></TD>
 150 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#createGridG5k(java.util.ArrayList)">createGridG5k</A></B>(java.util.ArrayList&lt;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A>&gt;&nbsp;_an)</CODE>
 151
 152 <BR>
 153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creation of the representation of the grid, according to clusters into sites.</TD>
 154 </TR>
 155 <TR BGCOLOR="white" CLASS="TableRowColor">
 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 157 <CODE>static&nbsp;<A HREF="../../and/Mapping/Graph.html" title="class in and.Mapping">Graph</A></CODE></FONT></TD>
 158 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#readGraph(java.lang.String)">readGraph</A></B>(java.lang.String&nbsp;_file)</CODE>
 159
 160 <BR>
 161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read an application Graph from a file.</TD>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 165 <CODE>static&nbsp;<A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A></CODE></FONT></TD>
 166 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#readGrid(java.lang.String)">readGrid</A></B>(java.lang.String&nbsp;_file)</CODE>
 167
 168 <BR>
 169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read a Grid graph from a file.</TD>
 170 </TR>
 171 <TR BGCOLOR="white" CLASS="TableRowColor">
 172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 173 <CODE>static&nbsp;void</CODE></FONT></TD>
 174 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#writeGraph(and.Mapping.Graph, java.lang.String, java.lang.String)">writeGraph</A></B>(<A HREF="../../and/Mapping/Graph.html" title="class in and.Mapping">Graph</A>&nbsp;_gr,
 175            java.lang.String&nbsp;_file,
 176            java.lang.String&nbsp;_path)</CODE>
 177
 178 <BR>
 179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write an application Graph in a file.</TD>
 180 </TR>
 181 <TR BGCOLOR="white" CLASS="TableRowColor">
 182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 183 <CODE>static&nbsp;void</CODE></FONT></TD>
 184 <TD><CODE><B><A HREF="../../and/Mapping/Utils.html#writeGrid(and.Mapping.Grid, java.lang.String, java.lang.String)">writeGrid</A></B>(<A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A>&nbsp;_gl,
 185           java.lang.String&nbsp;_file,
 186           java.lang.String&nbsp;_path)</CODE>
 187
 188 <BR>
 189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write the Grid object in an XML file.</TD>
 190 </TR>
 191 </TABLE>
 192 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 194 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 195 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 196 </TR>
 197 <TR BGCOLOR="white" CLASS="TableRowColor">
 198 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 199 </TR>
 200 </TABLE>
 201 &nbsp;
 202 <P>
 203
 204 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 205
 206 <A NAME="constructor_detail"><!-- --></A>
 207 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 208 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 209 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 210 <B>Constructor Detail</B></FONT></TH>
 211 </TR>
 212 </TABLE>
 213
 214 <A NAME="Utils()"><!-- --></A><H3>
 215 Utils</H3>
 216 <PRE>
 217 public <B>Utils</B>()</PRE>
 218 <DL>
 219 </DL>
 220
 221 <!-- ============ METHOD DETAIL ========== -->
 222
 223 <A NAME="method_detail"><!-- --></A>
 224 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 225 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 226 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 227 <B>Method Detail</B></FONT></TH>
 228 </TR>
 229 </TABLE>
 230
 231 <A NAME="createGNode()"><!-- --></A><H3>
 232 createGNode</H3>
 233 <PRE>
 234 public static <A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A> <B>createGNode</B>()</PRE>
 235 <DL>
 236 <DD>Creation of the representation of the node in the Mapping point of view. It needs
 237  some information about the computing node, which will be exploited by mapping
 238  algorithms.
 239 <P>
 240 <DD><DL>
 241
 242 <DT><B>Returns:</B><DD>A node from the Mapping library</DL>
 243 </DD>
 244 </DL>
 245 <HR>
 246
 247 <A NAME="createGridG5k(java.util.ArrayList)"><!-- --></A><H3>
 248 createGridG5k</H3>
 249 <PRE>
 250 public static <A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A> <B>createGridG5k</B>(java.util.ArrayList&lt;<A HREF="../../and/Mapping/GNode.html" title="class in and.Mapping">GNode</A>&gt;&nbsp;_an)</PRE>
 251 <DL>
 252 <DD>Creation of the representation of the grid, according to clusters into sites.
 253  This representation may only fit on Grid'5000 like architectures (with computing
 254  nodes name based on the following pattern |cluster_name|id_of_node_into_cluster|.|site_of_cluster|.|organisation|.*|).
 255 <P>
 256 <DD><DL>
 257 <DT><B>Parameters:</B><DD><CODE>_an</CODE> - the list of computing nodes connected
 258 <DT><B>Returns:</B><DD>the grid's architecture</DL>
 259 </DD>
 260 </DL>
 261 <HR>
 262
 263 <A NAME="writeGrid(and.Mapping.Grid, java.lang.String, java.lang.String)"><!-- --></A><H3>
 264 writeGrid</H3>
 265 <PRE>
 266 public static void <B>writeGrid</B>(<A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A>&nbsp;_gl,
 267                              java.lang.String&nbsp;_file,
 268                              java.lang.String&nbsp;_path)</PRE>
 269 <DL>
 270 <DD>Write the Grid object in an XML file.
 271 <P>
 272 <DD><DL>
 273 <DT><B>Parameters:</B><DD><CODE>_gl</CODE> - Grid graph to be write<DD><CODE>_file</CODE> - File's name<DD><CODE>_path</CODE> - File's path</DL>
 274 </DD>
 275 </DL>
 276 <HR>
 277
 278 <A NAME="writeGraph(and.Mapping.Graph, java.lang.String, java.lang.String)"><!-- --></A><H3>
 279 writeGraph</H3>
 280 <PRE>
 281 public static void <B>writeGraph</B>(<A HREF="../../and/Mapping/Graph.html" title="class in and.Mapping">Graph</A>&nbsp;_gr,
 282                               java.lang.String&nbsp;_file,
 283                               java.lang.String&nbsp;_path)</PRE>
 284 <DL>
 285 <DD>Write an application Graph in a file.
 286 <P>
 287 <DD><DL>
 288 <DT><B>Parameters:</B><DD><CODE>_gr</CODE> - Application Graph to be write<DD><CODE>_file</CODE> - File's name<DD><CODE>_path</CODE> - File's path</DL>
 289 </DD>
 290 </DL>
 291 <HR>
 292
 293 <A NAME="readGraph(java.lang.String)"><!-- --></A><H3>
 294 readGraph</H3>
 295 <PRE>
 296 public static <A HREF="../../and/Mapping/Graph.html" title="class in and.Mapping">Graph</A> <B>readGraph</B>(java.lang.String&nbsp;_file)</PRE>
 297 <DL>
 298 <DD>Read an application Graph from a file.
 299 <P>
 300 <DD><DL>
 301 <DT><B>Parameters:</B><DD><CODE>_file</CODE> - File's name
 302 <DT><B>Returns:</B><DD>The application Graph read</DL>
 303 </DD>
 304 </DL>
 305 <HR>
 306
 307 <A NAME="readGrid(java.lang.String)"><!-- --></A><H3>
 308 readGrid</H3>
 309 <PRE>
 310 public static <A HREF="../../and/Mapping/Grid.html" title="class in and.Mapping">Grid</A> <B>readGrid</B>(java.lang.String&nbsp;_file)</PRE>
 311 <DL>
 312 <DD>Read a Grid graph from a file.
 313 <P>
 314 <DD><DL>
 315 <DT><B>Parameters:</B><DD><CODE>_file</CODE> - File's name
 316 <DT><B>Returns:</B><DD>The Grid graph read</DL>
 317 </DD>
 318 </DL>
 319 <!-- ========= END OF CLASS DATA ========= -->
 320 <HR>
 321
 322
 323 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 324 <A NAME="navbar_bottom"><!-- --></A>
 325 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 326 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 327 <TR>
 328 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 329 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 330 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 331   <TR ALIGN="center" VALIGN="top">
 332   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../and/Mapping/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 333   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 334   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Utils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 335   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 336   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 337   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 338   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 339   </TR>
 340 </TABLE>
 341 </TD>
 342 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 343 </EM>
 344 </TD>
 345 </TR>
 346
 347 <TR>
 348 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 349 &nbsp;<A HREF="../../and/Mapping/Simple.html" title="class in and.Mapping"><B>PREV CLASS</B></A>&nbsp;
 350 &nbsp;NEXT CLASS</FONT></TD>
 351 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 352   <A HREF="../../index.html?and/Mapping/Utils.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 353 &nbsp;<A HREF="Utils.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 354 &nbsp;<SCRIPT type="text/javascript">
 355   <!--
 356   if(window==top) {
 357     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 358   }
 359   //-->
 360 </SCRIPT>
 361 <NOSCRIPT>
 362   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 363 </NOSCRIPT>
 364
 365
 366 </FONT></TD>
 367 </TR>
 368 <TR>
 369 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 370   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 371 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 372 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 373 </TR>
 374 </TABLE>
 375 <A NAME="skip-navbar_bottom"></A>
 376 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 377
 378 <HR>
 379
 380 </BODY>
 381 </HTML>