sidekick/sidekick/Sidekick_backend__Dot/index.html
Simon Cruanes 186f167885 update doc
2018-05-09 20:34:17 -05:00

6 lines
No EOL
6.1 KiB
HTML

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sidekick_backend__Dot (sidekick.Sidekick_backend__Dot)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../index.html">sidekick</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">Sidekick_backend__Dot</span></h1></header><p>Dot backend for proofs</p><p>This module provides functions to export proofs into the dot graph format.
Graphs in dot format can be used to generates images using the graphviz tool.</p><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><div class="def module-type"><code><span class="keyword">module type </span><a href="module-type-S/index.html">S</a> = <a href="../Sidekick_backend/Backend_intf/index.html#module-type-S">Sidekick_backend.Backend_intf.S</a></code></div><div class="doc"><p>Interface for exporting proofs.</p></div></div><div class="spec module-type" id="module-type-Arg"><a href="#module-type-Arg" class="anchor"></a><div class="def module-type"><code><span class="keyword">module type </span><a href="module-type-Arg/index.html">Arg</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div><div class="spec module" id="module-Default"><a href="#module-Default" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Default/index.html">Default</a> : <span class="keyword">functor</span> (<a href="Default/argument-1-S/index.html">S</a> : <a href="../Sidekick_sat/Res/index.html#module-type-S">Sidekick_sat.Res.S</a>) -&gt; <a href="index.html#module-type-Arg">Arg</a><span class="keyword"> with </span><span class="keyword">type </span><a href="Default/index.html#type-atom">atom</a> := <a href="Default/argument-1-S/index.html#type-atom">S.atom</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Default/index.html#type-hyp">hyp</a> := <a href="Default/argument-1-S/index.html#type-clause">S.clause</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Default/index.html#type-lemma">lemma</a> := <a href="Default/argument-1-S/index.html#type-clause">S.clause</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Default/index.html#type-assumption">assumption</a> := <a href="Default/argument-1-S/index.html#type-clause">S.clause</a></code></div><div class="doc"><p>Provides a reasonnable default to instantiate the <code class="code">Make</code> functor, assuming
the original printing functions are compatible with DOT html labels.</p></div></div><div class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-S/index.html">S</a> : <a href="../Sidekick_sat/Res/index.html#module-type-S">Sidekick_sat.Res.S</a>) -&gt; <span class="keyword">functor</span> (<a href="Make/argument-2-A/index.html">A</a> : <a href="index.html#module-type-Arg">Arg</a><span class="keyword"> with </span><span class="keyword">type </span><a href="Make/index.html#type-atom">atom</a> := <a href="Make/argument-1-S/index.html#type-atom">S.atom</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Make/index.html#type-hyp">hyp</a> := <a href="Make/argument-1-S/index.html#type-clause">S.clause</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Make/index.html#type-lemma">lemma</a> := <a href="Make/argument-1-S/index.html#type-clause">S.clause</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Make/index.html#type-assumption">assumption</a> := <a href="Make/argument-1-S/index.html#type-clause">S.clause</a>) -&gt; <a href="index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">type </span><a href="Make/index.html#type-t">t</a> := <a href="Make/argument-1-S/index.html#type-proof">S.proof</a></code></div><div class="doc"><p>Functor for making a module to export proofs to the DOT format.</p></div></div><div class="spec module" id="module-Simple"><a href="#module-Simple" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Simple/index.html">Simple</a> : <span class="keyword">functor</span> (<a href="Simple/argument-1-S/index.html">S</a> : <a href="../Sidekick_sat/Res/index.html#module-type-S">Sidekick_sat.Res.S</a>) -&gt; <span class="keyword">functor</span> (<a href="Simple/argument-2-A/index.html">A</a> : <a href="index.html#module-type-Arg">Arg</a><span class="keyword"> with </span><span class="keyword">type </span><a href="Simple/index.html#type-atom">atom</a> := <a href="Simple/argument-1-S/index.html#type-formula">S.formula</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Simple/index.html#type-hyp">hyp</a><span class="keyword"> = </span><a href="Simple/argument-1-S/index.html#type-formula">S.formula</a> list<span class="keyword"> and </span><span class="keyword">type </span><a href="Simple/index.html#type-lemma">lemma</a> := <a href="Simple/argument-1-S/index.html#type-lemma">S.lemma</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Simple/index.html#type-assumption">assumption</a><span class="keyword"> = </span><a href="Simple/argument-1-S/index.html#type-formula">S.formula</a>) -&gt; <a href="index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">type </span><a href="Simple/index.html#type-t">t</a> := <a href="Simple/argument-1-S/index.html#type-proof">S.proof</a></code></div><div class="doc"><p>Functor for making a module to export proofs to the DOT format.
The substitution of the hyp type is non-destructive due to a restriction
of destructive substitutions on earlier versions of ocaml.</p></div></div></body></html>