chore: migrate to eslint 9
[poolifier.git] / tests / priority-queue.test.mjs
index 58931859cb02b7d67f63b6d3c25f0948d199c421..839b6057ba96bc99610f1641b7f2c94acb9ae7ba 100644 (file)
 import { expect } from 'expect'
 
-import { PriorityQueue } from '../lib/priority-queue.cjs'
+import { FixedPriorityQueue } from '../lib/fixed-priority-queue.cjs'
+import { defaultBucketSize, PriorityQueue } from '../lib/priority-queue.cjs'
 
 describe('Priority queue test suite', () => {
   it('Verify constructor() behavior', () => {
     expect(() => new PriorityQueue('')).toThrow(
-      new TypeError('k must be an integer')
+      new TypeError("Invalid bucket size: '' is not an integer")
     )
     expect(() => new PriorityQueue(-1)).toThrow(
-      new RangeError('k must be greater than or equal to 1')
-    )
-    expect(() => new PriorityQueue(0)).toThrow(
-      new RangeError('k must be greater than or equal to 1')
+      new RangeError('Invalid bucket size: -1 < 0')
     )
     let priorityQueue = new PriorityQueue()
-    expect(priorityQueue.k).toBe(Infinity)
+    expect(priorityQueue.bucketSize).toBe(defaultBucketSize)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(0)
     expect(priorityQueue.maxSize).toBe(0)
-    expect(priorityQueue.nodeArray).toStrictEqual([])
-    priorityQueue = new PriorityQueue(2)
-    expect(priorityQueue.k).toBe(2)
+    expect(priorityQueue.enablePriority).toBe(false)
+    expect(priorityQueue.head).toBeInstanceOf(FixedPriorityQueue)
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.head.capacity).toBe(defaultBucketSize)
+    expect(priorityQueue.tail).toBeInstanceOf(FixedPriorityQueue)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
+    const bucketSize = 2
+    priorityQueue = new PriorityQueue(bucketSize, true)
+    expect(priorityQueue.bucketSize).toBe(bucketSize)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(0)
     expect(priorityQueue.maxSize).toBe(0)
-    expect(priorityQueue.nodeArray).toStrictEqual([])
+    expect(priorityQueue.enablePriority).toBe(true)
+    expect(priorityQueue.head).toBeInstanceOf(FixedPriorityQueue)
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.head.capacity).toBe(bucketSize)
+    expect(priorityQueue.tail).toBeInstanceOf(FixedPriorityQueue)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
   })
 
