<!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="BatFile.html">
<link rel="next" href="BatFloat.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 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"><title>Batteries user guide : BatFingerTree</title>
</head>
<body>
<div class="navbar"><a class="pre" href="BatFile.html" title="BatFile">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="BatFloat.html" title="BatFloat">Next</a>
</div>
<h1>Module <a href="type_BatFingerTree.html">BatFingerTree</a></h1>
<pre><span class="keyword">module</span> BatFingerTree: <code class="code"><span class="keyword">sig</span></code> <a href="BatFingerTree.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
This module implements a generic finger tree datastructure
as described here:
Finger Trees: A Simple General-purpose Data Structure
http://www.soi.city.ac.uk/~ross/papers/FingerTree.pdf
<p>
The finger tree itself is polymorphic over the measure and
the measurement function (this is needed because sometimes
the type of the measure depends on the type of the elements).
<p>
This module also contains an instanciation of a finger tree that
implements a functional sequence with the following characteristics:<ul>
<li>amortized constant time addition and deletions at both ends</li>
<li>contant time size operation</li>
<li>logarithmic lookup, update or deletion of the element at a given index</li>
<li>logarithmic splitting and concatenation</li>
</ul>
If you are trying to understand the signature at first, whenever you
see a type <code class="code">(something, _, _) wrap</code>, just pretend it is simply
the type <code class="code">something</code> (this is what the documentation does).
<p>
Complexities are given assuming that the monoid combination operation
and the measurement functions are constant time and space.
<p>
None of the functions on finger trees can cause stack overflow:
they use at worst a logarithmic amount of stack space.<br>
</div>
<hr width="100%">
<pre><code><span id="TYPEmonoid"><span class="keyword">type</span> <code class="type">'a</code> monoid</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonoid.zero">zero</span> : <code class="type">'a</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The neutral element of the monoid.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonoid.combine">combine</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code">combine</code> should be associative, and have <code class="code">zero</code> as neutral element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
The type of the element of a monoid.<br>
</div>
<pre><span id="EXCEPTIONEmpty"><span class="keyword">exception</span> Empty</span></pre>
<div class="info ">
An exception that is thrown by various operations when
trying to get a non existing element.<br>
</div>
<pre><span class="keyword">module type</span> <a href="BatFingerTree.S.html">S</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatFingerTree.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>
<pre><span class="keyword">module</span> <a href="BatFingerTree.Generic.html">Generic</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatFingerTree.Generic.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre>
<pre><span class="keyword">include</span> <a href="BatFingerTree.S.html">BatFingerTree.S</a></pre>
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">'a <a href="BatFingerTree.html#TYPEt">t</a> -> int</code></pre><div class="info ">
<code class="code">size t</code> returns the number of elements in the sequence.
<p>
Unlike the generic <code class="code">size</code> on finger trees, this one has complexity O(1).<br>
</div>
<pre><span id="VALsplit_at"><span class="keyword">val</span> split_at</span> : <code class="type">'a <a href="BatFingerTree.html#TYPEt">t</a> -> int -> 'a <a href="BatFingerTree.html#TYPEt">t</a> * 'a <a href="BatFingerTree.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">split_at</code> is equivalent to <code class="code"><span class="constructor">List</span>.split_at</code>.<br>
<b>Raises</b> <code>Invalid_argument</code> when the index is out of bounds.
<p>
O(log(n)).<br>
</div>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">'a <a href="BatFingerTree.html#TYPEt">t</a> -> int -> 'a</code></pre><div class="info ">
<code class="code">get t i</code> returns the <code class="code">i</code>-th element of <code class="code">t</code>.<br>
<b>Raises</b> <code>Invalid_argument</code> when the index is out of bounds.
<p>
O(log(n)).<br>
</div>
<pre><span id="VALset"><span class="keyword">val</span> set</span> : <code class="type">'a <a href="BatFingerTree.html#TYPEt">t</a> -> int -> 'a -> 'a <a href="BatFingerTree.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">set t i v</code> returns <code class="code">t</code> where the <code class="code">i</code>-th element is now <code class="code">v</code>.<br>
<b>Raises</b> <code>Invalid_argument</code> when the index is out of bounds.
<p>
O(log(n)).<br>
</div>
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type">'a <a href="BatFingerTree.html#TYPEt">t</a> -> int -> ('a -> 'a) -> 'a <a href="BatFingerTree.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">update t i f</code> returns <code class="code">t</code> where the <code class="code">i</code>-th element is now <code class="code">f (get i t)</code>.<br>
<b>Raises</b> <code>Invalid_argument</code> when the index is out of bounds.
<p>
O(log(n)).<br>
</div>
</body></html>
