Skip to content

Commit cf79bee

Browse files
author
buildbot121
committed
API documentation update by build server
1 parent 891efb3 commit cf79bee

9 files changed

+157
-65
lines changed

‎docs/api/Advanced.Algorithms.DataStructures.AVLTree-1.html‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,11 +122,13 @@ <h3 id="constructors">Constructors
122122

123123
<a id="Advanced_Algorithms_DataStructures_AVLTree_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.AVLTree`1.#ctor*"></a>
124124
<h4 id="Advanced_Algorithms_DataStructures_AVLTree_1__ctor_IEnumerable__0__System_Boolean_" data-uid="Advanced.Algorithms.DataStructures.AVLTree`1.#ctor(IEnumerable{`0},System.Boolean)">AVLTree(IEnumerable&lt;T&gt;, Boolean)</h4>
125-
<div class="markdown level1 summary"></div>
125+
<div class="markdown level1 summary"><p>Initialize the BST with given sorted keys.
126+
Time complexity: O(n).</p>
127+
</div>
126128
<div class="markdown level1 conceptual"></div>
127129
<h5 class="decalaration">Declaration</h5>
128130
<div class="codewrapper">
129-
<pre><code class="lang-csharp hljs">public AVLTree(IEnumerable&lt;T&gt; collection, bool enableNodeLookUp = false)</code></pre>
131+
<pre><code class="lang-csharp hljs">public AVLTree(IEnumerable&lt;T&gt; sortedKeys, bool enableNodeLookUp = false)</code></pre>
130132
</div>
131133
<h5 class="parameters">Parameters</h5>
132134
<table class="table table-bordered table-striped table-condensed">
@@ -140,13 +142,16 @@ <h5 class="parameters">Parameters</h5>
140142
<tbody>
141143
<tr>
142144
<td><span class="xref">IEnumerable</span>&lt;T&gt;</td>
143-
<td><span class="parametername">collection</span></td>
144-
<td></td>
145+
<td><span class="parametername">sortedKeys</span></td>
146+
<td><p>The sorted keys.</p>
147+
</td>
145148
</tr>
146149
<tr>
147150
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
148151
<td><span class="parametername">enableNodeLookUp</span></td>
149-
<td></td>
152+
<td><p>Enabling lookup will fasten deletion/insertion/exists operations
153+
at the cost of additional space.</p>
154+
</td>
150155
</tr>
151156
</tbody>
152157
</table>
@@ -174,7 +179,7 @@ <h5 class="parameters">Parameters</h5>
174179
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
175180
<td><span class="parametername">enableNodeLookUp</span></td>
176181
<td><p>Enabling lookup will fasten deletion/insertion/exists operations
177-
at the cost of additional space.</p>
182+
at the cost of additional space.</p>
178183
</td>
179184
</tr>
180185
</tbody>

‎docs/api/Advanced.Algorithms.DataStructures.BST-1.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,13 @@ <h5 class="decalaration">Declaration</h5>
132132

133133
<a id="Advanced_Algorithms_DataStructures_BST_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.BST`1.#ctor*"></a>
134134
<h4 id="Advanced_Algorithms_DataStructures_BST_1__ctor_IEnumerable__0__" data-uid="Advanced.Algorithms.DataStructures.BST`1.#ctor(IEnumerable{`0})">BST(IEnumerable&lt;T&gt;)</h4>
135-
<div class="markdown level1 summary"></div>
135+
<div class="markdown level1 summary"><p>Initialize the BST with given sorted keys.
136+
Time complexity: O(n).</p>
137+
</div>
136138
<div class="markdown level1 conceptual"></div>
137139
<h5 class="decalaration">Declaration</h5>
138140
<div class="codewrapper">
139-
<pre><code class="lang-csharp hljs">public BST(IEnumerable&lt;T&gt; collection)</code></pre>
141+
<pre><code class="lang-csharp hljs">public BST(IEnumerable&lt;T&gt; sortedKeys)</code></pre>
140142
</div>
141143
<h5 class="parameters">Parameters</h5>
142144
<table class="table table-bordered table-striped table-condensed">
@@ -150,7 +152,7 @@ <h5 class="parameters">Parameters</h5>
150152
<tbody>
151153
<tr>
152154
<td><span class="xref">IEnumerable</span>&lt;T&gt;</td>
153-
<td><span class="parametername">collection</span></td>
155+
<td><span class="parametername">sortedKeys</span></td>
154156
<td></td>
155157
</tr>
156158
</tbody>

