1 <?xml version="1.0" encoding="ascii"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
5 <head> |
|
6 <title>graph.readwrite</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 <!-- Home link --> |
|
18 <th> <a |
|
19 href="graph-module.html">Home</a> </th> |
|
20 |
|
21 <!-- Tree link --> |
|
22 <th> <a |
|
23 href="module-tree.html">Trees</a> </th> |
|
24 |
|
25 <!-- Index link --> |
|
26 <th> <a |
|
27 href="identifier-index.html">Indices</a> </th> |
|
28 |
|
29 <!-- Help link --> |
|
30 <th> <a |
|
31 href="help.html">Help</a> </th> |
|
32 |
|
33 <!-- Project homepage --> |
|
34 <th class="navbar" align="right" width="100%"> |
|
35 <table border="0" cellpadding="0" cellspacing="0"> |
|
36 <tr><th class="navbar" align="center" |
|
37 ><a class="navbar" target="_top" href="http://code.google.com/p/python-graph/">python-graph</a></th> |
|
38 </tr></table></th> |
|
39 </tr> |
|
40 </table> |
|
41 <table width="100%" cellpadding="0" cellspacing="0"> |
|
42 <tr valign="top"> |
|
43 <td width="100%"> |
|
44 <span class="breadcrumbs"> |
|
45 <a href="graph-module.html">Package graph</a> :: |
|
46 Module readwrite |
|
47 </span> |
|
48 </td> |
|
49 <td> |
|
50 <table cellpadding="0" cellspacing="0"> |
|
51 <!-- hide/show private --> |
|
52 </table> |
|
53 </td> |
|
54 </tr> |
|
55 </table> |
|
56 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
57 <h1 class="epydoc">Module readwrite</h1><p class="nomargin-top"></p> |
|
58 <p>Functions for reading and writing graphs.</p> |
|
59 |
|
60 <!-- ==================== FUNCTIONS ==================== --> |
|
61 <a name="section-Functions"></a> |
|
62 <table class="summary" border="1" cellpadding="3" |
|
63 cellspacing="0" width="100%" bgcolor="white"> |
|
64 <tr bgcolor="#70b0f0" class="table-header"> |
|
65 <td align="left" colspan="2" class="table-header"> |
|
66 <span class="table-header">Functions</span></td> |
|
67 </tr> |
|
68 <tr> |
|
69 <td width="15%" align="right" valign="top" class="summary"> |
|
70 <span class="summary-type"> </span> |
|
71 </td><td class="summary"> |
|
72 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
73 <tr> |
|
74 <td><span class="summary-sig"><a href="graph.readwrite-module.html#read_xml" class="summary-sig-name">read_xml</a>(<span class="summary-sig-arg">graph</span>, |
|
75 <span class="summary-sig-arg">string</span>)</span><br /> |
|
76 Read a graph from a XML document.</td> |
|
77 <td align="right" valign="top"> |
|
78 |
|
79 |
|
80 </td> |
|
81 </tr> |
|
82 </table> |
|
83 |
|
84 </td> |
|
85 </tr> |
|
86 <tr> |
|
87 <td width="15%" align="right" valign="top" class="summary"> |
|
88 <span class="summary-type">string</span> |
|
89 </td><td class="summary"> |
|
90 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
91 <tr> |
|
92 <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_xml" class="summary-sig-name">write_xml</a>(<span class="summary-sig-arg">graph</span>)</span><br /> |
|
93 Return a string specifying the given graph as a XML document.</td> |
|
94 <td align="right" valign="top"> |
|
95 |
|
96 |
|
97 </td> |
|
98 </tr> |
|
99 </table> |
|
100 |
|
101 </td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td width="15%" align="right" valign="top" class="summary"> |
|
105 <span class="summary-type">string</span> |
|
106 </td><td class="summary"> |
|
107 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
108 <tr> |
|
109 <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_dot_graph" class="summary-sig-name">write_dot_graph</a>(<span class="summary-sig-arg">graph</span>, |
|
110 <span class="summary-sig-arg">wt</span>)</span><br /> |
|
111 Return a string specifying the given graph in DOT Language.</td> |
|
112 <td align="right" valign="top"> |
|
113 |
|
114 |
|
115 </td> |
|
116 </tr> |
|
117 </table> |
|
118 |
|
119 </td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td width="15%" align="right" valign="top" class="summary"> |
|
123 <span class="summary-type">string</span> |
|
124 </td><td class="summary"> |
|
125 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
126 <tr> |
|
127 <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_dot_digraph" class="summary-sig-name">write_dot_digraph</a>(<span class="summary-sig-arg">graph</span>, |
|
128 <span class="summary-sig-arg">wt</span>)</span><br /> |
|
129 Return a string specifying the given digraph in DOT Language.</td> |
|
130 <td align="right" valign="top"> |
|
131 |
|
132 |
|
133 </td> |
|
134 </tr> |
|
135 </table> |
|
136 |
|
137 </td> |
|
138 </tr> |
|
139 <tr> |
|
140 <td width="15%" align="right" valign="top" class="summary"> |
|
141 <span class="summary-type">string</span> |
|
142 </td><td class="summary"> |
|
143 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
144 <tr> |
|
145 <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_dot_hypergraph" class="summary-sig-name">write_dot_hypergraph</a>(<span class="summary-sig-arg">hypergraph</span>, |
|
146 <span class="summary-sig-arg">coloured</span>=<span class="summary-sig-default">False</span>)</span><br /> |
|
147 Return a string specifying the given hypergraph in DOT Language.</td> |
|
148 <td align="right" valign="top"> |
|
149 |
|
150 |
|
151 </td> |
|
152 </tr> |
|
153 </table> |
|
154 |
|
155 </td> |
|
156 </tr> |
|
157 <tr> |
|
158 <td width="15%" align="right" valign="top" class="summary"> |
|
159 <span class="summary-type">string</span> |
|
160 </td><td class="summary"> |
|
161 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
162 <tr> |
|
163 <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_xml_hypergraph" class="summary-sig-name">write_xml_hypergraph</a>(<span class="summary-sig-arg">hypergraph</span>)</span><br /> |
|
164 Return a string specifying the given hypergraph as a XML document.</td> |
|
165 <td align="right" valign="top"> |
|
166 |
|
167 |
|
168 </td> |
|
169 </tr> |
|
170 </table> |
|
171 |
|
172 </td> |
|
173 </tr> |
|
174 <tr> |
|
175 <td width="15%" align="right" valign="top" class="summary"> |
|
176 <span class="summary-type"> </span> |
|
177 </td><td class="summary"> |
|
178 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
179 <tr> |
|
180 <td><span class="summary-sig"><a href="graph.readwrite-module.html#read_xml_hypergraph" class="summary-sig-name">read_xml_hypergraph</a>(<span class="summary-sig-arg">hypergraph</span>, |
|
181 <span class="summary-sig-arg">string</span>)</span><br /> |
|
182 Read a graph from a XML document.</td> |
|
183 <td align="right" valign="top"> |
|
184 |
|
185 |
|
186 </td> |
|
187 </tr> |
|
188 </table> |
|
189 |
|
190 </td> |
|
191 </tr> |
|
192 </table> |
|
193 <!-- ==================== VARIABLES ==================== --> |
|
194 <a name="section-Variables"></a> |
|
195 <table class="summary" border="1" cellpadding="3" |
|
196 cellspacing="0" width="100%" bgcolor="white"> |
|
197 <tr bgcolor="#70b0f0" class="table-header"> |
|
198 <td align="left" colspan="2" class="table-header"> |
|
199 <span class="table-header">Variables</span></td> |
|
200 </tr> |
|
201 <tr> |
|
202 <td width="15%" align="right" valign="top" class="summary"> |
|
203 <span class="summary-type"> </span> |
|
204 </td><td class="summary"> |
|
205 <a href="graph.readwrite-module.html#colors" class="summary-name">colors</a> = <code title="['aquamarine4', |
|
206 'blue4', |
|
207 'brown4', |
|
208 'cornflowerblue', |
|
209 'cyan4', |
|
210 'darkgreen', |
|
211 'darkorange3', |
|
212 'darkorchid4', |
|
213 ..."><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">aquamarine4</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">blue4</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">brown4</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">cornflowerblue</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></code> |
|
214 </td> |
|
215 </tr> |
|
216 </table> |
|
217 <!-- ==================== FUNCTION DETAILS ==================== --> |
|
218 <a name="section-FunctionDetails"></a> |
|
219 <table class="details" border="1" cellpadding="3" |
|
220 cellspacing="0" width="100%" bgcolor="white"> |
|
221 <tr bgcolor="#70b0f0" class="table-header"> |
|
222 <td align="left" colspan="2" class="table-header"> |
|
223 <span class="table-header">Function Details</span></td> |
|
224 </tr> |
|
225 </table> |
|
226 <a name="read_xml"></a> |
|
227 <div> |
|
228 <table class="details" border="1" cellpadding="3" |
|
229 cellspacing="0" width="100%" bgcolor="white"> |
|
230 <tr><td> |
|
231 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
232 <tr valign="top"><td> |
|
233 <h3 class="epydoc"><span class="sig"><span class="sig-name">read_xml</span>(<span class="sig-arg">graph</span>, |
|
234 <span class="sig-arg">string</span>)</span> |
|
235 </h3> |
|
236 </td><td align="right" valign="top" |
|
237 > |
|
238 </td> |
|
239 </tr></table> |
|
240 |
|
241 <p>Read a graph from a XML document. Nodes and edges specified in the |
|
242 input will be added to the current graph.</p> |
|
243 <dl class="fields"> |
|
244 <dt>Parameters:</dt> |
|
245 <dd><ul class="nomargin-top"> |
|
246 <li><strong class="pname"><code>graph</code></strong> (graph) - Graph</li> |
|
247 <li><strong class="pname"><code>string</code></strong> (string) - Input string in XML format specifying a graph.</li> |
|
248 </ul></dd> |
|
249 </dl> |
|
250 </td></tr></table> |
|
251 </div> |
|
252 <a name="write_xml"></a> |
|
253 <div> |
|
254 <table class="details" border="1" cellpadding="3" |
|
255 cellspacing="0" width="100%" bgcolor="white"> |
|
256 <tr><td> |
|
257 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
258 <tr valign="top"><td> |
|
259 <h3 class="epydoc"><span class="sig"><span class="sig-name">write_xml</span>(<span class="sig-arg">graph</span>)</span> |
|
260 </h3> |
|
261 </td><td align="right" valign="top" |
|
262 > |
|
263 </td> |
|
264 </tr></table> |
|
265 |
|
266 <p>Return a string specifying the given graph as a XML document.</p> |
|
267 <dl class="fields"> |
|
268 <dt>Parameters:</dt> |
|
269 <dd><ul class="nomargin-top"> |
|
270 <li><strong class="pname"><code>graph</code></strong> (graph) - Graph.</li> |
|
271 </ul></dd> |
|
272 <dt>Returns: string</dt> |
|
273 <dd>String specifying the graph as a XML document.</dd> |
|
274 </dl> |
|
275 </td></tr></table> |
|
276 </div> |
|
277 <a name="write_dot_graph"></a> |
|
278 <div> |
|
279 <table class="details" border="1" cellpadding="3" |
|
280 cellspacing="0" width="100%" bgcolor="white"> |
|
281 <tr><td> |
|
282 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
283 <tr valign="top"><td> |
|
284 <h3 class="epydoc"><span class="sig"><span class="sig-name">write_dot_graph</span>(<span class="sig-arg">graph</span>, |
|
285 <span class="sig-arg">wt</span>)</span> |
|
286 </h3> |
|
287 </td><td align="right" valign="top" |
|
288 > |
|
289 </td> |
|
290 </tr></table> |
|
291 |
|
292 <p>Return a string specifying the given graph in DOT Language.</p> |
|
293 <dl class="fields"> |
|
294 <dt>Parameters:</dt> |
|
295 <dd><ul class="nomargin-top"> |
|
296 <li><strong class="pname"><code>graph</code></strong> (graph) - Graph.</li> |
|
297 <li><strong class="pname"><code>wt</code></strong> (boolean) - Whether edges should be labelled with its weight.</li> |
|
298 </ul></dd> |
|
299 <dt>Returns: string</dt> |
|
300 <dd>String specifying the graph in DOT Language.</dd> |
|
301 </dl> |
|
302 </td></tr></table> |
|
303 </div> |
|
304 <a name="write_dot_digraph"></a> |
|
305 <div> |
|
306 <table class="details" border="1" cellpadding="3" |
|
307 cellspacing="0" width="100%" bgcolor="white"> |
|
308 <tr><td> |
|
309 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
310 <tr valign="top"><td> |
|
311 <h3 class="epydoc"><span class="sig"><span class="sig-name">write_dot_digraph</span>(<span class="sig-arg">graph</span>, |
|
312 <span class="sig-arg">wt</span>)</span> |
|
313 </h3> |
|
314 </td><td align="right" valign="top" |
|
315 > |
|
316 </td> |
|
317 </tr></table> |
|
318 |
|
319 <p>Return a string specifying the given digraph in DOT Language.</p> |
|
320 <dl class="fields"> |
|
321 <dt>Parameters:</dt> |
|
322 <dd><ul class="nomargin-top"> |
|
323 <li><strong class="pname"><code>graph</code></strong> (graph) - Graph.</li> |
|
324 <li><strong class="pname"><code>wt</code></strong> (boolean) - Whether arrows should be labelled with its weight.</li> |
|
325 </ul></dd> |
|
326 <dt>Returns: string</dt> |
|
327 <dd>String specifying the graph in DOT Language.</dd> |
|
328 </dl> |
|
329 </td></tr></table> |
|
330 </div> |
|
331 <a name="write_dot_hypergraph"></a> |
|
332 <div> |
|
333 <table class="details" border="1" cellpadding="3" |
|
334 cellspacing="0" width="100%" bgcolor="white"> |
|
335 <tr><td> |
|
336 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
337 <tr valign="top"><td> |
|
338 <h3 class="epydoc"><span class="sig"><span class="sig-name">write_dot_hypergraph</span>(<span class="sig-arg">hypergraph</span>, |
|
339 <span class="sig-arg">coloured</span>=<span class="sig-default">False</span>)</span> |
|
340 </h3> |
|
341 </td><td align="right" valign="top" |
|
342 > |
|
343 </td> |
|
344 </tr></table> |
|
345 |
|
346 <p>Return a string specifying the given hypergraph in DOT Language.</p> |
|
347 <dl class="fields"> |
|
348 <dt>Parameters:</dt> |
|
349 <dd><ul class="nomargin-top"> |
|
350 <li><strong class="pname"><code>hypergraph</code></strong> (hypergraph) - Hypergraph.</li> |
|
351 <li><strong class="pname"><code>coloured</code></strong> (boolean) - Whether hyperedges should be coloured.</li> |
|
352 </ul></dd> |
|
353 <dt>Returns: string</dt> |
|
354 <dd>String specifying the hypergraph in DOT Language.</dd> |
|
355 </dl> |
|
356 </td></tr></table> |
|
357 </div> |
|
358 <a name="write_xml_hypergraph"></a> |
|
359 <div> |
|
360 <table class="details" border="1" cellpadding="3" |
|
361 cellspacing="0" width="100%" bgcolor="white"> |
|
362 <tr><td> |
|
363 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
364 <tr valign="top"><td> |
|
365 <h3 class="epydoc"><span class="sig"><span class="sig-name">write_xml_hypergraph</span>(<span class="sig-arg">hypergraph</span>)</span> |
|
366 </h3> |
|
367 </td><td align="right" valign="top" |
|
368 > |
|
369 </td> |
|
370 </tr></table> |
|
371 |
|
372 <p>Return a string specifying the given hypergraph as a XML document.</p> |
|
373 <dl class="fields"> |
|
374 <dt>Parameters:</dt> |
|
375 <dd><ul class="nomargin-top"> |
|
376 <li><strong class="pname"><code>hypergraph</code></strong> (hypergraph) - Hypergraph.</li> |
|
377 </ul></dd> |
|
378 <dt>Returns: string</dt> |
|
379 <dd>String specifying the graph as a XML document.</dd> |
|
380 </dl> |
|
381 </td></tr></table> |
|
382 </div> |
|
383 <a name="read_xml_hypergraph"></a> |
|
384 <div> |
|
385 <table class="details" border="1" cellpadding="3" |
|
386 cellspacing="0" width="100%" bgcolor="white"> |
|
387 <tr><td> |
|
388 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
389 <tr valign="top"><td> |
|
390 <h3 class="epydoc"><span class="sig"><span class="sig-name">read_xml_hypergraph</span>(<span class="sig-arg">hypergraph</span>, |
|
391 <span class="sig-arg">string</span>)</span> |
|
392 </h3> |
|
393 </td><td align="right" valign="top" |
|
394 > |
|
395 </td> |
|
396 </tr></table> |
|
397 |
|
398 <p>Read a graph from a XML document. Nodes and hyperedges specified in |
|
399 the input will be added to the current graph.</p> |
|
400 <dl class="fields"> |
|
401 <dt>Parameters:</dt> |
|
402 <dd><ul class="nomargin-top"> |
|
403 <li><strong class="pname"><code>hypergraph</code></strong> (hypergraph) - Hypergraph</li> |
|
404 <li><strong class="pname"><code>string</code></strong> (string) - Input string in XML format specifying a graph.</li> |
|
405 </ul></dd> |
|
406 </dl> |
|
407 </td></tr></table> |
|
408 </div> |
|
409 <br /> |
|
410 <!-- ==================== VARIABLES DETAILS ==================== --> |
|
411 <a name="section-VariablesDetails"></a> |
|
412 <table class="details" border="1" cellpadding="3" |
|
413 cellspacing="0" width="100%" bgcolor="white"> |
|
414 <tr bgcolor="#70b0f0" class="table-header"> |
|
415 <td align="left" colspan="2" class="table-header"> |
|
416 <span class="table-header">Variables Details</span></td> |
|
417 </tr> |
|
418 </table> |
|
419 <a name="colors"></a> |
|
420 <div> |
|
421 <table class="details" border="1" cellpadding="3" |
|
422 cellspacing="0" width="100%" bgcolor="white"> |
|
423 <tr><td> |
|
424 <h3 class="epydoc">colors</h3> |
|
425 |
|
426 <dl class="fields"> |
|
427 </dl> |
|
428 <dl class="fields"> |
|
429 <dt>Value:</dt> |
|
430 <dd><table><tr><td><pre class="variable"> |
|
431 <code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">aquamarine4</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
432 <code class="variable-quote">'</code><code class="variable-string">blue4</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
433 <code class="variable-quote">'</code><code class="variable-string">brown4</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
434 <code class="variable-quote">'</code><code class="variable-string">cornflowerblue</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
435 <code class="variable-quote">'</code><code class="variable-string">cyan4</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
436 <code class="variable-quote">'</code><code class="variable-string">darkgreen</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
437 <code class="variable-quote">'</code><code class="variable-string">darkorange3</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
438 <code class="variable-quote">'</code><code class="variable-string">darkorchid4</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
|
439 <code class="variable-ellipsis">...</code> |
|
440 </pre></td></tr></table> |
|
441 </dd> |
|
442 </dl> |
|
443 </td></tr></table> |
|
444 </div> |
|
445 <br /> |
|
446 <!-- ==================== NAVIGATION BAR ==================== --> |
|
447 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
448 bgcolor="#a0c0ff" cellspacing="0"> |
|
449 <tr valign="middle"> |
|
450 <!-- Home link --> |
|
451 <th> <a |
|
452 href="graph-module.html">Home</a> </th> |
|
453 |
|
454 <!-- Tree link --> |
|
455 <th> <a |
|
456 href="module-tree.html">Trees</a> </th> |
|
457 |
|
458 <!-- Index link --> |
|
459 <th> <a |
|
460 href="identifier-index.html">Indices</a> </th> |
|
461 |
|
462 <!-- Help link --> |
|
463 <th> <a |
|
464 href="help.html">Help</a> </th> |
|
465 |
|
466 <!-- Project homepage --> |
|
467 <th class="navbar" align="right" width="100%"> |
|
468 <table border="0" cellpadding="0" cellspacing="0"> |
|
469 <tr><th class="navbar" align="center" |
|
470 ><a class="navbar" target="_top" href="http://code.google.com/p/python-graph/">python-graph</a></th> |
|
471 </tr></table></th> |
|
472 </tr> |
|
473 </table> |
|
474 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
475 <tr> |
|
476 <td align="left" class="footer"> |
|
477 Generated by Epydoc 3.0.1 on Mon Oct 27 20:36:37 2008 |
|
478 </td> |
|
479 <td align="right" class="footer"> |
|
480 <a target="mainFrame" href="http://epydoc.sourceforge.net" |
|
481 >http://epydoc.sourceforge.net</a> |
|
482 </td> |
|
483 </tr> |
|
484 </table> |
|
485 |
|
486 <script type="text/javascript"> |
|
487 <!-- |
|
488 // Private objects are initially displayed (because if |
|
489 // javascript is turned off then we want them to be |
|
490 // visible); but by default, we want to hide them. So hide |
|
491 // them unless we have a cookie that says to show them. |
|
492 checkCookie(); |
|
493 // --> |
|
494 </script> |
|
495 </body> |
|
496 </html> |
|