<!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="Batteries.Hashcons.html">
<link rel="next" href="Batteries.FingerTree.html">
<link rel="Up" href="Batteries.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 classes" rel=Appendix href="index_classes.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="BatArray" rel="Chapter" href="BatArray.html">
<link title="BatAvlTree" rel="Chapter" href="BatAvlTree.html">
<link title="BatBase64" rel="Chapter" href="BatBase64.html">
<link title="BatBig_int" rel="Chapter" href="BatBig_int.html">
<link title="BatBigarray" rel="Chapter" href="BatBigarray.html">
<link title="BatBitSet" rel="Chapter" href="BatBitSet.html">
<link title="BatBool" rel="Chapter" href="BatBool.html">
<link title="BatBounded" rel="Chapter" href="BatBounded.html">
<link title="BatBuffer" rel="Chapter" href="BatBuffer.html">
<link title="BatCache" rel="Chapter" href="BatCache.html">
<link title="BatChar" rel="Chapter" href="BatChar.html">
<link title="BatCharParser" rel="Chapter" href="BatCharParser.html">
<link title="BatComplex" rel="Chapter" href="BatComplex.html">
<link title="BatConcurrent" rel="Chapter" href="BatConcurrent.html">
<link title="BatDeque" rel="Chapter" href="BatDeque.html">
<link title="BatDigest" rel="Chapter" href="BatDigest.html">
<link title="BatDllist" rel="Chapter" href="BatDllist.html">
<link title="BatDynArray" rel="Chapter" href="BatDynArray.html">
<link title="BatEnum" rel="Chapter" href="BatEnum.html">
<link title="BatFile" rel="Chapter" href="BatFile.html">
<link title="BatFingerTree" rel="Chapter" href="BatFingerTree.html">
<link title="BatFloat" rel="Chapter" href="BatFloat.html">
<link title="BatFormat" rel="Chapter" href="BatFormat.html">
<link title="BatGc" rel="Chapter" href="BatGc.html">
<link title="BatGenlex" rel="Chapter" href="BatGenlex.html">
<link title="BatGlobal" rel="Chapter" href="BatGlobal.html">
<link title="BatHashcons" rel="Chapter" href="BatHashcons.html">
<link title="BatHashtbl" rel="Chapter" href="BatHashtbl.html">
<link title="BatHeap" rel="Chapter" href="BatHeap.html">
<link title="BatIMap" rel="Chapter" href="BatIMap.html">
<link title="BatIO" rel="Chapter" href="BatIO.html">
<link title="BatISet" rel="Chapter" href="BatISet.html">
<link title="BatInnerIO" rel="Chapter" href="BatInnerIO.html">
<link title="BatInnerPervasives" rel="Chapter" href="BatInnerPervasives.html">
<link title="BatInnerWeaktbl" rel="Chapter" href="BatInnerWeaktbl.html">
<link title="BatInt" rel="Chapter" href="BatInt.html">
<link title="BatInt32" rel="Chapter" href="BatInt32.html">
<link title="BatInt64" rel="Chapter" href="BatInt64.html">
<link title="BatInterfaces" rel="Chapter" href="BatInterfaces.html">
<link title="BatLazyList" rel="Chapter" href="BatLazyList.html">
<link title="BatLexing" rel="Chapter" href="BatLexing.html">
<link title="BatList" rel="Chapter" href="BatList.html">
<link title="BatLog" rel="Chapter" href="BatLog.html">
<link title="BatLogger" rel="Chapter" href="BatLogger.html">
<link title="BatMap" rel="Chapter" href="BatMap.html">
<link title="BatMarshal" rel="Chapter" href="BatMarshal.html">
<link title="BatMultiMap" rel="Chapter" href="BatMultiMap.html">
<link title="BatMultiPMap" rel="Chapter" href="BatMultiPMap.html">
<link title="BatMutex" rel="Chapter" href="BatMutex.html">
<link title="BatNativeint" rel="Chapter" href="BatNativeint.html">
<link title="BatNum" rel="Chapter" href="BatNum.html">
<link title="BatNumber" rel="Chapter" href="BatNumber.html">
<link title="BatOo" rel="Chapter" href="BatOo.html">
<link title="BatOptParse" rel="Chapter" href="BatOptParse.html">
<link title="BatOption" rel="Chapter" href="BatOption.html">
<link title="BatOrd" rel="Chapter" href="BatOrd.html">
<link title="BatParserCo" rel="Chapter" href="BatParserCo.html">
<link title="BatPathGen" rel="Chapter" href="BatPathGen.html">
<link title="BatPervasives" rel="Chapter" href="BatPervasives.html">
<link title="BatPrintexc" rel="Chapter" href="BatPrintexc.html">
<link title="BatPrintf" rel="Chapter" href="BatPrintf.html">
<link title="BatQueue" rel="Chapter" href="BatQueue.html">
<link title="BatRMutex" rel="Chapter" href="BatRMutex.html">
<link title="BatRandom" rel="Chapter" href="BatRandom.html">
<link title="BatRef" rel="Chapter" href="BatRef.html">
<link title="BatRefList" rel="Chapter" href="BatRefList.html">
<link title="BatResult" rel="Chapter" href="BatResult.html">
<link title="BatReturn" rel="Chapter" href="BatReturn.html">
<link title="BatScanf" rel="Chapter" href="BatScanf.html">
<link title="BatSeq" rel="Chapter" href="BatSeq.html">
<link title="BatSet" rel="Chapter" href="BatSet.html">
<link title="BatSplay" rel="Chapter" href="BatSplay.html">
<link title="BatStack" rel="Chapter" href="BatStack.html">
<link title="BatStream" rel="Chapter" href="BatStream.html">
<link title="BatString" rel="Chapter" href="BatString.html">
<link title="BatSubstring" rel="Chapter" href="BatSubstring.html">
<link title="BatSys" rel="Chapter" href="BatSys.html">
<link title="BatText" rel="Chapter" href="BatText.html">
<link title="BatTuple" rel="Chapter" href="BatTuple.html">
<link title="BatUChar" rel="Chapter" href="BatUChar.html">
<link title="BatUTF8" rel="Chapter" href="BatUTF8.html">
<link title="BatUnit" rel="Chapter" href="BatUnit.html">
<link title="BatUnix" rel="Chapter" href="BatUnix.html">
<link title="BatUref" rel="Chapter" href="BatUref.html">
<link title="BatVect" rel="Chapter" href="BatVect.html">
<link title="Batteries" rel="Chapter" href="Batteries.html">
<link title="BatteriesConfig" rel="Chapter" href="BatteriesConfig.html">
<link title="BatteriesPrint" rel="Chapter" href="BatteriesPrint.html">
<link title="BatteriesThread" rel="Chapter" href="BatteriesThread.html">
<link title="Extlib" rel="Chapter" href="Extlib.html"><link title="Construction" rel="Section" href="#6_Construction">
<link title="Operations" rel="Section" href="#6_Operations">
<link title="Transformation" rel="Section" href="#6_Transformation">
<link title="Printing" rel="Section" href="#6_Printing">
<link title="Functorized version" rel="Section" href="#6_Functorizedversion">
<title>Batteries user guide : Batteries.Heap</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Batteries.Hashcons.html" title="Batteries.Hashcons">Previous</a>
<a class="up" href="Batteries.html" title="Batteries">Up</a>
<a class="post" href="Batteries.FingerTree.html" title="Batteries.FingerTree">Next</a>
</div>
<h1>Module <a href="type_Batteries.Heap.html">Batteries.Heap</a></h1>
<pre><span class="keyword">module</span> Heap: <code class="type">BatHeap</code></pre><hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">+'a</code> t</span> </pre>
<div class="info ">
Heap of elements that are compared with <code class="code"><span class="constructor">Pervasives</span>.compare</code>.<br>
</div>
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> int</code></pre><div class="info ">
Number of elements in the heap. O(1)<br>
</div>
<br>
<h6 id="6_Construction">Construction</h6><br>
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
The empty heap.<br>
</div>
<pre><span id="VALinsert"><span class="keyword">val</span> insert</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a -> 'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
Insert an element into the heap. Duplicates are kept. O(log m)<br>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">'a -> 'a <a href="BatHeap.html#TYPEt">t</a> -> 'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">add x h</code> is the same as <code class="code">insert h x</code>. This function is intended
to be used with <code class="code">fold_right</code>.<br>
</div>
<br>
<h6 id="6_Operations">Operations</h6><br>
<pre><span id="VALmerge"><span class="keyword">val</span> merge</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a <a href="BatHeap.html#TYPEt">t</a> -> 'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
Merge two heaps. O(log m)<br>
</div>
<pre><span id="VALfind_min"><span class="keyword">val</span> find_min</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
Find the minimal element of the heap. O(1)<br>
<b>Raises</b> <code>Invalid_argument</code> <code class="code"><span class="string">"find_min"</span></code> if the heap is empty<br>
</div>
<pre><span id="VALdel_min"><span class="keyword">val</span> del_min</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
Delete the minimal element of the heap. O(log n)<br>
<b>Raises</b> <code>Invalid_argument</code> <code class="code"><span class="string">"del_min"</span></code> if the heap is empty<br>
</div>
<br>
<h6 id="6_Transformation">Transformation</h6><br>
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">'a list -> 'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
Build a heap from a given list. O(n log n)<br>
</div>
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a list</code></pre><div class="info ">
Enumerate the elements of the heap. O(n log n)<br>
</div>
<pre><span id="VALelems"><span class="keyword">val</span> elems</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a list</code></pre><div class="info ">
<span class="warning">Deprecated.</span>Same as <code class="code">to_list</code>.<br>
</div>
<pre><span id="VALof_enum"><span class="keyword">val</span> of_enum</span> : <code class="type">'a <a href="BatEnum.html#TYPEt">BatEnum.t</a> -> 'a <a href="BatHeap.html#TYPEt">t</a></code></pre><div class="info ">
Build a heap from an enumeration. Consumes the enumeration.
O(n log n)<br>
</div>
<pre><span id="VALenum"><span class="keyword">val</span> enum</span> : <code class="type">'a <a href="BatHeap.html#TYPEt">t</a> -> 'a <a href="BatEnum.html#TYPEt">BatEnum.t</a></code></pre><div class="info ">
Enumerate the elements of the heap in heap order. O(log n) per
<a href="BatEnum.html#VALget"><code class="code"><span class="constructor">BatEnum</span>.get</code></a>.<br>
</div>
<br>
<h6 id="6_Printing">Printing</h6><br>
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type">?first:string -><br> ?last:string -><br> ?sep:string -> ('a, 'b) <a href="BatIO.html#TYPEprinter">BatIO.printer</a> -> ('a <a href="BatHeap.html#TYPEt">t</a>, 'b) <a href="BatIO.html#TYPEprinter">BatIO.printer</a></code></pre><div class="info ">
Print the contents of the heap in heap order. O(n log n)<br>
</div>
<br>
<h6 id="6_Functorizedversion">Functorized version</h6><br>
<pre><span class="keyword">module type</span> <a href="BatHeap.H.html">H</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatHeap.H.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
The result of <a href="BatHeap.Make.html"><code class="code"><span class="constructor">BatHeap</span>.<span class="constructor">Make</span></code></a>
</div>
<pre><span class="keyword">module</span> <a href="BatHeap.Make.html">Make</a>: <div class="sig_block"><code class="code"><span class="keyword">functor</span> (</code><code class="code"><span class="constructor">Ord</span></code><code class="code"> : </code><code class="type"><a href="BatInterfaces.OrderedType.html">BatInterfaces.OrderedType</a></code><code class="code">) <span class="keywordsign">-></span> </code><code class="type"><a href="BatHeap.H.html">H</a></code><code class="type"> with type elem = Ord.t</code></div></pre><div class="info">
Functorized heaps over arbitrary orderings.
</div>
</body></html>