‎docs/api/Advanced.Algorithms.DataStructures.Foundation.SortedDictionary-2.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,35 @@ <h5 class="decalaration">Declaration</h5>
131131
<div class="codewrapper">
132132
<pre><code class="lang-csharp hljs">public SortedDictionary()</code></pre>
133133
</div>
134+
135+
136+
<a id="Advanced_Algorithms_DataStructures_Foundation_SortedDictionary_2__ctor_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedDictionary`2.#ctor*"></a>
137+
<h4 id="Advanced_Algorithms_DataStructures_Foundation_SortedDictionary_2__ctor_IEnumerable_KeyValuePair__0__1___" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedDictionary`2.#ctor(IEnumerable{KeyValuePair{`0,`1}})">SortedDictionary(IEnumerable&lt;KeyValuePair&lt;K, V&gt;&gt;)</h4>
138+
<div class="markdown level1 summary"><p>Initialize the dictionary with given key value pairs sorted by key.
139+
Time complexity: log(n).</p>
140+
</div>
141+
<div class="markdown level1 conceptual"></div>
142+
<h5 class="decalaration">Declaration</h5>
143+
<div class="codewrapper">
144+
<pre><code class="lang-csharp hljs">public SortedDictionary(IEnumerable&lt;KeyValuePair&lt;K, V&gt;&gt; sortedKeyValuePairs)</code></pre>
145+
</div>
146+
<h5 class="parameters">Parameters</h5>
147+
<table class="table table-bordered table-striped table-condensed">
148+
<thead>
149+
<tr>
150+
<th>Type</th>
151+
<th>Name</th>
152+
<th>Description</th>
153+
</tr>
154+
</thead>
155+
<tbody>
156+
<tr>
157+
<td><span class="xref">IEnumerable</span>&lt;<span class="xref">KeyValuePair</span>&lt;K, V&gt;&gt;</td>
158+
<td><span class="parametername">sortedKeyValuePairs</span></td>
159+
<td></td>
160+
</tr>
161+
</tbody>
162+
</table>
134163
<h3 id="properties">Properties
135164
</h3>
136165

‎docs/api/Advanced.Algorithms.DataStructures.Foundation.SortedHashSet-1.html‎

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,35 @@ <h5 class="decalaration">Declaration</h5>
126126
<div class="codewrapper">
127127
<pre><code class="lang-csharp hljs">public SortedHashSet()</code></pre>
128128
</div>
129+
130+
131+
<a id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.#ctor*"></a>
132+
<h4 id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1__ctor_IEnumerable__0__" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.#ctor(IEnumerable{`0})">SortedHashSet(IEnumerable&lt;T&gt;)</h4>
133+
<div class="markdown level1 summary"><p>Initialize the sorted hashset with given sorted key collection.
134+
Time complexity: log(n).</p>
135+
</div>
136+
<div class="markdown level1 conceptual"></div>
137+
<h5 class="decalaration">Declaration</h5>
138+
<div class="codewrapper">
139+
<pre><code class="lang-csharp hljs">public SortedHashSet(IEnumerable&lt;T&gt; sortedKeys)</code></pre>
140+
</div>
141+
<h5 class="parameters">Parameters</h5>
142+
<table class="table table-bordered table-striped table-condensed">
143+
<thead>
144+
<tr>
145+
<th>Type</th>
146+
<th>Name</th>
147+
<th>Description</th>
148+
</tr>
149+
</thead>
150+
<tbody>
151+
<tr>
152+
<td><span class="xref">IEnumerable</span>&lt;T&gt;</td>
153+
<td><span class="parametername">sortedKeys</span></td>
154+
<td></td>
155+
</tr>
156+
</tbody>
157+
</table>
129158
<h3 id="properties">Properties
130159
</h3>
131160

