Skip to content

Commit d7191fc

Browse files
author
buildbot121
committed
API documentation update by build server
1 parent 2e3ceec commit d7191fc

24 files changed

+1863
-389
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h3 id="properties">Properties
217217
<a id="Advanced_Algorithms_DataStructures_ArrayList_1_Item_" data-uid="Advanced.Algorithms.DataStructures.ArrayList`1.Item*"></a>
218218
<h4 id="Advanced_Algorithms_DataStructures_ArrayList_1_Item_System_Int32_" data-uid="Advanced.Algorithms.DataStructures.ArrayList`1.Item(System.Int32)">Item[Int32]</h4>
219219
<div class="markdown level1 summary"><p>Indexed access to array.
220-
Time Complexity: O(1).</p>
220+
Time complexity: O(1).</p>
221221
</div>
222222
<div class="markdown level1 conceptual"></div>
223223
<h5 class="decalaration">Declaration</h5>

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

Lines changed: 152 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Advanced_Algorithms_DataStructures_BMaxHeap_1" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1" class="text-break">Class BMaxHeap&lt;T&gt;
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>A binary max heap implementation.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>
@@ -144,14 +145,79 @@ <h3 id="constructors">Constructors
144145
</h3>
145146

146147

148+
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor*"></a>
149+
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor">BMaxHeap()</h4>
150+
<div class="markdown level1 summary"></div>
151+
<div class="markdown level1 conceptual"></div>
152+
<h5 class="decalaration">Declaration</h5>
153+
<div class="codewrapper">
154+
<pre><code class="lang-csharp hljs">public BMaxHeap()</code></pre>
155+
</div>
156+
157+
158+
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor*"></a>
159+
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_System_Collections_Generic_IComparer__0__" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor(System.Collections.Generic.IComparer{`0})">BMaxHeap(IComparer&lt;T&gt;)</h4>
160+
<div class="markdown level1 summary"></div>
161+
<div class="markdown level1 conceptual"></div>
162+
<h5 class="decalaration">Declaration</h5>
163+
<div class="codewrapper">
164+
<pre><code class="lang-csharp hljs">public BMaxHeap(IComparer&lt;T&gt; comparer)</code></pre>
165+
</div>
166+
<h5 class="parameters">Parameters</h5>
167+
<table class="table table-bordered table-striped table-condensed">
168+
<thead>
169+
<tr>
170+
<th>Type</th>
171+
<th>Name</th>
172+
<th>Description</th>
173+
</tr>
174+
</thead>
175+
<tbody>
176+
<tr>
177+
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.icomparer-1">IComparer</a>&lt;T&gt;</td>
178+
<td><span class="parametername">comparer</span></td>
179+
<td></td>
180+
</tr>
181+
</tbody>
182+
</table>
183+
184+
147185
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor*"></a>
148186
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_System_Collections_Generic_IEnumerable__0__" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor(System.Collections.Generic.IEnumerable{`0})">BMaxHeap(IEnumerable&lt;T&gt;)</h4>
149-
<div class="markdown level1 summary"><p>Initialize with optional init value</p>
187+
<div class="markdown level1 summary"></div>
188+
<div class="markdown level1 conceptual"></div>
189+
<h5 class="decalaration">Declaration</h5>
190+
<div class="codewrapper">
191+
<pre><code class="lang-csharp hljs">public BMaxHeap(IEnumerable&lt;T&gt; initial)</code></pre>
192+
</div>
193+
<h5 class="parameters">Parameters</h5>
194+
<table class="table table-bordered table-striped table-condensed">
195+
<thead>
196+
<tr>
197+
<th>Type</th>
198+
<th>Name</th>
199+
<th>Description</th>
200+
</tr>
201+
</thead>
202+
<tbody>
203+
<tr>
204+
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</td>
205+
<td><span class="parametername">initial</span></td>
206+
<td></td>
207+
</tr>
208+
</tbody>
209+
</table>
210+
211+
212+
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor*"></a>
213+
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1__ctor_System_Collections_Generic_IEnumerable__0__System_Collections_Generic_IComparer__0__" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})">BMaxHeap(IEnumerable&lt;T&gt;, IComparer&lt;T&gt;)</h4>
214+
<div class="markdown level1 summary"><p>Constructor.
215+
Time complexity: O(n) if initial is provided. Otherwise O(1).</p>
150216
</div>
151217
<div class="markdown level1 conceptual"></div>
152218
<h5 class="decalaration">Declaration</h5>
153219
<div class="codewrapper">
154-
<pre><code class="lang-csharp hljs">public BMaxHeap(IEnumerable&lt;T&gt; initial = null)</code></pre>
220+
<pre><code class="lang-csharp hljs">public BMaxHeap(IEnumerable&lt;T&gt; initial, IComparer&lt;T&gt; comparer)</code></pre>
155221
</div>
156222
<h5 class="parameters">Parameters</h5>
157223
<table class="table table-bordered table-striped table-condensed">
@@ -166,6 +232,12 @@ <h5 class="parameters">Parameters</h5>
166232
<tr>
167233
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</td>
168234
<td><span class="parametername">initial</span></td>
235+
<td><p>The initial items in the heap.</p>
236+
</td>
237+
</tr>
238+
<tr>
239+
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.icomparer-1">IComparer</a>&lt;T&gt;</td>
240+
<td><span class="parametername">comparer</span></td>
169241
<td></td>
170242
</tr>
171243
</tbody>
@@ -201,9 +273,81 @@ <h3 id="methods">Methods
201273
</h3>
202274

