You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: xml/System.Collections.Generic/PriorityQueue`2.xml
+17-25Lines changed: 17 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -20,14 +20,13 @@
20
20
<Docs>
21
21
<typeparamname="TElement">Specifies the type of elements in the queue.</typeparam>
22
22
<typeparamname="TPriority">Specifies the type of priority associated with enqueued elements.</typeparam>
23
-
<summary>Represents a min priority queue.</summary>
23
+
<summary>Represents a collection of items that have a value and a priority. On dequeue, the item with the lowest priority value is removed.</summary>
24
24
<remarks>
25
25
<formattype="text/markdown"><![CDATA[
26
26
27
27
## Remarks
28
28
29
-
Implements an array-backed quaternary min-heap. Each element is enqueued with an associated priority
30
-
that determines the dequeue order: elements with the lowest priority get dequeued first.
29
+
Implements an array-backed, quaternary min-heap. Each element is enqueued with an associated priority that determines the dequeue order. Elements with the lowest priority are dequeued first.
31
30
32
31
]]></format>
33
32
</remarks>
@@ -102,8 +101,7 @@ Implements an array-backed quaternary min-heap. Each element is enqueued with an
102
101
103
102
## Remarks
104
103
105
-
Constructs the heap using a heapify operation,
106
-
which is generally faster than enqueuing individual elements sequentially.
104
+
Constructs the heap using a heapify operation, which is generally faster than enqueuing individual elements sequentially.
107
105
108
106
]]></format>
109
107
</remarks>
@@ -165,8 +163,7 @@ Constructs the heap using a heapify operation,
165
163
166
164
## Remarks
167
165
168
-
Constructs the heap using a heapify operation,
169
-
which is generally faster than enqueuing individual elements sequentially.
166
+
Constructs the heap using a heapify operation, which is generally faster than enqueuing individual elements sequentially.
170
167
171
168
]]></format>
172
169
</remarks>
@@ -236,7 +233,7 @@ Constructs the heap using a heapify operation,
236
233
</ReturnValue>
237
234
<Docs>
238
235
<summary>Gets the priority comparer used by the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
239
-
<value>To be added.</value>
236
+
<value>The comparer that determines the priority of items in the queue.</value>
240
237
<remarks>To be added.</remarks>
241
238
</Docs>
242
239
</Member>
@@ -257,7 +254,7 @@ Constructs the heap using a heapify operation,
257
254
</ReturnValue>
258
255
<Docs>
259
256
<summary>Gets the number of elements contained in the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
260
-
<value>To be added.</value>
257
+
<value>The number of elements contained in the queue.</value>
261
258
<remarks>To be added.</remarks>
262
259
</Docs>
263
260
</Member>
@@ -278,7 +275,7 @@ Constructs the heap using a heapify operation,
278
275
</ReturnValue>
279
276
<Parameters />
280
277
<Docs>
281
-
<summary>Removes and returns the minimal element from the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
278
+
<summary>Removes and returns the minimal element from the <seecref="T:System.Collections.Generic.PriorityQueue`2" /> - that is, the element with the lowest priority value.</summary>
282
279
<returns>The minimal element of the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</returns>
283
280
<remarks>To be added.</remarks>
284
281
<exceptioncref="T:System.InvalidOperationException">The queue is empty.</exception>
@@ -339,9 +336,7 @@ Constructs the heap using a heapify operation,
339
336
340
337
## Remarks
341
338
342
-
Implements an insert-then-extract heap operation that is generally more efficient
343
-
than sequencing Enqueue and Dequeue operations: in the worst case scenario only one
344
-
sift-down operation is required.
339
+
Implements an insert-then-extract heap operation that's generally more efficient than sequencing enqueue and dequeue operations.
345
340
346
341
]]></format>
347
342
</remarks>
@@ -374,7 +369,7 @@ Implements an insert-then-extract heap operation that is generally more efficien
374
369
</Parameters>
375
370
<Docs>
376
371
<paramname="items">The pairs of elements and priorities to add to the queue.</param>
377
-
<summary>Enqueues a sequence of element/priority pairs to the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
372
+
<summary>Enqueues a sequence of element-priority pairs to the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
378
373
<remarks>To be added.</remarks>
379
374
<exceptioncref="T:System.ArgumentNullException">The specified <paramrefname="items" /> argument was <seelangword="null" />.</exception>
380
375
</Docs>
@@ -478,8 +473,7 @@ Implements an insert-then-extract heap operation that is generally more efficien
478
473
479
474
## Remarks
480
475
481
-
This method can be used to minimize a collection's memory overhead
482
-
if no new elements will be added to the collection.
476
+
This method can be used to minimize a collection's memory overhead if no new elements will be added to the collection.
483
477
484
478
]]></format>
485
479
</remarks>
@@ -519,9 +513,9 @@ This method can be used to minimize a collection's memory overhead
519
513
</Parameter>
520
514
</Parameters>
521
515
<Docs>
522
-
<paramname="element">The removed element.</param>
523
-
<paramname="priority">The priority associated with the removed element.</param>
524
-
<summary>Removes the minimal element from the <seecref="T:System.Collections.Generic.PriorityQueue`2" />, and copies it to the <paramrefname="element" /> parameter, and its associated priority to the <paramrefname="priority" /> parameter.</summary>
516
+
<paramname="element">When this method returns, contains the removed element.</param>
517
+
<paramname="priority">When this method returns, contains the priority associated with the removed element.</param>
518
+
<summary>Removes the minimal element from the <seecref="T:System.Collections.Generic.PriorityQueue`2" />, and copies it and its associated priority to the <paramrefname="element" /> and <paramrefname="priority" /> arguments.</summary>
525
519
<returns>
526
520
<seelangword="true" /> if the element is successfully removed; <seelangword="false" /> if the <seecref="T:System.Collections.Generic.PriorityQueue`2" /> is empty.</returns>
527
521
<remarks>To be added.</remarks>
@@ -561,10 +555,9 @@ This method can be used to minimize a collection's memory overhead
561
555
</Parameter>
562
556
</Parameters>
563
557
<Docs>
564
-
<paramname="element">The minimal element in the queue.</param>
565
-
<paramname="priority">The priority associated with the minimal element.</param>
566
-
<summary>Returns a value that indicates whether there is a minimal element in the <seecref="T:System.Collections.Generic.PriorityQueue`2" />, and if one is present, copies it to the <paramrefname="element" /> parameter, and its associated priority to the <paramrefname="priority" /> parameter.
567
-
The element is not removed from the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
558
+
<paramname="element">When this method returns, contains the minimal element in the queue.</param>
559
+
<paramname="priority">When this method returns, contains the priority associated with the minimal element.</param>
560
+
<summary>Returns a value that indicates whether there is a minimal element in the <seecref="T:System.Collections.Generic.PriorityQueue`2" />, and if one is present, copies it and its associated priority to the <paramrefname="element" /> and <paramrefname="priority" /> arguments. The element is not removed from the <seecref="T:System.Collections.Generic.PriorityQueue`2" />.</summary>
568
561
<returns>
569
562
<seelangword="true" /> if there is a minimal element; <seelangword="false" /> if the <seecref="T:System.Collections.Generic.PriorityQueue`2" /> is empty.</returns>
570
563
<remarks>To be added.</remarks>
@@ -593,8 +586,7 @@ This method can be used to minimize a collection's memory overhead
593
586
594
587
## Remarks
595
588
596
-
The enumeration does not order items by priority, since that would require N * log(N) time and N space.
597
-
Items are instead enumerated following the internal array heap layout.
589
+
The enumeration does not order items by priority, since that would require N * log(N) time and N space. Instead, items are enumerated following the internal array heap layout.
0 commit comments