Logo AND Algorithmique Numérique Distribuée

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