mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
215 lines
No EOL
14 KiB
HTML
215 lines
No EOL
14 KiB
HTML
<!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=utf-8" http-equiv="Content-Type">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="previous" href="Containers.html">
|
|
<link rel="next" href="CCKList.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 class methods" rel=Appendix href="index_methods.html">
|
|
<link title="Index of class types" rel=Appendix href="index_class_types.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="CCVector" rel="Chapter" href="CCVector.html">
|
|
<link title="CCHeap" rel="Chapter" href="CCHeap.html">
|
|
<link title="CCList" rel="Chapter" href="CCList.html">
|
|
<link title="CCOpt" rel="Chapter" href="CCOpt.html">
|
|
<link title="CCPair" rel="Chapter" href="CCPair.html">
|
|
<link title="CCFun" rel="Chapter" href="CCFun.html">
|
|
<link title="CCHash" rel="Chapter" href="CCHash.html">
|
|
<link title="CCInt" rel="Chapter" href="CCInt.html">
|
|
<link title="CCBool" rel="Chapter" href="CCBool.html">
|
|
<link title="CCFloat" rel="Chapter" href="CCFloat.html">
|
|
<link title="CCArray" rel="Chapter" href="CCArray.html">
|
|
<link title="CCRef" rel="Chapter" href="CCRef.html">
|
|
<link title="CCSet" rel="Chapter" href="CCSet.html">
|
|
<link title="CCOrd" rel="Chapter" href="CCOrd.html">
|
|
<link title="CCRandom" rel="Chapter" href="CCRandom.html">
|
|
<link title="CCString" rel="Chapter" href="CCString.html">
|
|
<link title="CCHashtbl" rel="Chapter" href="CCHashtbl.html">
|
|
<link title="CCMap" rel="Chapter" href="CCMap.html">
|
|
<link title="CCFormat" rel="Chapter" href="CCFormat.html">
|
|
<link title="CCIO" rel="Chapter" href="CCIO.html">
|
|
<link title="CCInt64" rel="Chapter" href="CCInt64.html">
|
|
<link title="CCChar" rel="Chapter" href="CCChar.html">
|
|
<link title="CCResult" rel="Chapter" href="CCResult.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCArray_slice" rel="Chapter" href="CCArray_slice.html">
|
|
<link title="CCListLabels" rel="Chapter" href="CCListLabels.html">
|
|
<link title="CCArrayLabels" rel="Chapter" href="CCArrayLabels.html">
|
|
<link title="CCEqual" rel="Chapter" href="CCEqual.html">
|
|
<link title="Containers" rel="Chapter" href="Containers.html">
|
|
<link title="CCKTree" rel="Chapter" href="CCKTree.html">
|
|
<link title="CCKList" rel="Chapter" href="CCKList.html">
|
|
<link title="CCLazy_list" rel="Chapter" href="CCLazy_list.html">
|
|
<link title="CCMultiMap" rel="Chapter" href="CCMultiMap.html">
|
|
<link title="CCMultiSet" rel="Chapter" href="CCMultiSet.html">
|
|
<link title="CCTrie" rel="Chapter" href="CCTrie.html">
|
|
<link title="CCFlatHashtbl" rel="Chapter" href="CCFlatHashtbl.html">
|
|
<link title="CCCache" rel="Chapter" href="CCCache.html">
|
|
<link title="CCPersistentHashtbl" rel="Chapter" href="CCPersistentHashtbl.html">
|
|
<link title="CCDeque" rel="Chapter" href="CCDeque.html">
|
|
<link title="CCFQueue" rel="Chapter" href="CCFQueue.html">
|
|
<link title="CCBV" rel="Chapter" href="CCBV.html">
|
|
<link title="CCMixtbl" rel="Chapter" href="CCMixtbl.html">
|
|
<link title="CCMixmap" rel="Chapter" href="CCMixmap.html">
|
|
<link title="CCRingBuffer" rel="Chapter" href="CCRingBuffer.html">
|
|
<link title="CCIntMap" rel="Chapter" href="CCIntMap.html">
|
|
<link title="CCPersistentArray" rel="Chapter" href="CCPersistentArray.html">
|
|
<link title="CCMixset" rel="Chapter" href="CCMixset.html">
|
|
<link title="CCGraph" rel="Chapter" href="CCGraph.html">
|
|
<link title="CCHashSet" rel="Chapter" href="CCHashSet.html">
|
|
<link title="CCBitField" rel="Chapter" href="CCBitField.html">
|
|
<link title="CCHashTrie" rel="Chapter" href="CCHashTrie.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCSimple_queue" rel="Chapter" href="CCSimple_queue.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="CCZipper" rel="Chapter" href="CCZipper.html">
|
|
<link title="CCPool" rel="Chapter" href="CCPool.html">
|
|
<link title="CCLock" rel="Chapter" href="CCLock.html">
|
|
<link title="CCSemaphore" rel="Chapter" href="CCSemaphore.html">
|
|
<link title="CCThread" rel="Chapter" href="CCThread.html">
|
|
<link title="CCBlockingQueue" rel="Chapter" href="CCBlockingQueue.html">
|
|
<link title="CCTimer" rel="Chapter" href="CCTimer.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexp_lex" rel="Chapter" href="CCSexp_lex.html"><link title="Basics" rel="Section" href="#2_Basics">
|
|
<link title="Graph Traversals" rel="Section" href="#2_GraphTraversals">
|
|
<link title="Pretty-printing" rel="Section" href="#2_Prettyprinting">
|
|
<link title="Pretty printing in the DOT (graphviz) format" rel="Section" href="#2_PrettyprintingintheDOTgraphvizformat">
|
|
<title>Containers doc : CCKTree</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="Containers.html" title="Containers">Previous</a>
|
|
<a class="up" href="index.html" title="Index">Up</a>
|
|
<a class="post" href="CCKList.html" title="CCKList">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_CCKTree.html">CCKTree</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> CCKTree: <code class="code"><span class="keyword">sig</span></code> <a href="CCKTree.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
|
|
<h1 id="1_LazyTreeStructure">Lazy Tree Structure</h1>
|
|
This structure can be used to represent trees and directed
|
|
graphs (as infinite trees) in a lazy fashion. Like <a href="CCKList.html"><code class="code"><span class="constructor">CCKList</span></code></a>, it
|
|
is a structural type.<br>
|
|
</div>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="TYPEsequence"><span class="keyword">type</span> <code class="type">'a</code> sequence</span> = <code class="type">('a -> unit) -> unit</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEgen"><span class="keyword">type</span> <code class="type">'a</code> gen</span> = <code class="type">unit -> 'a option</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEklist"><span class="keyword">type</span> <code class="type">'a</code> klist</span> = <code class="type">unit -> [ `Cons of 'a * 'a <a href="CCKTree.html#TYPEklist">klist</a> | `Nil ]</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEprinter"><span class="keyword">type</span> <code class="type">'a</code> printer</span> = <code class="type">Format.formatter -> 'a -> unit</code> </pre>
|
|
|
|
<br>
|
|
<h2 id="2_Basics">Basics</h2><br>
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> = <code class="type">unit -> [ `Nil | `Node of 'a * 'a <a href="CCKTree.html#TYPEt">t</a> list ]</code> </pre>
|
|
|
|
|
|
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">'a <a href="CCKTree.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALis_empty"><span class="keyword">val</span> is_empty</span> : <code class="type">'a <a href="CCKTree.html#TYPEt">t</a> -> bool</code></pre>
|
|
<pre><span id="VALsingleton"><span class="keyword">val</span> singleton</span> : <code class="type">'a -> 'a <a href="CCKTree.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Tree with only one label<br>
|
|
</div>
|
|
|
|
<pre><span id="VALnode"><span class="keyword">val</span> node</span> : <code class="type">'a -> 'a <a href="CCKTree.html#TYPEt">t</a> list -> 'a <a href="CCKTree.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Build a node from a label and a list of children<br>
|
|
</div>
|
|
|
|
<pre><span id="VALnode1"><span class="keyword">val</span> node1</span> : <code class="type">'a -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'a <a href="CCKTree.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Node with one child<br>
|
|
</div>
|
|
|
|
<pre><span id="VALnode2"><span class="keyword">val</span> node2</span> : <code class="type">'a -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'a <a href="CCKTree.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Node with two children<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('a -> 'b -> 'a) -> 'a -> 'b <a href="CCKTree.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Fold on values in no specified order. May not terminate if the
|
|
tree is infinite.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a -> unit) -> 'a <a href="CCKTree.html#TYPEt">t</a> -> unit</code></pre>
|
|
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">'a <a href="CCKTree.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of elements<br>
|
|
</div>
|
|
|
|
<pre><span id="VALheight"><span class="keyword">val</span> height</span> : <code class="type">'a <a href="CCKTree.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Length of the longest path to empty leaves<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'b <a href="CCKTree.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VAL(>|=)"><span class="keyword">val</span> (>|=)</span> : <code class="type">'a <a href="CCKTree.html#TYPEt">t</a> -> ('a -> 'b) -> 'b <a href="CCKTree.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALcut_depth"><span class="keyword">val</span> cut_depth</span> : <code class="type">int -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'a <a href="CCKTree.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Cut the tree at the given depth, so it becomes finite.<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_GraphTraversals">Graph Traversals</h2><br>
|
|
|
|
<pre><span id="TYPEpset"><span class="keyword">class type</span> <code class="type">['a]</code> <a href="CCKTree.pset-c.html">pset</a></span> = <code class="code"><span class="keyword">object</span></code> <a href="CCKTree.pset-c.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
|
|
Abstract Set structure
|
|
</div>
|
|
|
|
<pre><span id="VALset_of_cmp"><span class="keyword">val</span> set_of_cmp</span> : <code class="type">?cmp:('a -> 'a -> int) -> unit -> 'a <a href="CCKTree.pset-c.html">pset</a></code></pre><div class="info ">
|
|
Build a set structure given a total ordering<br>
|
|
</div>
|
|
|
|
<pre><span id="VALdfs"><span class="keyword">val</span> dfs</span> : <code class="type">?pset:'a <a href="CCKTree.pset-c.html">pset</a> -><br> 'a <a href="CCKTree.html#TYPEt">t</a> -> [ `Enter of 'a | `Exit of 'a ] <a href="CCKTree.html#TYPEklist">klist</a></code></pre><div class="info ">
|
|
Depth-first traversal of the tree<br>
|
|
</div>
|
|
|
|
<pre><span id="VALbfs"><span class="keyword">val</span> bfs</span> : <code class="type">?pset:'a <a href="CCKTree.pset-c.html">pset</a> -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'a <a href="CCKTree.html#TYPEklist">klist</a></code></pre><div class="info ">
|
|
Breadth-first traversal of the tree<br>
|
|
</div>
|
|
|
|
<pre><span id="VALforce"><span class="keyword">val</span> force</span> : <code class="type">'a <a href="CCKTree.html#TYPEt">t</a> -> ([ `Nil | `Node of 'a * 'b list ] as 'b)</code></pre><div class="info ">
|
|
<code class="code">force t</code> evaluates <code class="code">t</code> completely and returns a regular tree
|
|
structure<br>
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">?pset:'a <a href="CCKTree.pset-c.html">pset</a> -> ('a -> 'b option) -> 'a <a href="CCKTree.html#TYPEt">t</a> -> 'b option</code></pre><div class="info ">
|
|
Look for an element that maps to <code class="code"><span class="constructor">Some</span> _</code><br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_Prettyprinting">Pretty-printing</h2>
|
|
<p>
|
|
|
|
Example (tree of calls for naive Fibonacci function):
|
|
<pre class="codepre"><code class="code"> <span class="keyword">let</span> mk_fib n =
|
|
<span class="keyword">let</span> <span class="keyword">rec</span> fib' l r i =
|
|
<span class="keyword">if</span> i=n <span class="keyword">then</span> r <span class="keyword">else</span> fib' r (l+r) (i+1)
|
|
<span class="keyword">in</span> fib' 1 1 1;;
|
|
|
|
<span class="keyword">let</span> <span class="keyword">rec</span> fib n = <span class="keyword">match</span> n <span class="keyword">with</span>
|
|
<span class="keywordsign">|</span> 0 <span class="keywordsign">|</span> 1 <span class="keywordsign">-></span> <span class="constructor">CCKTree</span>.singleton (<span class="keywordsign">`</span><span class="constructor">Cst</span> n)
|
|
<span class="keywordsign">|</span> _ <span class="keywordsign">-></span> <span class="constructor">CCKTree</span>.node2 (<span class="keywordsign">`</span><span class="constructor">Plus</span> (mk_fib n)) (fib (n-1)) (fib (n-2));;
|
|
|
|
<span class="keyword">let</span> pp_node fmt = <span class="keyword">function</span>
|
|
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Cst</span> n <span class="keywordsign">-></span> <span class="constructor">Format</span>.fprintf fmt <span class="string">"%d"</span> n
|
|
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Plus</span> n <span class="keywordsign">-></span> <span class="constructor">Format</span>.fprintf fmt <span class="string">"%d"</span> n;;
|
|
|
|
<span class="constructor">Format</span>.printf <span class="string">"%a@."</span> (<span class="constructor">CCKTree</span>.print pp_node) (fib 8);;
|
|
</code></pre><br>
|
|
|
|
<pre><span id="VALpp"><span class="keyword">val</span> pp</span> : <code class="type">'a <a href="CCKTree.html#TYPEprinter">printer</a> -> 'a <a href="CCKTree.html#TYPEt">t</a> <a href="CCKTree.html#TYPEprinter">printer</a></code></pre><div class="info ">
|
|
A pretty-printer using S-expressions and boxes to render the tree.
|
|
Empty nodes are not rendered; sharing is ignored.<br>
|
|
<b>Since</b> 0.9<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_PrettyprintingintheDOTgraphvizformat">Pretty printing in the DOT (graphviz) format</h2><br>
|
|
|
|
<pre><span class="keyword">module</span> <a href="CCKTree.Dot.html">Dot</a>: <code class="code"><span class="keyword">sig</span></code> <a href="CCKTree.Dot.html">..</a> <code class="code"><span class="keyword">end</span></code></pre></body></html> |