Skip to content

Commit 2d60653

Browse files
lorenteylorentey
committed
Move docs from gh-pages branch
1 parent 457fae5 commit 2d60653

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+40875
-0
lines changed

‎docs/Classes.html

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Classes Reference</title>
5+
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
7+
<meta charset="utf-8">
8+
<script src="js/jquery.min.js" defer></script>
9+
<script src="js/jazzy.js" defer></script>
10+
11+
</head>
12+
<body>
13+
14+
15+
<a title="Classes Reference"></a>
16+
17+
<header class="header">
18+
<p class="header-col header-col--primary">
19+
<a class="header-link" href="index.html">
20+
BTree Docs
21+
</a>
22+
(100% documented)
23+
</p>
24+
25+
<p class="header-col header-col--secondary">
26+
<a class="header-link" href="https://github.com/lorentey/BTree">
27+
<img class="header-icon" src="img/gh.png"/>
28+
View on GitHub
29+
</a>
30+
</p>
31+
32+
<p class="header-col header-col--secondary">
33+
<a class="header-link" href="dash-feed://https%3A%2F%2Florentey%2Egithub%2Eio%2FBTree%2Freference%2Fdocsets%2FBTree%2Exml">
34+
<img class="header-icon" src="img/dash.png"/>
35+
Install in Dash
36+
</a>
37+
</p>
38+
</header>
39+
40+
<p class="breadcrumbs">
41+
<a class="breadcrumb" href="index.html">BTree Reference</a>
42+
<img class="carat" src="img/carat.png" />
43+
Classes Reference
44+
</p>
45+
46+
<div class="content-wrapper">
47+
<nav class="navigation">
48+
<ul class="nav-groups">
49+
<li class="nav-group-name">
50+
<a class="nav-group-name-link" href="Classes.html">Classes</a>
51+
<ul class="nav-group-tasks">
52+
<li class="nav-group-task">
53+
<a class="nav-group-task-link" href="Classes/BTreeCursor.html">BTreeCursor</a>
54+
</li>
55+
</ul>
56+
</li>
57+
<li class="nav-group-name">
58+
<a class="nav-group-name-link" href="Enums.html">Enums</a>
59+
<ul class="nav-group-tasks">
60+
<li class="nav-group-task">
61+
<a class="nav-group-task-link" href="Enums/BTreeKeySelector.html">BTreeKeySelector</a>
62+
</li>
63+
<li class="nav-group-task">
64+
<a class="nav-group-task-link" href="Enums/BTreeMatchingStrategy.html">BTreeMatchingStrategy</a>
65+
</li>
66+
</ul>
67+
</li>
68+
<li class="nav-group-name">
69+
<a class="nav-group-name-link" href="Structs.html">Structs</a>
70+
<ul class="nav-group-tasks">
71+
<li class="nav-group-task">
72+
<a class="nav-group-task-link" href="Structs/BTree.html">BTree</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a class="nav-group-task-link" href="Structs/BTreeIndex.html">BTreeIndex</a>
76+
</li>
77+
<li class="nav-group-task">
78+
<a class="nav-group-task-link" href="Structs/BTreeIterator.html">BTreeIterator</a>
79+
</li>
80+
<li class="nav-group-task">
81+
<a class="nav-group-task-link" href="Structs/BTreeKeyIterator.html">BTreeKeyIterator</a>
82+
</li>
83+
<li class="nav-group-task">
84+
<a class="nav-group-task-link" href="Structs/BTreeValueIterator.html">BTreeValueIterator</a>
85+
</li>
86+
<li class="nav-group-task">
87+
<a class="nav-group-task-link" href="Structs/List.html">List</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a class="nav-group-task-link" href="Structs/Map.html">Map</a>
91+
</li>
92+
<li class="nav-group-task">
93+
<a class="nav-group-task-link" href="Structs/SortedBag.html">SortedBag</a>
94+
</li>
95+
<li class="nav-group-task">
96+
<a class="nav-group-task-link" href="Structs/SortedSet.html">SortedSet</a>
97+
</li>
98+
</ul>
99+
</li>
100+
</ul>
101+
</nav>
102+
<article class="main-content">
103+
104+
<section class="section">
105+
<div class="section-content">
106+
<h1>Classes</h1>
107+
<p>The following classes are available globally.</p>
108+
109+
</div>
110+
</section>
111+
112+
<section class="section">
113+
<div class="section-content">
114+
<div class="task-group">
115+
<ul class="item-container">
116+
<li class="item">
117+
<div>
118+
<code>
119+
<a name="/s:C5BTree11BTreeCursor"></a>
120+
<a name="//apple_ref/swift/Class/BTreeCursor" class="dashAnchor"></a>
121+
<a class="token" href="#/s:C5BTree11BTreeCursor">BTreeCursor</a>
122+
</code>
123+
</div>
124+
<div class="height-container">
125+
<div class="pointer-container"></div>
126+
<section class="section">
127+
<div class="pointer"></div>
128+
<div class="abstract">
129+
<p>A stateful editing interface for efficiently inserting/removing/updating a range of elements in a B-tree.</p>
130+
131+
<p>Creating a cursor over a tree takes exclusive ownership of it; the tree is in a transient invalid state
132+
while the cursor is active. (In particular, element counts are not finalized until the cursor is deactivated.)</p>
133+
134+
<p>The cursor always focuses on a particular spot on the tree: either a particular element, or the empty spot after
135+
the last element. There are methods to move the cursor to the next or previous element, to modify the currently
136+
focused element, to insert a new element before the current position, and to remove the currently focused element
137+
from the tree.</p>
138+
139+
<p>Note that the cursor does not verify that keys you insert/modify uphold tree invariants &ndash; it is your responsibility
140+
to guarantee keys remain in ascending order while you&rsquo;re working with the cursor.</p>
141+
142+
<p>Creating a cursor takes O(log(<em>n</em>)) steps; once the cursor has been created, the complexity of most manipulations
143+
is amortized O(1). For example, appending <em>k</em> new elements without a cursor takes O(<em>k</em> * log(<em>n</em>)) steps;
144+
using a cursor to do the same only takes O(log(<em>n</em>) + <em>k</em>).</p>
145+
146+
<a href="Classes/BTreeCursor.html" class="slightly-smaller">See more</a>
147+
</div>
148+
<div class="declaration">
149+
<h4>Declaration</h4>
150+
<div class="language">
151+
<p class="aside-title">Swift</p>
152+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">BTreeCursor</span><span class="o">&lt;</span><span class="kt">Key</span><span class="p">:</span> <span class="kt">Comparable</span><span class="p">,</span> <span class="kt">Value</span><span class="o">&gt;</span></code></pre>
153+
154+
</div>
155+
</div>
156+
<div class="slightly-smaller">
157+
<a href="https://github.com/lorentey/BTree/tree/v4.0.1/Sources/BTreeCursor.swift#L310-L705">Show on GitHub</a>
158+
</div>
159+
</section>
160+
</div>
161+
</li>
162+
</ul>
163+
</div>
164+
</div>
165+
</section>
166+
167+
</article>
168+
</div>
169+
<section class="footer">
170+
<p>&copy; 2016 <a class="link" href="https://twitter.com/lorentey" target="_blank" rel="external">Károly Lőrentey</a>. All rights reserved. (Last updated: 2016-11-08)</p>
171+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
172+
</section>
173+
</body>
174+
</div>
175+
</html>

0 commit comments

Comments
 (0)