203275

276+
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1_Delete_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.Delete*"></a>
277+
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1_Delete__0_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.Delete(`0)">Delete(T)</h4>
278+
<div class="markdown level1 summary"><p>Time complexity: O(n).</p>
279+
</div>
280+
<div class="markdown level1 conceptual"></div>
281+
<h5 class="decalaration">Declaration</h5>
282+
<div class="codewrapper">
283+
<pre><code class="lang-csharp hljs">public void Delete(T value)</code></pre>
284+
</div>
285+
<h5 class="parameters">Parameters</h5>
286+
<table class="table table-bordered table-striped table-condensed">
287+
<thead>
288+
<tr>
289+
<th>Type</th>
290+
<th>Name</th>
291+
<th>Description</th>
292+
</tr>
293+
</thead>
294+
<tbody>
295+
<tr>
296+
<td><span class="xref">T</span></td>
297+
<td><span class="parametername">value</span></td>
298+
<td></td>
299+
</tr>
300+
</tbody>
301+
</table>
302+
303+
304+
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1_Exists_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.Exists*"></a>
305+
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1_Exists__0_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.Exists(`0)">Exists(T)</h4>
306+
<div class="markdown level1 summary"><p>Time complexity: O(n).</p>
307+
</div>
308+
<div class="markdown level1 conceptual"></div>
309+
<h5 class="decalaration">Declaration</h5>
310+
<div class="codewrapper">
311+
<pre><code class="lang-csharp hljs">public bool Exists(T value)</code></pre>
312+
</div>
313+
<h5 class="parameters">Parameters</h5>
314+
<table class="table table-bordered table-striped table-condensed">
315+
<thead>
316+
<tr>
317+
<th>Type</th>
318+
<th>Name</th>
319+
<th>Description</th>
320+
</tr>
321+
</thead>
322+
<tbody>
323+
<tr>
324+
<td><span class="xref">T</span></td>
325+
<td><span class="parametername">value</span></td>
326+
<td></td>
327+
</tr>
328+
</tbody>
329+
</table>
330+
<h5 class="returns">Returns</h5>
331+
<table class="table table-bordered table-striped table-condensed">
332+
<thead>
333+
<tr>
334+
<th>Type</th>
335+
<th>Description</th>
336+
</tr>
337+
</thead>
338+
<tbody>
339+
<tr>
340+
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
341+
<td></td>
342+
</tr>
343+
</tbody>
344+
</table>
345+
346+
204347
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1_ExtractMax_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.ExtractMax*"></a>
205348
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1_ExtractMax" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.ExtractMax">ExtractMax()</h4>
206-
<div class="markdown level1 summary"></div>
349+
<div class="markdown level1 summary"><p>Time complexity: O(log(n)).</p>
350+
</div>
207351
<div class="markdown level1 conceptual"></div>
208352
<h5 class="decalaration">Declaration</h5>
209353
<div class="codewrapper">
@@ -253,7 +397,8 @@ <h5 class="returns">Returns</h5>
253397

