Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 1280a9d763ea6574bb6098d1ca3767c9 > files > 75

ocaml-ocamlgraph-doc-1.1-1mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Flow.html">
<link rel="next" href="Gml.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Sig" rel="Chapter" href="Sig.html">
<link title="Sig_pack" rel="Chapter" href="Sig_pack.html">
<link title="Dot_ast" rel="Chapter" href="Dot_ast.html">
<link title="Util" rel="Chapter" href="Util.html">
<link title="Persistent" rel="Chapter" href="Persistent.html">
<link title="Imperative" rel="Chapter" href="Imperative.html">
<link title="Delaunay" rel="Chapter" href="Delaunay.html">
<link title="Builder" rel="Chapter" href="Builder.html">
<link title="Classic" rel="Chapter" href="Classic.html">
<link title="Rand" rel="Chapter" href="Rand.html">
<link title="Oper" rel="Chapter" href="Oper.html">
<link title="Path" rel="Chapter" href="Path.html">
<link title="Traverse" rel="Chapter" href="Traverse.html">
<link title="Coloring" rel="Chapter" href="Coloring.html">
<link title="Topological" rel="Chapter" href="Topological.html">
<link title="Components" rel="Chapter" href="Components.html">
<link title="Kruskal" rel="Chapter" href="Kruskal.html">
<link title="Flow" rel="Chapter" href="Flow.html">
<link title="Graphviz" rel="Chapter" href="Graphviz.html">
<link title="Gml" rel="Chapter" href="Gml.html">
<link title="Dot" rel="Chapter" href="Dot.html">
<link title="Pack" rel="Chapter" href="Pack.html">
<link title="Gmap" rel="Chapter" href="Gmap.html">
<link title="Minsep" rel="Chapter" href="Minsep.html">
<link title="Cliquetree" rel="Chapter" href="Cliquetree.html">
<link title="Mcs_m" rel="Chapter" href="Mcs_m.html">
<link title="Md" rel="Chapter" href="Md.html">
<link title="Strat" rel="Chapter" href="Strat.html"><link title="Common stuff" rel="Section" href="#2_Commonstuff">
<link title="Interface with the dot engine" rel="Section" href="#2_Interfacewiththedotengine">
<link title="The neato engine" rel="Section" href="#2_Theneatoengine">
<link title="Common types and signatures" rel="Subsection" href="#3_Commontypesandsignatures">
<link title="Common attributes" rel="Subsection" href="#3_Commonattributes">
<title>Graphviz</title>
</head>
<body>
<div class="navbar"><a href="Flow.html">Previous</a>
&nbsp;<a href="index.html">Up</a>
&nbsp;<a href="Gml.html">Next</a>
</div>
<center><h1>Module <a href="type_Graphviz.html">Graphviz</a></h1></center>
<br>
<pre><span class="keyword">module</span> Graphviz: <code class="code">sig</code> <a href="Graphviz.html">..</a> <code class="code">end</code></pre>Interface with <i>GraphViz</i>
<p>

    This module provides a basic interface with dot and neato,
    two programs of the GraphViz toolbox.
    These tools are available at the following URLs:<ul>
<li><pre>http://www.graphviz.org</pre></li>
<li><pre>http://www.research.att.com/sw/tools/graphviz</pre></li>
</ul>
<br>
<hr width="100%">
<br>
<a name="2_Commonstuff"></a>
<h2>Common stuff</h2><br>
<br>
Because the neato and dot engines present a lot of common points -
    in particular in the graph description language, large parts of
    the code is shared.  The <code class="code">CommonAttributes</code> module defines
    attributes of graphs, vertices and edges that are understood by the
    two engines.  Then module <code class="code">DotAttributes</code> and <code class="code">NeatoAttributes</code>
    define attributes specific to dot and neato respectively.<br>
<br>
<a name="3_Commontypesandsignatures"></a>
<h3>Common types and signatures</h3><br>
<pre><span class="keyword">type</span> <a name="TYPEcolor"></a><code class="type"></code>color = <code class="type">int</code> </pre>

