Skip to content

Commit c3d23d2

Browse files
committed
scaladoc
1 parent 5d58707 commit c3d23d2

File tree

11 files changed

+177
-61
lines changed

11 files changed

+177
-61
lines changed

docs/index/index-a.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
</div><div class="entry">
2020
<div class="name">alloc</div>
2121
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
22+
</div><div class="entry">
23+
<div class="name">apply</div>
24+
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree$.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
2225
</div><div class="entry">
2326
<div class="name">asInternal</div>
2427
<div class="occurrences"><a href="../xyz/hyperreal/btree/MemoryBPlusTree$Node.html" class="extype" name="xyz.hyperreal.btree.MemoryBPlusTree.Node">Node</a> </div>

docs/index/index-d.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
</div><div class="entry">
1717
<div class="name">DATUM_SIZE</div>
1818
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
19+
</div><div class="entry">
20+
<div class="name">decode</div>
21+
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
1922
</div><div class="entry">
2023
<div class="name">delete</div>
2124
<div class="occurrences"><a href="../xyz/hyperreal/btree/BPlusTree.html" class="extype" name="xyz.hyperreal.btree.BPlusTree">BPlusTree</a> </div>
@@ -25,8 +28,5 @@
2528
</div><div class="entry">
2629
<div class="name">dispose</div>
2730
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
28-
</div><div class="entry">
29-
<div class="name">dump</div>
30-
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
3131
</div></body>
3232
</html>

docs/index/index-e.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,8 @@
1313
<body><div class="entry">
1414
<div class="name">empty</div>
1515
<div class="occurrences"><a href="../xyz/hyperreal/btree/MutableSortedMap.html" class="extype" name="xyz.hyperreal.btree.MutableSortedMap">MutableSortedMap</a> </div>
16+
</div><div class="entry">
17+
<div class="name">encode</div>
18+
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
1619
</div></body>
1720
</html>

docs/index/index-o.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111

1212
</head>
1313
<body><div class="entry">
14+
<div class="name">order</div>
15+
<div class="occurrences"><a href="../xyz/hyperreal/btree/BPlusTree.html" class="extype" name="xyz.hyperreal.btree.BPlusTree">BPlusTree</a> <a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> <a href="../xyz/hyperreal/btree/MemoryBPlusTree.html" class="extype" name="xyz.hyperreal.btree.MemoryBPlusTree">MemoryBPlusTree</a> </div>
16+
</div><div class="entry">
1417
<div class="name">ordering</div>
1518
<div class="occurrences"><a href="../xyz/hyperreal/btree/MutableSortedMap.html" class="extype" name="xyz.hyperreal.btree.MutableSortedMap">MutableSortedMap</a> </div>
1619
</div></body>

docs/index/index-r.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
<div class="name">rangeImpl</div>
1515
<div class="occurrences"><a href="../xyz/hyperreal/btree/MutableSortedMap.html" class="extype" name="xyz.hyperreal.btree.MutableSortedMap">MutableSortedMap</a> </div>
1616
</div><div class="entry">
17-
<div class="name">readDatum</div>
17+
<div class="name">readDatumArray</div>
1818
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
1919
</div><div class="entry">
20-
<div class="name">readString</div>
20+
<div class="name">readDatumFile</div>
2121
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
2222
</div><div class="entry">
2323
<div class="name">removeInternal</div>

docs/index/index-w.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414
<div class="name">wellConstructed</div>
1515
<div class="occurrences"><a href="../xyz/hyperreal/btree/BPlusTree.html" class="extype" name="xyz.hyperreal.btree.BPlusTree">BPlusTree</a> </div>
1616
</div><div class="entry">
17-
<div class="name">writeDatum</div>
17+
<div class="name">writeDatumArray</div>
18+
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
19+
</div><div class="entry">
20+
<div class="name">writeDatumFile</div>
1821
<div class="occurrences"><a href="../xyz/hyperreal/btree/FileBPlusTree.html" class="extype" name="xyz.hyperreal.btree.FileBPlusTree">FileBPlusTree</a> </div>
1922
</div><div class="entry">
2023
<div class="name">writeEmptyRecord</div>

