Skip to content

Commit

Permalink
Deploying to gh-pages from @ acbd599 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@ByronBecker
ByronBecker committed Jan 1, 2024
1 parent a2453fe commit f6d0137
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion BTree.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!DOCTYPE html>
<html><head title="Doc"><meta charset="UTF-8"/><link href="styles.css" rel="stylesheet"/></head><body><nav class="sidebar"><h3>Modules</h3><ul><li><li><a href="ArrayUtil.html">ArrayUtil</a></li></li><li><li><a href="BTree.html">BTree</a></li></li><li><li><a href="BinarySearch.html">BinarySearch</a></li></li><li><li><a href="Check.html">Check</a></li></li><li><li><a href="NodeUtil.html">NodeUtil</a></li></li><li><li><a href="Types.html">Types</a></li></li></ul><h3>Declarations</h3><ul><li><li><a href="#type.BTree">BTree</a></li></li><li><li><a href="#type.Node">Node</a></li></li><li><li><a href="#type.Internal">Internal</a></li></li><li><li><a href="#type.Leaf">Leaf</a></li></li><li><li><a href="#type.Data">Data</a></li></li><li><li><a href="#init">init</a></li></li><li><li><a href="#fromArray">fromArray</a></li></li><li><li><a href="#fromBuffer">fromBuffer</a></li></li><li><li><a href="#size">size</a></li></li><li><li><a href="#get">get</a></li></li><li><li><a href="#has">has</a></li></li><li><li><a href="#insert">insert</a></li></li><li><li><a href="#substituteKey">substituteKey</a></li></li><li><li><a href="#update">update</a></li></li><li><li><a href="#delete">delete</a></li></li><li><li><a href="#min">min</a></li></li><li><li><a href="#max">max</a></li></li><li><li><a href="#deleteMin">deleteMin</a></li></li><li><li><a href="#deleteMax">deleteMax</a></li></li><li><li><a href="#entries">entries</a></li></li><li><li><a href="#toKeyArray">toKeyArray</a></li></li><li><li><a href="#toValueArray">toValueArray</a></li></li><li><li><a href="#toArray">toArray</a></li></li><li><li><a href="#toBuffer">toBuffer</a></li></li><li><li><a href="#type.Direction">Direction</a></li></li><li><li><a href="#type.ScanLimitResult">ScanLimitResult</a></li></li><li><li><a href="#scanLimit">scanLimit</a></li></li><li><li><a href="#toText">toText</a></li></li><li><li><a href="#equals">equals</a></li></li></ul></nav><div class="documentation"><h1>BTree</h1><p>The BTree module collection of functions and types</p>
<html><head title="Doc"><meta charset="UTF-8"/><link href="styles.css" rel="stylesheet"/></head><body><nav class="sidebar"><h3>Modules</h3><ul><li><li><a href="ArrayUtil.html">ArrayUtil</a></li></li><li><li><a href="BTree.html">BTree</a></li></li><li><li><a href="BinarySearch.html">BinarySearch</a></li></li><li><li><a href="Check.html">Check</a></li></li><li><li><a href="NodeUtil.html">NodeUtil</a></li></li><li><li><a href="Types.html">Types</a></li></li></ul><h3>Declarations</h3><ul><li><li><a href="#type.BTree">BTree</a></li></li><li><li><a href="#type.Node">Node</a></li></li><li><li><a href="#type.Internal">Internal</a></li></li><li><li><a href="#type.Leaf">Leaf</a></li></li><li><li><a href="#type.Data">Data</a></li></li><li><li><a href="#init">init</a></li></li><li><li><a href="#clear">clear</a></li></li><li><li><a href="#fromArray">fromArray</a></li></li><li><li><a href="#fromBuffer">fromBuffer</a></li></li><li><li><a href="#size">size</a></li></li><li><li><a href="#get">get</a></li></li><li><li><a href="#has">has</a></li></li><li><li><a href="#insert">insert</a></li></li><li><li><a href="#substituteKey">substituteKey</a></li></li><li><li><a href="#update">update</a></li></li><li><li><a href="#delete">delete</a></li></li><li><li><a href="#min">min</a></li></li><li><li><a href="#max">max</a></li></li><li><li><a href="#deleteMin">deleteMin</a></li></li><li><li><a href="#deleteMax">deleteMax</a></li></li><li><li><a href="#entries">entries</a></li></li><li><li><a href="#toKeyArray">toKeyArray</a></li></li><li><li><a href="#toValueArray">toValueArray</a></li></li><li><li><a href="#toArray">toArray</a></li></li><li><li><a href="#toBuffer">toBuffer</a></li></li><li><li><a href="#type.Direction">Direction</a></li></li><li><li><a href="#type.ScanLimitResult">ScanLimitResult</a></li></li><li><li><a href="#scanLimit">scanLimit</a></li></li><li><li><a href="#toText">toText</a></li></li><li><li><a href="#equals">equals</a></li></li></ul></nav><div class="documentation"><h1>BTree</h1><p>The BTree module collection of functions and types</p>
<div class="declaration"><h4 class="type-declaration" id="type.BTree"><span class="keyword">type </span><span class="type">BTree</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt; = <a href="Types.html#type.BTree"><span class="type">Types.BTree</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</h4><p></p></div><div class="declaration"><h4 class="type-declaration" id="type.Node"><span class="keyword">type </span><span class="type">Node</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt; = <a href="Types.html#type.Node"><span class="type">Types.Node</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</h4><p></p></div><div class="declaration"><h4 class="type-declaration" id="type.Internal"><span class="keyword">type </span><span class="type">Internal</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt; = <a href="Types.html#type.Internal"><span class="type">Types.Internal</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</h4><p></p></div><div class="declaration"><h4 class="type-declaration" id="type.Leaf"><span class="keyword">type </span><span class="type">Leaf</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt; = <a href="Types.html#type.Leaf"><span class="type">Types.Leaf</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</h4><p></p></div><div class="declaration"><h4 class="type-declaration" id="type.Data"><span class="keyword">type </span><span class="type">Data</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt; = <a href="Types.html#type.Data"><span class="type">Types.Data</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</h4><p></p></div><div class="declaration"><h4 class="function" id="init"><code><span class="keyword">public func </span><span class="fnname">init</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;(<span class="parameter">order</span> : ?<span class="type">Nat</span>) : <a href="#type.BTree"><span class="type">BTree</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</code></h4><p><p>Initializes an empty BTree. By default, set the BTree to have order 8, and enforce the the order be greater than 4, but lower than 512</p>
</p></div><div class="declaration"><h4 class="function" id="clear"><code><span class="keyword">public func </span><span class="fnname">clear</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;(<span class="parameter">tree</span> : <a href="#type.BTree"><span class="type">BTree</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;) : ()</code></h4><p><p>Clears all entries from a BTree</p>
</p></div><div class="declaration"><h4 class="function" id="fromArray"><code><span class="keyword">public func </span><span class="fnname">fromArray</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;(<br/>  <span class="parameter">order</span> : <span class="type">Nat</span>, <br/>  <span class="parameter">compare</span> : (<span class="type">K</span>, <span class="type">K</span>) -&gt; <span class="type">O.Order</span>, <br/>  <span class="parameter">kvPairs</span> : [(<span class="type">K</span>, <span class="type">V</span>)]<br/>) : <a href="#type.BTree"><span class="type">BTree</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</code></h4><p><p>Allows one to quickly create a BTree from an array of key value pairs</p>
</p></div><div class="declaration"><h4 class="function" id="fromBuffer"><code><span class="keyword">public func </span><span class="fnname">fromBuffer</span>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;(<br/>  <span class="parameter">order</span> : <span class="type">Nat</span>, <br/>  <span class="parameter">compare</span> : (<span class="type">K</span>, <span class="type">K</span>) -&gt; <span class="type">O.Order</span>, <br/>  <span class="parameter">kvPairs</span> : <span class="type">Buffer.Buffer</span>&lt;(<span class="type">K</span>, <span class="type">V</span>)&gt;<br/>) : <a href="#type.BTree"><span class="type">BTree</span></a>&lt;<span class="type">K</span>, <span class="type">V</span>&gt;</code></h4><p><p>Allows one to quickly create a BTree from an Buffer of key value pairs</p>
<p>The Buffer class type returned is described in the Motoko-base library here:
Expand Down

0 comments on commit f6d0137

Please sign in to comment.