Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
+ /**
+ * Checks if the fixed priority queue is empty.
+ *
+ * @returns `true` if the fixed priority queue is empty, `false` otherwise.
+ */
public empty (): boolean {
return this.size === 0
}
public empty (): boolean {
return this.size === 0
}
+ /**
+ * Checks if the fixed priority queue is full.
+ *
+ * @returns `true` if the fixed priority queue is full, `false` otherwise.
+ */
public full (): boolean {
return this.size === this.capacity
}
public full (): boolean {
return this.size === this.capacity
}
+ /**
+ * Enqueue data into the fixed priority queue.
+ *
+ * @param data - Data to enqueue.
+ * @param priority - Priority of the data. Lower values have higher priority.
+ * @returns The new size of the priority queue.
+ */
public enqueue (data: T, priority?: number): number {
if (this.full()) {
throw new Error('Priority queue is full')
public enqueue (data: T, priority?: number): number {
if (this.full()) {
throw new Error('Priority queue is full')
return this.incrementSize()
}
return this.incrementSize()
}
+ /**
+ * Dequeue data from the fixed priority queue.
+ *
+ * @returns The dequeued data or `undefined` if the priority queue is empty.
+ */
public dequeue (): T | undefined {
if (this.empty()) {
return undefined
public dequeue (): T | undefined {
if (this.empty()) {
return undefined
+ /**
+ * Checks the size.
+ *
+ * @param size - The size to check.
+ */
private checkSize (size: number): void {
if (!Number.isSafeInteger(size)) {
throw new TypeError(
private checkSize (size: number): void {
if (!Number.isSafeInteger(size)) {
throw new TypeError(
/** @inheritdoc */
public dequeueLastPrioritizedTask (): Task<Data> | undefined {
// Start from the last empty or partially filled bucket
/** @inheritdoc */
public dequeueLastPrioritizedTask (): Task<Data> | undefined {
// Start from the last empty or partially filled bucket
- return this.dequeueTask()
+ return this.dequeueTask(this.tasksQueue.buckets + 1)
* @returns PriorityQueue.
*/
public constructor (bucketSize: number = defaultBucketSize) {
* @returns PriorityQueue.
*/
public constructor (bucketSize: number = defaultBucketSize) {
+ if (!Number.isSafeInteger(bucketSize)) {
+ throw new TypeError('bucketSize must be an integer')
+ }
+ if (bucketSize < 1) {
+ throw new RangeError('bucketSize must be greater than or equal to 1')
+ }
this.bucketSize = bucketSize
this.clear()
}
this.bucketSize = bucketSize
this.clear()
}
- /** The size of the priority queue. */
+ /**
+ * The size of the priority queue.
+ */
public get size (): number {
let node: PriorityQueueNode<T> | undefined = this.tail
let size = 0
public get size (): number {
let node: PriorityQueueNode<T> | undefined = this.tail
let size = 0
+ /**
+ * The number of filled prioritized buckets.
+ */
+ public get buckets (): number {
+ return Math.trunc(this.size / this.bucketSize)
+ }
+
/**
* Enqueue data into the priority queue.
*
/**
* Enqueue data into the priority queue.
*
describe('Priority queue test suite', () => {
it('Verify constructor() behavior', () => {
describe('Priority queue test suite', () => {
it('Verify constructor() behavior', () => {
- const priorityQueue = new PriorityQueue()
+ expect(() => new PriorityQueue('')).toThrow(
+ new TypeError('bucketSize must be an integer')
+ )
+ expect(() => new PriorityQueue(-1)).toThrow(
+ new RangeError('bucketSize must be greater than or equal to 1')
+ )
+ expect(() => new PriorityQueue(0)).toThrow(
+ new RangeError('bucketSize must be greater than or equal to 1')
+ )
+ let priorityQueue = new PriorityQueue()
+ expect(priorityQueue.bucketSize).toBe(defaultBucketSize)
+ expect(priorityQueue.buckets).toBe(0)
expect(priorityQueue.size).toBe(0)
expect(priorityQueue.maxSize).toBe(0)
expect(priorityQueue.head).toBeInstanceOf(FixedPriorityQueue)
expect(priorityQueue.size).toBe(0)
expect(priorityQueue.maxSize).toBe(0)
expect(priorityQueue.head).toBeInstanceOf(FixedPriorityQueue)
expect(priorityQueue.head.capacity).toBe(defaultBucketSize)
expect(priorityQueue.tail).toBeInstanceOf(FixedPriorityQueue)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
expect(priorityQueue.head.capacity).toBe(defaultBucketSize)
expect(priorityQueue.tail).toBeInstanceOf(FixedPriorityQueue)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
+ const bucketSize = 2
+ priorityQueue = new PriorityQueue(bucketSize)
+ expect(priorityQueue.bucketSize).toBe(bucketSize)
+ expect(priorityQueue.buckets).toBe(0)
+ expect(priorityQueue.size).toBe(0)
+ expect(priorityQueue.maxSize).toBe(0)
+ 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 bucket size enqueue() behavior', () => {
const priorityQueue = new PriorityQueue()
let rtSize = priorityQueue.enqueue(1)
})
it('Verify default bucket size enqueue() behavior', () => {
const priorityQueue = new PriorityQueue()
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.size).toBe(1)
expect(priorityQueue.maxSize).toBe(1)
expect(rtSize).toBe(priorityQueue.size)
expect(priorityQueue.head.next).toBe(undefined)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(2)
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.size).toBe(2)
expect(priorityQueue.maxSize).toBe(2)
expect(rtSize).toBe(priorityQueue.size)
expect(priorityQueue.head.next).toBe(undefined)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(3)
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.size).toBe(3)
expect(priorityQueue.maxSize).toBe(3)
expect(rtSize).toBe(priorityQueue.size)
expect(priorityQueue.head.next).toBe(undefined)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(3, -1)
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.size).toBe(4)
expect(priorityQueue.maxSize).toBe(4)
expect(rtSize).toBe(priorityQueue.size)
expect(priorityQueue.head.next).toBe(undefined)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(1, 1)
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.size).toBe(5)
expect(priorityQueue.maxSize).toBe(5)
expect(rtSize).toBe(priorityQueue.size)
it('Verify bucketSize=2 enqueue() behavior', () => {
const priorityQueue = new PriorityQueue(2)
let rtSize = priorityQueue.enqueue(1)
it('Verify bucketSize=2 enqueue() behavior', () => {
const priorityQueue = new PriorityQueue(2)
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.size).toBe(1)
expect(priorityQueue.maxSize).toBe(1)
expect(rtSize).toBe(priorityQueue.size)
expect(priorityQueue.head.next).toBe(undefined)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(2)
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.size).toBe(2)
expect(priorityQueue.maxSize).toBe(2)
expect(rtSize).toBe(priorityQueue.size)
expect(priorityQueue.head.next).toBe(undefined)
expect(priorityQueue.tail).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(3)
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.size).toBe(3)
expect(priorityQueue.maxSize).toBe(3)
expect(rtSize).toBe(priorityQueue.size)
])
expect(priorityQueue.tail.next).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(3, -1)
])
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.size).toBe(4)
expect(priorityQueue.maxSize).toBe(4)
expect(rtSize).toBe(priorityQueue.size)
])
expect(priorityQueue.tail.next).toStrictEqual(priorityQueue.head)
rtSize = priorityQueue.enqueue(1, 1)
])
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.size).toBe(5)
expect(priorityQueue.maxSize).toBe(5)
expect(rtSize).toBe(priorityQueue.size)
{ data: 3, priority: 0 }
])
rtSize = priorityQueue.enqueue(3, -2)
{ data: 3, priority: 0 }
])
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.size).toBe(6)
expect(priorityQueue.maxSize).toBe(6)
expect(rtSize).toBe(priorityQueue.size)
priorityQueue.enqueue(1)
priorityQueue.enqueue(2, -1)
priorityQueue.enqueue(3)
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.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.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBe(undefined)
rtItem = priorityQueue.dequeue()
expect(priorityQueue.size).toBe(2)
expect(priorityQueue.maxSize).toBe(3)
expect(rtItem).toBe(2)
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.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBe(undefined)
rtItem = priorityQueue.dequeue()
expect(priorityQueue.size).toBe(1)
expect(priorityQueue.maxSize).toBe(3)
expect(rtItem).toBe(1)
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.size).toBe(0)
expect(priorityQueue.maxSize).toBe(3)
expect(rtItem).toBe(3)
priorityQueue.enqueue(3, -1)
priorityQueue.enqueue(1, 1)
priorityQueue.enqueue(3, -2)
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.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.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
rtItem = priorityQueue.dequeue()
expect(priorityQueue.size).toBe(5)
expect(priorityQueue.maxSize).toBe(6)
expect(rtItem).toBe(3)
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.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
rtItem = priorityQueue.dequeue(2)
expect(priorityQueue.size).toBe(4)
expect(priorityQueue.maxSize).toBe(6)
expect(rtItem).toBe(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.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
rtItem = priorityQueue.dequeue(2)
expect(priorityQueue.size).toBe(3)
expect(priorityQueue.maxSize).toBe(6)
expect(rtItem).toBe(3)
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(3)
expect(priorityQueue.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
rtItem = priorityQueue.dequeue(2)
expect(priorityQueue.size).toBe(2)
expect(priorityQueue.maxSize).toBe(6)
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(1)
expect(priorityQueue.tail.empty()).toBe(false)
expect(priorityQueue.tail.next).toBeInstanceOf(FixedPriorityQueue)
rtItem = priorityQueue.dequeue()
expect(priorityQueue.size).toBe(1)
expect(priorityQueue.maxSize).toBe(6)
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(2)
expect(priorityQueue.size).toBe(0)
expect(priorityQueue.maxSize).toBe(6)
expect(rtItem).toBe(2)
priorityQueue.enqueue(1)
priorityQueue.enqueue(2)
priorityQueue.enqueue(3)
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.head.empty()).toBe(false)
expect(priorityQueue.tail.empty()).toBe(false)
expect(priorityQueue.tail).not.toStrictEqual(priorityQueue.head)
priorityQueue.clear()
expect(priorityQueue.size).toBe(3)
expect(priorityQueue.maxSize).toBe(3)
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.head.empty()).toBe(true)
expect(priorityQueue.size).toBe(0)
expect(priorityQueue.maxSize).toBe(0)
expect(priorityQueue.head.empty()).toBe(true)