docs/xyz/hyperreal/btree/BPlusTree.html

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,23 +92,23 @@ <h4 id="signature" class="signature">
9292
<div id="allMembers">
9393
<div id="constructors" class="members">
9494
<h3>Instance Constructors</h3>
95-
<ol><li name="xyz.hyperreal.btree.BPlusTree#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
96-
<a id="&lt;init&gt;(order:Int)(implicitevidence$1:K=&gt;Ordered[K]):xyz.hyperreal.btree.BPlusTree[K,V]"></a>
95+
<ol><li name="xyz.hyperreal.btree.BPlusTree#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
96+
<a id="&lt;init&gt;()(implicitevidence$1:K=&gt;Ordered[K]):xyz.hyperreal.btree.BPlusTree[K,V]"></a>
9797
<a id="&lt;init&gt;:BPlusTree[K,V]"></a>
9898
<h4 class="signature">
9999
<span class="modifier_kind">
100100
<span class="modifier"></span>
101101
<span class="kind">new</span>
102102
</span>
103103
<span class="symbol">
104-
<span class="name">BPlusTree</span><span class="params">(<span name="order">order: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="arg0">arg0: (<span class="extype" name="xyz.hyperreal.btree.BPlusTree.K">K</span>) ⇒ <span class="extype" name="scala.Ordered">Ordered</span>[<span class="extype" name="xyz.hyperreal.btree.BPlusTree.K">K</span>]</span>)</span>
104+
<span class="name">BPlusTree</span><span class="params">()</span><span class="params">(<span class="implicit">implicit </span><span name="arg0">arg0: (<span class="extype" name="xyz.hyperreal.btree.BPlusTree.K">K</span>) ⇒ <span class="extype" name="scala.Ordered">Ordered</span>[<span class="extype" name="xyz.hyperreal.btree.BPlusTree.K">K</span>]</span>)</span>
105105
</span>
106106
</h4><span class="permalink">
107-
<a href="../../../index.html#xyz.hyperreal.btree.BPlusTree@&lt;init&gt;(order:Int)(implicitevidence$1:K=&gt;Ordered[K]):xyz.hyperreal.btree.BPlusTree[K,V]" title="Permalink" target="_top">
107+
<a href="../../../index.html#xyz.hyperreal.btree.BPlusTree@&lt;init&gt;()(implicitevidence$1:K=&gt;Ordered[K]):xyz.hyperreal.btree.BPlusTree[K,V]" title="Permalink" target="_top">
108108
<img src="../../../lib/permalink.png" alt="Permalink" />
109109
</a>
110110
</span>
111-
<p class="shortcomment cmt">creates an object providing access to a B+ tree with a branching factor of <code>order</code> and possibly creating an empty tree.</p><div class="fullcomment"><div class="comment cmt"><p>creates an object providing access to a B+ tree with a branching factor of <code>order</code> and possibly creating an empty tree.</p></div><dl class="paramcmts block"><dt class="param">order</dt><dd class="cmt"><p>the branching factor (maximum number of branches in an internal node) of the tree</p></dd></dl></div>
111+
<p class="shortcomment cmt">creates an object providing access to a B+ tree with a branching factor of <code>order</code> and possibly creating an empty tree.</p>
112112
</li></ol>
113113
</div>
114114