-  it('Verify default k enqueue() behavior', () => {
-    const priorityQueue = new PriorityQueue()
+  it('Verify default bucket size enqueue() behavior', () => {
+    const priorityQueue = new PriorityQueue(defaultBucketSize, true)
     let rtSize = priorityQueue.enqueue(1)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(1)
     expect(priorityQueue.maxSize).toBe(1)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([{ data: 1, priority: 0 }])
+    expect(priorityQueue.head.nodeArray).toMatchObject([
+      { data: 1, priority: 0 },
+    ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(2)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(2)
     expect(priorityQueue.maxSize).toBe(2)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
-      { data: 2, priority: 0 }
+      { data: 2, priority: 0 },
     ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(3)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(3)
     expect(priorityQueue.maxSize).toBe(3)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
-      { data: 3, priority: 0 }
+      { data: 3, priority: 0 },
     ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(3, -1)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(4)
     expect(priorityQueue.maxSize).toBe(4)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
       { data: 3, priority: -1 },
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
-      { data: 3, priority: 0 }
+      { data: 3, priority: 0 },
     ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(1, 1)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(5)
     expect(priorityQueue.maxSize).toBe(5)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
       { data: 3, priority: -1 },
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
       { data: 3, priority: 0 },
-      { data: 1, priority: 1 }
+      { data: 1, priority: 1 },
     ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
   })
 
-  it('Verify k=2 enqueue() behavior', () => {
-    const priorityQueue = new PriorityQueue(2)
+  it('Verify bucketSize=2 enqueue() behavior', () => {
+    const priorityQueue = new PriorityQueue(2, true)
     let rtSize = priorityQueue.enqueue(1)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(1)
     expect(priorityQueue.maxSize).toBe(1)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([{ data: 1, priority: 0 }])
+    expect(priorityQueue.head.nodeArray).toMatchObject([
+      { data: 1, priority: 0 },
+    ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(2)
+    expect(priorityQueue.buckets).toBe(1)
     expect(priorityQueue.size).toBe(2)
     expect(priorityQueue.maxSize).toBe(2)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
-      { data: 2, priority: 0 }
+      { data: 2, priority: 0 },
     ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(3)
+    expect(priorityQueue.buckets).toBe(1)
     expect(priorityQueue.size).toBe(3)
     expect(priorityQueue.maxSize).toBe(3)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
+      { data: 3, priority: 0 },
+    ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
-      { data: 3, priority: 0 }
     ])
+    expect(priorityQueue.tail.next).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(3, -1)
+    expect(priorityQueue.buckets).toBe(2)
     expect(priorityQueue.size).toBe(4)
     expect(priorityQueue.maxSize).toBe(4)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
+      { data: 3, priority: -1 },
+      { data: 3, priority: 0 },
+    ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
-      { data: 3, priority: -1 },
-      { data: 3, priority: 0 }
     ])
+    expect(priorityQueue.tail.next).toStrictEqual(priorityQueue.head)
     rtSize = priorityQueue.enqueue(1, 1)
+    expect(priorityQueue.buckets).toBe(2)
     expect(priorityQueue.size).toBe(5)
     expect(priorityQueue.maxSize).toBe(5)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
+      { data: 1, priority: 1 },
+    ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
+    ])
+    expect(priorityQueue.tail.next).not.toStrictEqual(priorityQueue.head)
+    expect(priorityQueue.tail.next.nodeArray).toMatchObject([
       { data: 3, priority: -1 },
       { data: 3, priority: 0 },
-      { data: 1, priority: 1 }
     ])
     rtSize = priorityQueue.enqueue(3, -2)
+    expect(priorityQueue.buckets).toBe(3)
     expect(priorityQueue.size).toBe(6)
     expect(priorityQueue.maxSize).toBe(6)
     expect(rtSize).toBe(priorityQueue.size)
-    expect(priorityQueue.nodeArray).toStrictEqual([
+    expect(priorityQueue.head.nodeArray).toMatchObject([
+      { data: 3, priority: -2 },
+      { data: 1, priority: 1 },
+    ])
+    expect(priorityQueue.head.next).toBe(undefined)
+    expect(priorityQueue.tail.nodeArray).toMatchObject([
       { data: 1, priority: 0 },
       { data: 2, priority: 0 },
+    ])
+    expect(priorityQueue.tail.next).not.toStrictEqual(priorityQueue.head)
+    expect(priorityQueue.tail.next.nodeArray).toMatchObject([
       { data: 3, priority: -1 },
       { data: 3, priority: 0 },
-      { data: 3, priority: -2 },
-      { data: 1, priority: 1 }
     ])
   })
 
-  it('Verify default k dequeue() behavior', () => {
-    const priorityQueue = new PriorityQueue()
+  it('Verify default bucket size dequeue() behavior', () => {
+    const priorityQueue = new PriorityQueue(defaultBucketSize, true)
     priorityQueue.enqueue(1)
     priorityQueue.enqueue(2, -1)
     priorityQueue.enqueue(3)
+    expect(priorityQueue.buckets).toBe(0)
+    expect(priorityQueue.size).toBe(3)
+    expect(priorityQueue.maxSize).toBe(3)
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBe(undefined)
     let rtItem = priorityQueue.dequeue()
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(2)
     expect(priorityQueue.maxSize).toBe(3)
     expect(rtItem).toBe(2)
-    expect(priorityQueue.nodeArray).toStrictEqual([
-      { data: 1, priority: 0 },
-      { data: 3, priority: 0 }
-    ])
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBe(undefined)
     rtItem = priorityQueue.dequeue()
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(1)
     expect(priorityQueue.maxSize).toBe(3)
     expect(rtItem).toBe(1)
-    expect(priorityQueue.nodeArray).toStrictEqual([{ data: 3, priority: 0 }])
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBe(undefined)
     rtItem = priorityQueue.dequeue()
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(0)
     expect(priorityQueue.maxSize).toBe(3)
     expect(rtItem).toBe(3)
-    expect(priorityQueue.nodeArray).toStrictEqual([])
+    expect(priorityQueue.tail.empty()).toBe(true)
+    expect(priorityQueue.tail.next).toBe(undefined)
   })
 
-  it('Verify k=2 dequeue() behavior', () => {
-    const priorityQueue = new PriorityQueue(2)
+  it('Verify bucketSize=2 dequeue() behavior', () => {
+    const priorityQueue = new PriorityQueue(2, true)
     priorityQueue.enqueue(1)
     priorityQueue.enqueue(2)
     priorityQueue.enqueue(3)
     priorityQueue.enqueue(3, -1)
     priorityQueue.enqueue(1, 1)
     priorityQueue.enqueue(3, -2)
+    expect(priorityQueue.buckets).toBe(3)
+    expect(priorityQueue.size).toBe(6)
+    expect(priorityQueue.maxSize).toBe(6)
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
     let rtItem = priorityQueue.dequeue(3)
+    expect(priorityQueue.buckets).toBe(2)
     expect(priorityQueue.size).toBe(5)
     expect(priorityQueue.maxSize).toBe(6)
     expect(rtItem).toBe(3)
-    expect(priorityQueue.nodeArray).toStrictEqual([
-      { data: 1, priority: 0 },
-      { data: 2, priority: 0 },
-      { data: 3, priority: -1 },
-      { data: 3, priority: 0 },
-      { data: 1, priority: 1 }
-    ])
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
     rtItem = priorityQueue.dequeue()
+    expect(priorityQueue.buckets).toBe(2)
     expect(priorityQueue.size).toBe(4)
     expect(priorityQueue.maxSize).toBe(6)
     expect(rtItem).toBe(1)
-    expect(priorityQueue.nodeArray).toStrictEqual([
-      { data: 2, priority: 0 },
-      { data: 3, priority: -1 },
-      { data: 3, priority: 0 },
-      { data: 1, priority: 1 }
-    ])
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
     rtItem = priorityQueue.dequeue(2)
+    expect(priorityQueue.buckets).toBe(1)
     expect(priorityQueue.size).toBe(3)
     expect(priorityQueue.maxSize).toBe(6)
     expect(rtItem).toBe(3)
-    expect(priorityQueue.nodeArray).toStrictEqual([
-      { data: 2, priority: 0 },
-      { data: 3, priority: -1 },
-      { data: 1, priority: 1 }
-    ])
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
     rtItem = priorityQueue.dequeue(2)
+    expect(priorityQueue.buckets).toBe(1)
     expect(priorityQueue.size).toBe(2)
     expect(priorityQueue.maxSize).toBe(6)
-    expect(rtItem).toBe(1)
-    expect(priorityQueue.nodeArray).toStrictEqual([
-      { data: 2, priority: 0 },
-      { data: 3, priority: -1 }
-    ])
+    expect(rtItem).toBe(3)
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
     rtItem = priorityQueue.dequeue(2)
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(1)
     expect(priorityQueue.maxSize).toBe(6)
-    expect(rtItem).toBe(2)
-    expect(priorityQueue.nodeArray).toStrictEqual([{ data: 3, priority: -1 }])
+    expect(rtItem).toBe(1)
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
     rtItem = priorityQueue.dequeue()
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(0)
     expect(priorityQueue.maxSize).toBe(6)
-    expect(rtItem).toBe(3)
-    expect(priorityQueue.nodeArray).toStrictEqual([])
-  })
-
-  it('Verify peekFirst() behavior', () => {
-    const priorityQueue = new PriorityQueue()
-    priorityQueue.enqueue(1)
-    priorityQueue.enqueue(2)
-    priorityQueue.enqueue(3)
-    expect(priorityQueue.size).toBe(3)
-    expect(priorityQueue.peekFirst()).toBe(1)
-    expect(priorityQueue.size).toBe(3)
+    expect(rtItem).toBe(2)
+    expect(priorityQueue.tail.empty()).toBe(true)
+    expect(priorityQueue.tail.next).toBe(undefined)
   })
 
-  it('Verify peekLast() behavior', () => {
-    const priorityQueue = new PriorityQueue()
+  it('Verify enablePriority setter behavior', () => {
+    const priorityQueue = new PriorityQueue(2)
+    expect(priorityQueue.enablePriority).toBe(false)
     priorityQueue.enqueue(1)
     priorityQueue.enqueue(2)
     priorityQueue.enqueue(3)
-    expect(priorityQueue.size).toBe(3)
-    expect(priorityQueue.peekLast()).toBe(3)
-    expect(priorityQueue.size).toBe(3)
+    priorityQueue.enqueue(4)
+    let buckets = 0
+    let node = priorityQueue.tail
+    while (node != null) {
+      expect(node.enablePriority).toBe(false)
+      node = node.next
+      ++buckets
+    }
+    expect(buckets).toBe(2)
+    priorityQueue.enablePriority = true
+    expect(priorityQueue.enablePriority).toBe(true)
+    node = priorityQueue.tail
+    while (node != null) {
+      expect(node.enablePriority).toBe(true)
+      node = node.next
+    }
   })
 
   it('Verify iterator behavior', () => {
-    const priorityQueue = new PriorityQueue()
+    const priorityQueue = new PriorityQueue(2)
     priorityQueue.enqueue(1)
     priorityQueue.enqueue(2)
     priorityQueue.enqueue(3)
@@ -247,20 +318,21 @@ describe('Priority queue test suite', () => {
   })
 
   it('Verify clear() behavior', () => {
-    const priorityQueue = new PriorityQueue()
+    const priorityQueue = new PriorityQueue(2)
     priorityQueue.enqueue(1)
     priorityQueue.enqueue(2)
     priorityQueue.enqueue(3)
+    expect(priorityQueue.buckets).toBe(1)
     expect(priorityQueue.size).toBe(3)
     expect(priorityQueue.maxSize).toBe(3)
-    expect(priorityQueue.nodeArray).toStrictEqual([
-      { data: 1, priority: 0 },
-      { data: 2, priority: 0 },
-      { data: 3, priority: 0 }
-    ])
+    expect(priorityQueue.head.empty()).toBe(false)
+    expect(priorityQueue.tail.empty()).toBe(false)
+    expect(priorityQueue.tail).not.toStrictEqual(priorityQueue.head)
     priorityQueue.clear()
+    expect(priorityQueue.buckets).toBe(0)
     expect(priorityQueue.size).toBe(0)
     expect(priorityQueue.maxSize).toBe(0)
-    expect(priorityQueue.nodeArray).toStrictEqual([])
+    expect(priorityQueue.head.empty()).toBe(true)
+    expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
   })
 })