heap.md

@wholebuzz/search / Exports / heap

Module: heap

Table of contents

Classes

• MinHeap

Interfaces

• HeapItem

Functions

• addHeapItemList
• compareDocId
• compareHeapItem
• copyHeapData
• genericCompare
• incrementHeapItem
• intersectHeaps
• reloadHeapItem

Functions

addHeapItemList

▸ Const addHeapItemList(target: HeapItem[], term: undefined | string, pl: undefined | null | { data: Posting[] }, reader?: null | RecordReader): void

Parameters

Name	Type
target	HeapItem[]
term	undefined | string
pl	undefined | null | { data: Posting[] }
reader?	null | RecordReader

Returns: void

Defined in: src/heap.ts:44

---

compareDocId

▸ Const compareDocId(itemA: HasDocId, itemB: HasDocId): 0 | 1 | -1

Parameters

Name	Type
itemA	HasDocId
itemB	HasDocId

Returns: 0 | 1 | -1

Defined in: src/heap.ts:101

---

compareHeapItem

▸ Const compareHeapItem(itemA: HeapItem, itemB: HeapItem): 0 | 1 | -1

Parameters

Name	Type
itemA	HeapItem
itemB	HeapItem

Returns: 0 | 1 | -1

Defined in: src/heap.ts:15

---

copyHeapData

▸ Const copyHeapData(heap: MinHeap<HeapItem>): Promise<Posting[]>

Parameters

Name	Type
heap	MinHeap<HeapItem>

Returns: Promise<Posting[]>

Defined in: src/heap.ts:88

---

genericCompare

▸ genericCompare<X>(a: X, b: X): 0 | 1 | -1

Type parameters

Name
X

Parameters

Name	Type
a	X
b	X

Returns: 0 | 1 | -1

Defined in: src/heap.ts:104

---

incrementHeapItem

▸ Const incrementHeapItem(heap: MinHeap<HeapItem>, item: HeapItem): boolean

Parameters

Name	Type
heap	MinHeap<HeapItem>
item	HeapItem

Returns: boolean

Defined in: src/heap.ts:18

---

intersectHeaps

▸ Const intersectHeaps(heapA: MinHeap<HeapItem>, heapB: MinHeap<HeapItem>, scoreF: (postingA: Posting, postingB: Posting, modify: boolean) => Posting, modify?: boolean): Promise<Posting[]>

Parameters

Name	Type	Default value
heapA	MinHeap<HeapItem>	-
heapB	MinHeap<HeapItem>	-
scoreF	(postingA: Posting, postingB: Posting, modify: boolean) => Posting	-
modify	boolean	false

Returns: Promise<Posting[]>

Defined in: src/heap.ts:55

---

reloadHeapItem

▸ Const reloadHeapItem(heap: MinHeap<HeapItem>, item: HeapItem, nextRecord: null | Uint8Array): void

Parameters

Name	Type
heap	MinHeap<HeapItem>
item	HeapItem
nextRecord	null | Uint8Array

Returns: void

Defined in: src/heap.ts:30