nuget
Binary heap wrapper around the IList It's a max-heap implementation i.e. the maximum element is always on top. But the order of elements can be customized by providing IComparer instance.
BinaryHeap
Type Parameters
| Name | Description |
|---|---|
T | The type of the items in the source list. |
01 Syntax
Microsoft.VisualBasic.Data.GraphTheory.KNearNeighbors.HNSW.BinaryHeap`1
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| .ctor | 2 | Initializes a new instance of the BinaryHeap class. |
| Push | 1 | Pushes item to the heap. |
| Pop | 1 | Pops the item from the heap. |
| SiftDown | 1 | Restores the heap property starting from i'th position down to the bottom given that the downstream items fulfill the rule. |
| SiftUp | 1 | Restores the heap property starting from i'th position up to the head given that the upstream items fulfill the rule. |
| Swap | 1 | Swaps items with the specified indicies. |
03 Properties
04 Fields
05 Members
#ctor(
IList(Of `0))Initializes a new instance of the BinaryHeap class.
Parameters
| Name | Type | Description |
|---|---|---|
buffer | IList(Of `0) | The buffer to store heap items. |
#ctor(
IList(Of `0), IComparer(Of `0))Initializes a new instance of the BinaryHeap class.
Parameters
| Name | Type | Description |
|---|---|---|
buffer | IList(Of `0) | The buffer to store heap items. |
comparer | IComparer(Of `0) | The comparer which defines order of items. |
Push(
`0)Pushes item to the heap.
Parameters
| Name | Type | Description |
|---|---|---|
item | `0 | The item to push. |
Pop
Pops the item from the heap.
Returns
The popped item.
SiftDown(
Int32)Restores the heap property starting from i'th position down to the bottom given that the downstream items fulfill the rule.
Parameters
| Name | Type | Description |
|---|---|---|
i | Int32 | The position of item where heap property is violated. |
SiftUp(
Int32)Restores the heap property starting from i'th position up to the head given that the upstream items fulfill the rule.
Parameters
| Name | Type | Description |
|---|---|---|
i | Int32 | The position of item where heap property is violated. |
Swap(
Int32, Int32)Swaps items with the specified indicies.
Parameters
| Name | Type | Description |
|---|---|---|
i | Int32 | The first index. |
j | Int32 | The second index. |
_Comparer
Gets the heap comparer.
_Buffer
Gets the buffer of the heap.
Comparer
Buffer