@@ -258,15 +287,15 @@ <h5 class="returns">Returns</h5>
258287
</table>
259288

260289

261-
<a id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_Next_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.Next*"></a>
262-
<h4 id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_Next__0_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.Next(`0)">Next(T)</h4>
290+
<a id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_NextHigher_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.NextHigher*"></a>
291+
<h4 id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_NextHigher__0_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.NextHigher(`0)">NextHigher(T)</h4>
263292
<div class="markdown level1 summary"><p>Return the next higher value after given value in this hashset.
264293
Time complexity: O(log(n)).</p>
265294
</div>
266295
<div class="markdown level1 conceptual"></div>
267296
<h5 class="decalaration">Declaration</h5>
268297
<div class="codewrapper">
269-
<pre><code class="lang-csharp hljs">public T Next(T value)</code></pre>
298+
<pre><code class="lang-csharp hljs">public T NextHigher(T value)</code></pre>
270299
</div>
271300
<h5 class="parameters">Parameters</h5>
272301
<table class="table table-bordered table-striped table-condensed">
@@ -303,15 +332,15 @@ <h5 class="returns">Returns</h5>
303332
</table>
304333

305334

306-
<a id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_Previous_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.Previous*"></a>
307-
<h4 id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_Previous__0_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.Previous(`0)">Previous(T)</h4>
335+
<a id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_NextLower_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.NextLower*"></a>
336+
<h4 id="Advanced_Algorithms_DataStructures_Foundation_SortedHashSet_1_NextLower__0_" data-uid="Advanced.Algorithms.DataStructures.Foundation.SortedHashSet`1.NextLower(`0)">NextLower(T)</h4>
308337
<div class="markdown level1 summary"><p>Return the next lower value before given value in this HashSet.
309338
Time complexity: O(log(n)).</p>
310339
</div>
311340
<div class="markdown level1 conceptual"></div>
312341
<h5 class="decalaration">Declaration</h5>
313342
<div class="codewrapper">
314-
<pre><code class="lang-csharp hljs">public T Previous(T value)</code></pre>
343+
<pre><code class="lang-csharp hljs">public T NextLower(T value)</code></pre>
315344
</div>
316345
<h5 class="parameters">Parameters</h5>
317346
<table class="table table-bordered table-striped table-condensed">

‎docs/api/Advanced.Algorithms.DataStructures.RedBlackTree-1.html‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -122,11 +122,13 @@ <h3 id="constructors">Constructors
122122

123123
<a id="Advanced_Algorithms_DataStructures_RedBlackTree_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.RedBlackTree`1.#ctor*"></a>
124124
<h4 id="Advanced_Algorithms_DataStructures_RedBlackTree_1__ctor_IEnumerable__0__System_Boolean_IEqualityComparer__0__" data-uid="Advanced.Algorithms.DataStructures.RedBlackTree`1.#ctor(IEnumerable{`0},System.Boolean,IEqualityComparer{`0})">RedBlackTree(IEnumerable&lt;T&gt;, Boolean, IEqualityComparer&lt;T&gt;)</h4>
125-
<div class="markdown level1 summary"></div>
125+
<div class="markdown level1 summary"><p>Initialize the BST with given sorted keys.
126+
Time complexity: O(n).</p>
127+
</div>
126128
<div class="markdown level1 conceptual"></div>
127129
<h5 class="decalaration">Declaration</h5>
128130
<div class="codewrapper">
129-
<pre><code class="lang-csharp hljs">public RedBlackTree(IEnumerable&lt;T&gt; collection, bool enableNodeLookUp = false, IEqualityComparer&lt;T&gt; equalityComparer = null)</code></pre>
131+
<pre><code class="lang-csharp hljs">public RedBlackTree(IEnumerable&lt;T&gt; sortedKeys, bool enableNodeLookUp = false, IEqualityComparer&lt;T&gt; equalityComparer = null)</code></pre>
130132
</div>
131133
<h5 class="parameters">Parameters</h5>
132134
<table class="table table-bordered table-striped table-condensed">
@@ -140,27 +142,29 @@ <h5 class="parameters">Parameters</h5>
140142
<tbody>
141143
<tr>
142144
<td><span class="xref">IEnumerable</span>&lt;T&gt;</td>
143-
<td><span class="parametername">collection</span></td>
145+
<td><span class="parametername">sortedKeys</span></td>
144146
<td></td>
145147
</tr>
146148
<tr>
147149
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
148150
<td><span class="parametername">enableNodeLookUp</span></td>
149-
<td></td>
151+
<td><p>Enabling lookup will fasten deletion/insertion/exists operations
152+
at the cost of additional space.</p>
153+
</td>
150154
</tr>
151155
<tr>
152156
<td><span class="xref">IEqualityComparer</span>&lt;T&gt;</td>
153157
<td><span class="parametername">equalityComparer</span></td>
154-
<td></td>
158+
<td><p>Provide custom IEquality comparer for node lookup dictionary when enabled.</p>
159+
</td>
155160
</tr>
156161
</tbody>
157162
</table>
158163

159164

160165
<a id="Advanced_Algorithms_DataStructures_RedBlackTree_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.RedBlackTree`1.#ctor*"></a>
161166
<h4 id="Advanced_Algorithms_DataStructures_RedBlackTree_1__ctor_System_Boolean_IEqualityComparer__0__" data-uid="Advanced.Algorithms.DataStructures.RedBlackTree`1.#ctor(System.Boolean,IEqualityComparer{`0})">RedBlackTree(Boolean, IEqualityComparer&lt;T&gt;)</h4>
162-
<div class="markdown level1 summary"><p>Constructor</p>
163-
</div>
167+
<div class="markdown level1 summary"></div>
164168
<div class="markdown level1 conceptual"></div>
165169
<h5 class="decalaration">Declaration</h5>
166170
<div class="codewrapper">
@@ -186,7 +190,8 @@ <h5 class="parameters">Parameters</h5>
186190
<tr>
187191
<td><span class="xref">IEqualityComparer</span>&lt;T&gt;</td>
188192
<td><span class="parametername">equalityComparer</span></td>
189-
<td></td>
193+
<td><p>Provide custom IEquality comparer for node lookup dictionary when enabled.</p>
194+
</td>
190195
</tr>
191196
</tbody>
192197
</table>

‎docs/api/Advanced.Algorithms.DataStructures.SplayTree-1.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,9 @@ <h5 class="decalaration">Declaration</h5>
132132

133133
<a id="Advanced_Algorithms_DataStructures_SplayTree_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.SplayTree`1.#ctor*"></a>
134134
<h4 id="Advanced_Algorithms_DataStructures_SplayTree_1__ctor_IEnumerable__0__" data-uid="Advanced.Algorithms.DataStructures.SplayTree`1.#ctor(IEnumerable{`0})">SplayTree(IEnumerable&lt;T&gt;)</h4>
135-
<div class="markdown level1 summary"></div>
135+
<div class="markdown level1 summary"><p>Initialize the BST with given sorted keys.
136+
Time complexity: O(n).</p>
137+
</div>
136138
<div class="markdown level1 conceptual"></div>
137139
<h5 class="decalaration">Declaration</h5>
138140
<div class="codewrapper">

‎docs/api/Advanced.Algorithms.DataStructures.TreapTree-1.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,9 @@ <h5 class="decalaration">Declaration</h5>
132132

133133
<a id="Advanced_Algorithms_DataStructures_TreapTree_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.TreapTree`1.#ctor*"></a>
134134
<h4 id="Advanced_Algorithms_DataStructures_TreapTree_1__ctor_IEnumerable__0__" data-uid="Advanced.Algorithms.DataStructures.TreapTree`1.#ctor(IEnumerable{`0})">TreapTree(IEnumerable&lt;T&gt;)</h4>
135-
<div class="markdown level1 summary"></div>
135+
<div class="markdown level1 summary"><p>Initialize the BST with given sorted keys.
136+
Time complexity: O(n).</p>
137+
</div>
136138
<div class="markdown level1 conceptual"></div>
137139
<h5 class="decalaration">Declaration</h5>
138140
<div class="codewrapper">

0 commit comments

Comments
 (0)