<pre><span class="keyword">type</span> <a name="TYPEarrow_style"></a><code class="type"></code>arrow_style = <code class="type">[ `Dot | `Inv | `Invdot | `Invodot | `None | `Normal | `Odot ]</code> </pre>

<pre><span class="keyword">module type</span> <a href="Graphviz.ATTRIBUTES.html">ATTRIBUTES</a> = <code class="code">sig</code> <a href="Graphviz.ATTRIBUTES.html">..</a> <code class="code">end</code></pre><div class="info">
The <code class="code">ATTRIBUTES</code> module type defines the interface for the engines.
</div>
<br>
<a name="3_Commonattributes"></a>
<h3>Common attributes</h3><br>
<pre><span class="keyword">module</span> <a href="Graphviz.CommonAttributes.html">CommonAttributes</a>: <code class="code">sig</code> <a href="Graphviz.CommonAttributes.html">..</a> <code class="code">end</code></pre><div class="info">
The <code class="code">CommonAttributes</code> module defines attributes for graphs, vertices and
    edges that are available in the two engines, dot and neato.
</div>
<br>
<a name="2_Interfacewiththedotengine"></a>
<h2>Interface with the dot engine</h2><br>
<pre><span class="keyword">module</span> <a href="Graphviz.DotAttributes.html">DotAttributes</a>: <code class="code">sig</code> <a href="Graphviz.DotAttributes.html">..</a> <code class="code">end</code></pre><div class="info">
<code class="code">DotAttributes</code> extends <code class="code">CommonAttributes</code> and implements <code class="code">ATTRIBUTES</code>.
</div>
<pre><span class="keyword">module</span> <a href="Graphviz.Dot.html">Dot</a>: <div class="sig_block"><code class="code">functor (</code><code class="code">X</code><code class="code"> : </code><code class="code">sig</code><div class="sig_block"><br>
Graph implementation. Sub-signature of <code class="code">Sig.G</code><br>
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre>

<pre><span class="keyword">module</span> <a href="Graphviz.Dot.V.html">V</a>: <code class="code">sig</code> <a href="Graphviz.Dot.V.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">module</span> <a href="Graphviz.Dot.E.html">E</a>: <code class="code">sig</code> <a href="Graphviz.Dot.E.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">val</span> <a name="VALiter_vertex"></a>iter_vertex : <code class="type">(V.t -> unit) -> t -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALiter_edges_e"></a>iter_edges_e : <code class="type">(E.t -> unit) -> t -> unit</code></pre><br>
Graph, vertex and edge attributes.<br>
<pre><span class="keyword">val</span> <a name="VALgraph_attributes"></a>graph_attributes : <code class="type">t -> <a href="Graphviz.DotAttributes.html#TYPEgraph">Graphviz.DotAttributes.graph</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALdefault_vertex_attributes"></a>default_vertex_attributes : <code class="type">t -> <a href="Graphviz.DotAttributes.html#TYPEvertex">Graphviz.DotAttributes.vertex</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALvertex_name"></a>vertex_name : <code class="type">V.t -> string</code></pre><pre><span class="keyword">val</span> <a name="VALvertex_attributes"></a>vertex_attributes : <code class="type">V.t -> <a href="Graphviz.DotAttributes.html#TYPEvertex">Graphviz.DotAttributes.vertex</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALget_subgraph"></a>get_subgraph : <code class="type">V.t -> <a href="Graphviz.DotAttributes.html#TYPEsubgraph">Graphviz.DotAttributes.subgraph</a> option</code></pre><div class="info">
The box (if exists) which the vertex belongs to. Boxes with same
	   names are not distinguished and so they should have the same
	   attributes.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdefault_edge_attributes"></a>default_edge_attributes : <code class="type">t -> <a href="Graphviz.DotAttributes.html#TYPEedge">Graphviz.DotAttributes.edge</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALedge_attributes"></a>edge_attributes : <code class="type">E.t -> <a href="Graphviz.DotAttributes.html#TYPEedge">Graphviz.DotAttributes.edge</a> list</code></pre></div><code class="code">end</code><code class="code">) -&gt; </code><code class="code">sig</code> <a href="Graphviz.Dot.html">..</a> <code class="code">end</code></div></pre><br>
<a name="2_Theneatoengine"></a>
<h2>The neato engine</h2><br>
<pre><span class="keyword">module</span> <a href="Graphviz.NeatoAttributes.html">NeatoAttributes</a>: <code class="code">sig</code> <a href="Graphviz.NeatoAttributes.html">..</a> <code class="code">end</code></pre><div class="info">
The <code class="code">NeatoAttributes</code> module defines attributes for graphs, nodes and edges
    that are available in the neato engine.
</div>
<pre><span class="keyword">module</span> <a href="Graphviz.Neato.html">Neato</a>: <div class="sig_block"><code class="code">functor (</code><code class="code">X</code><code class="code"> : </code><code class="code">sig</code><div class="sig_block"><br>
Graph implementation. Sub-signature of <code class="code">Sig.G</code>.<br>
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre>

<pre><span class="keyword">module</span> <a href="Graphviz.Neato.V.html">V</a>: <code class="code">sig</code> <a href="Graphviz.Neato.V.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">module</span> <a href="Graphviz.Neato.E.html">E</a>: <code class="code">sig</code> <a href="Graphviz.Neato.E.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">val</span> <a name="VALiter_vertex"></a>iter_vertex : <code class="type">(V.t -> unit) -> t -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALiter_edges_e"></a>iter_edges_e : <code class="type">(E.t -> unit) -> t -> unit</code></pre><br>
Graph, vertex and edge attributes.<br>
<pre><span class="keyword">val</span> <a name="VALgraph_attributes"></a>graph_attributes : <code class="type">t -> <a href="Graphviz.NeatoAttributes.html#TYPEgraph">Graphviz.NeatoAttributes.graph</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALdefault_vertex_attributes"></a>default_vertex_attributes : <code class="type">t -> <a href="Graphviz.NeatoAttributes.html#TYPEvertex">Graphviz.NeatoAttributes.vertex</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALvertex_name"></a>vertex_name : <code class="type">V.t -> string</code></pre><pre><span class="keyword">val</span> <a name="VALvertex_attributes"></a>vertex_attributes : <code class="type">V.t -> <a href="Graphviz.NeatoAttributes.html#TYPEvertex">Graphviz.NeatoAttributes.vertex</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALget_subgraph"></a>get_subgraph : <code class="type">V.t -> <a href="Graphviz.NeatoAttributes.html#TYPEsubgraph">Graphviz.NeatoAttributes.subgraph</a> option</code></pre><div class="info">
The box (if exists) which the vertex belongs to. Boxes with same
	   names are not distinguished and so they should have the same
	   attributes.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdefault_edge_attributes"></a>default_edge_attributes : <code class="type">t -> <a href="Graphviz.NeatoAttributes.html#TYPEedge">Graphviz.NeatoAttributes.edge</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALedge_attributes"></a>edge_attributes : <code class="type">E.t -> <a href="Graphviz.NeatoAttributes.html#TYPEedge">Graphviz.NeatoAttributes.edge</a> list</code></pre></div><code class="code">end</code><code class="code">) -&gt; </code><code class="code">sig</code> <a href="Graphviz.Neato.html">..</a> <code class="code">end</code></div></pre></body></html>