254398
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1_Insert_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.Insert*"></a>
255399
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1_Insert__0_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.Insert(`0)">Insert(T)</h4>
256-
<div class="markdown level1 summary"></div>
400+
<div class="markdown level1 summary"><p>Time complexity: O(log(n)).</p>
401+
</div>
257402
<div class="markdown level1 conceptual"></div>
258403
<h5 class="decalaration">Declaration</h5>
259404
<div class="codewrapper">
@@ -280,7 +425,8 @@ <h5 class="parameters">Parameters</h5>
280425

281426
<a id="Advanced_Algorithms_DataStructures_BMaxHeap_1_PeekMax_" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.PeekMax*"></a>
282427
<h4 id="Advanced_Algorithms_DataStructures_BMaxHeap_1_PeekMax" data-uid="Advanced.Algorithms.DataStructures.BMaxHeap`1.PeekMax">PeekMax()</h4>
283-
<div class="markdown level1 summary"></div>
428+
<div class="markdown level1 summary"><p>Time complexity: O(1).</p>
429+
</div>
284430
<div class="markdown level1 conceptual"></div>
285431
<h5 class="decalaration">Declaration</h5>
286432
<div class="codewrapper">

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Advanced_Algorithms_DataStructures_BMinHeap_1" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1" class="text-break">Class BMinHeap&lt;T&gt;
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>A binary min heap implementation.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>
@@ -210,7 +211,8 @@ <h5 class="parameters">Parameters</h5>
210211

211212
<a id="Advanced_Algorithms_DataStructures_BMinHeap_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.#ctor*"></a>
212213
<h4 id="Advanced_Algorithms_DataStructures_BMinHeap_1__ctor_System_Collections_Generic_IEnumerable__0__System_Collections_Generic_IComparer__0__" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})">BMinHeap(IEnumerable&lt;T&gt;, IComparer&lt;T&gt;)</h4>
213-
<div class="markdown level1 summary"><p>Initialize with optional init value</p>
214+
<div class="markdown level1 summary"><p>Constructor.
215+
Time complexity: O(n) if initial is provided. Otherwise O(1).</p>
214216
</div>
215217
<div class="markdown level1 conceptual"></div>
216218
<h5 class="decalaration">Declaration</h5>
@@ -230,7 +232,8 @@ <h5 class="parameters">Parameters</h5>
230232
<tr>
231233
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</td>
232234
<td><span class="parametername">initial</span></td>
233-
<td></td>
235+
<td><p>The initial items in the heap.</p>
236+
</td>
234237
</tr>
235238
<tr>
236239
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.icomparer-1">IComparer</a>&lt;T&gt;</td>
@@ -272,7 +275,8 @@ <h3 id="methods">Methods
272275

273276
<a id="Advanced_Algorithms_DataStructures_BMinHeap_1_Delete_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.Delete*"></a>
274277
<h4 id="Advanced_Algorithms_DataStructures_BMinHeap_1_Delete__0_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.Delete(`0)">Delete(T)</h4>
275-
<div class="markdown level1 summary"></div>
278+
<div class="markdown level1 summary"><p>Time complexity: O(n).</p>
279+
</div>
276280
<div class="markdown level1 conceptual"></div>
277281
<h5 class="decalaration">Declaration</h5>
278282
<div class="codewrapper">
@@ -299,7 +303,8 @@ <h5 class="parameters">Parameters</h5>
299303

300304
<a id="Advanced_Algorithms_DataStructures_BMinHeap_1_Exists_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.Exists*"></a>
301305
<h4 id="Advanced_Algorithms_DataStructures_BMinHeap_1_Exists__0_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.Exists(`0)">Exists(T)</h4>
302-
<div class="markdown level1 summary"></div>
306+
<div class="markdown level1 summary"><p>Time complexity: O(n).</p>
307+
</div>
303308
<div class="markdown level1 conceptual"></div>
304309
<h5 class="decalaration">Declaration</h5>
305310
<div class="codewrapper">
@@ -341,7 +346,8 @@ <h5 class="returns">Returns</h5>
341346

342347
<a id="Advanced_Algorithms_DataStructures_BMinHeap_1_ExtractMin_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.ExtractMin*"></a>
343348
<h4 id="Advanced_Algorithms_DataStructures_BMinHeap_1_ExtractMin" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.ExtractMin">ExtractMin()</h4>
344-
<div class="markdown level1 summary"></div>
349+
<div class="markdown level1 summary"><p>Time complexity: O(log(n)).</p>
350+
</div>
345351
<div class="markdown level1 conceptual"></div>
346352
<h5 class="decalaration">Declaration</h5>
347353
<div class="codewrapper">
@@ -391,7 +397,8 @@ <h5 class="returns">Returns</h5>
391397

392398
<a id="Advanced_Algorithms_DataStructures_BMinHeap_1_Insert_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.Insert*"></a>
393399
<h4 id="Advanced_Algorithms_DataStructures_BMinHeap_1_Insert__0_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.Insert(`0)">Insert(T)</h4>
394-
<div class="markdown level1 summary"></div>
400+
<div class="markdown level1 summary"><p>Time complexity: O(log(n)).</p>
401+
</div>
395402
<div class="markdown level1 conceptual"></div>
396403
<h5 class="decalaration">Declaration</h5>
397404
<div class="codewrapper">
@@ -418,7 +425,8 @@ <h5 class="parameters">Parameters</h5>
418425

419426
<a id="Advanced_Algorithms_DataStructures_BMinHeap_1_PeekMin_" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.PeekMin*"></a>
420427
<h4 id="Advanced_Algorithms_DataStructures_BMinHeap_1_PeekMin" data-uid="Advanced.Algorithms.DataStructures.BMinHeap`1.PeekMin">PeekMin()</h4>
421-
<div class="markdown level1 summary"></div>
428+
<div class="markdown level1 summary"><p>Time complexity: O(1).</p>
429+
</div>
422430
<div class="markdown level1 conceptual"></div>
423431
<h5 class="decalaration">Declaration</h5>
424432
<div class="codewrapper">

0 commit comments

Comments
 (0)