@@ -624,6 +624,24 @@ <h4 class="signature">
624624
</span>
625625
<p class="shortcomment cmt">Returns the <i>null</i> node pointer.</p><div class="fullcomment"><div class="comment cmt"><p>Returns the <i>null</i> node pointer. For in-memory implementations this will usually be a Scala <code>null</code> value. For on-disk it would make sense for this to be <code>0L</code>.
626626
</p></div><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div>
627+
</li><li name="xyz.hyperreal.btree.BPlusTree#order" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
628+
<a id="order:Int"></a>
629+
<a id="order:Int"></a>
630+
<h4 class="signature">
631+
<span class="modifier_kind">
632+
<span class="modifier">abstract </span>
633+
<span class="kind">val</span>
634+
</span>
635+
<span class="symbol">
636+
<span class="name">order</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
637+
</span>
638+
</h4><span class="permalink">
639+
<a href="../../../index.html#xyz.hyperreal.btree.BPlusTree@order:Int" title="Permalink" target="_top">
640+
<img src="../../../lib/permalink.png" alt="Permalink" />
641+
</a>
642+
</span>
643+
<p class="shortcomment cmt">Order or branching factor of the tree.</p><div class="fullcomment"><div class="comment cmt"><p>Order or branching factor of the tree. The order is the maximum number of branches that an internal node can have. The maximum number of elements in a leaf node is <code>order - 1</code>.
644+
</p></div></div>
627645
</li><li name="xyz.hyperreal.btree.BPlusTree#removeInternal" visbl="prt" data-isabs="true" fullComment="yes" group="Ungrouped">
628646
<a id="removeInternal(node:BPlusTree.this.N,keyIndex:Int,branchIndex:Int):Int"></a>
629647
<a id="removeInternal(N,Int,Int):Int"></a>
@@ -929,7 +947,7 @@ <h4 class="signature">
929947
<img src="../../../lib/permalink.png" alt="Permalink" />
930948
</a>
931949
</span>
932-
<p class="shortcomment cmt">Returns a bounded iterator over a range of key/value pairs in the tree in sorted order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of key/value pairs in the tree in sorted order. The range of key/value pairs in the iterator is specified by <code>bounds</code>. <code>bounds</code> must contain one or two pairs where the first element in the pair is a symbol corresponding to the type of bound (i.e. '&lt;, '&lt;=, '&gt;, '&gt;=) and the second element is a key value.</p><p>An example of a bounded iterator over all elements in a tree (with <code>String</code> keys) that will include all keys that sort greater than or equal to &quot;a&quot; and up to but not including &quot;e&quot; is <code>boundedIterator( ('&gt;=, &quot;a&quot;), ('&lt;, &quot;e&quot;) )</code>.
950+
<p class="shortcomment cmt">Returns a bounded iterator over a range of key/value pairs in the tree in ascending sorted key order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of key/value pairs in the tree in ascending sorted key order. The range of key/value pairs in the iterator is specified by <code>bounds</code>. <code>bounds</code> must contain one or two pairs where the first element in the pair is a symbol corresponding to the type of bound (i.e. '&lt;, '&lt;=, '&gt;, '&gt;=) and the second element is a key value.</p><p>An example of a bounded iterator over all elements in a tree (with <code>String</code> keys) that will include all keys that sort greater than or equal to &quot;a&quot; and up to but not including &quot;e&quot; is <code>boundedIterator( ('&gt;=, &quot;a&quot;), ('&lt;, &quot;e&quot;) )</code>.
933951
</p></div></div>
934952
</li><li name="xyz.hyperreal.btree.BPlusTree#boundedKeysIterator" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
935953
<a id="boundedKeysIterator(bounds:(Symbol,K)*):Iterator[K]"></a>
@@ -947,7 +965,7 @@ <h4 class="signature">
947965
<img src="../../../lib/permalink.png" alt="Permalink" />
948966
</a>
949967
</span>
950-
<p class="shortcomment cmt">Returns a bounded iterator over a range of keys in the tree in sorted order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of keys in the tree in sorted order. The <code>bounds</code> parameter is the same as for <a href="#boundedIterator(bounds:(Symbol,K)*):Iterator[(K,V)]" class="extmbr" name="xyz.hyperreal.btree.BPlusTree#boundedIterator">boundedIterator</a>.
968+
<p class="shortcomment cmt">Returns a bounded iterator over a range of keys in the tree in ascending sorted key order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of keys in the tree in ascending sorted key order. The <code>bounds</code> parameter is the same as for <a href="#boundedIterator(bounds:(Symbol,K)*):Iterator[(K,V)]" class="extmbr" name="xyz.hyperreal.btree.BPlusTree#boundedIterator">boundedIterator</a>.
951969
</p></div></div>
952970
</li><li name="xyz.hyperreal.btree.BPlusTree#boundedPositionIterator" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
953971
<a id="boundedPositionIterator(bounds:(Symbol,K)*):Iterator[(BPlusTree.this.N,Int)]"></a>
@@ -965,7 +983,7 @@ <h4 class="signature">
965983
<img src="../../../lib/permalink.png" alt="Permalink" />
966984
</a>
967985
</span>
968-
<p class="shortcomment cmt">Returns a bounded iterator over a range of key positions (node/index pairs) in the tree in sorted order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of key positions (node/index pairs) in the tree in sorted order. The <code>bounds</code> parameter is the same as for <a href="#boundedIterator(bounds:(Symbol,K)*):Iterator[(K,V)]" class="extmbr" name="xyz.hyperreal.btree.BPlusTree#boundedIterator">boundedIterator</a>.
986+
<p class="shortcomment cmt">Returns a bounded iterator over a range of key positions (node/index pairs) in the tree in ascending sorted key order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of key positions (node/index pairs) in the tree in ascending sorted key order. The <code>bounds</code> parameter is the same as for <a href="#boundedIterator(bounds:(Symbol,K)*):Iterator[(K,V)]" class="extmbr" name="xyz.hyperreal.btree.BPlusTree#boundedIterator">boundedIterator</a>.
969987
</p></div><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div>
970988
</li><li name="xyz.hyperreal.btree.BPlusTree#boundedValuesIterator" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
971989
<a id="boundedValuesIterator(bounds:(Symbol,K)*):Iterator[V]"></a>
@@ -983,7 +1001,7 @@ <h4 class="signature">
9831001
<img src="../../../lib/permalink.png" alt="Permalink" />
9841002
</a>
9851003
</span>
986-
<p class="shortcomment cmt">Returns a bounded iterator over a range of values in the tree in sorted order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of values in the tree in sorted order. The <code>bounds</code> parameter is the same as for <a href="#boundedIterator(bounds:(Symbol,K)*):Iterator[(K,V)]" class="extmbr" name="xyz.hyperreal.btree.BPlusTree#boundedIterator">boundedIterator</a>.
1004+
<p class="shortcomment cmt">Returns a bounded iterator over a range of values in the tree in ascending sorted key order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a bounded iterator over a range of values in the tree in ascending sorted key order. The <code>bounds</code> parameter is the same as for <a href="#boundedIterator(bounds:(Symbol,K)*):Iterator[(K,V)]" class="extmbr" name="xyz.hyperreal.btree.BPlusTree#boundedIterator">boundedIterator</a>.
9871005
</p></div></div>
9881006
</li><li name="xyz.hyperreal.btree.BPlusTree#build" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
9891007
<a id="build(s:String):xyz.hyperreal.btree.BPlusTree[K,V]"></a>
@@ -1316,7 +1334,7 @@ <h4 class="signature">
13161334
<img src="../../../lib/permalink.png" alt="Permalink" />
13171335
</a>
13181336
</span>
1319-
<p class="shortcomment cmt">Returns an iterator over all key/value pairs in the tree in sorted order.</p>
1337+
<p class="shortcomment cmt">Returns an iterator over all key/value pairs in the tree in ascending sorted key order.</p>
13201338
</li><li name="xyz.hyperreal.btree.BPlusTree#keysIterator" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
13211339
<a id="keysIterator:Iterator[K]"></a>
13221340
<a id="keysIterator:Iterator[K]"></a>
@@ -1597,7 +1615,7 @@ <h4 class="signature">
15971615
<img src="../../../lib/permalink.png" alt="Permalink" />
15981616
</a>
15991617
</span>
1600-
<p class="shortcomment cmt">Returns an iterator over all key positions (node/index pairs) in the tree in ascending sorted order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns an iterator over all key positions (node/index pairs) in the tree in ascending sorted order.
1618+
<p class="shortcomment cmt">Returns an iterator over all key positions (node/index pairs) in the tree in ascending sorted key order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns an iterator over all key positions (node/index pairs) in the tree in ascending sorted key order.
16011619
</p></div><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div>
16021620
</li><li name="xyz.hyperreal.btree.BPlusTree#prettyPrint" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
16031621
<a id="prettyPrint:Unit"></a>
@@ -1721,7 +1739,7 @@ <h4 class="signature">
17211739
<img src="../../../lib/permalink.png" alt="Permalink" />
17221740
</a>
17231741
</span>
1724-
<p class="shortcomment cmt">Returns an iterator over all key/value pairs in the tree in sorted order.</p>
1742+
<p class="shortcomment cmt">Returns an iterator over all key/value pairs in the tree in descending sorted key order.</p>
17251743
</li><li name="xyz.hyperreal.btree.BPlusTree#reverseKeysIterator" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
17261744
<a id="reverseKeysIterator:Iterator[K]"></a>
17271745
<a id="reverseKeysIterator:Iterator[K]"></a>
@@ -1755,7 +1773,7 @@ <h4 class="signature">
17551773
<img src="../../../lib/permalink.png" alt="Permalink" />
17561774
</a>
17571775
</span>
1758-
<p class="shortcomment cmt">Returns a reverse iterator over all key positions (node/index pairs) in the tree in descending sorted order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a reverse iterator over all key positions (node/index pairs) in the tree in descending sorted order.
1776+
<p class="shortcomment cmt">Returns a reverse iterator over all key positions (node/index pairs) in the tree in descending sorted key order.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a reverse iterator over all key positions (node/index pairs) in the tree in descending sorted key order.
17591777
</p></div><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd></dl></div>
17601778
</li><li name="xyz.hyperreal.btree.BPlusTree#rightmost" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
17611779
<a id="rightmost(node:BPlusTree.this.N):K"></a>

0 commit comments

Comments
 (0)