Merge pull request #38 from datastructures-js/add_push_pop

add push/pop

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [6.1.0] - 2022-05-30
+### Added
+- push & pop as alias methods for enqueue & dequeue
+
 ## [6.0.0] - 2022-03-19
 ### Changed
 - new version: improved usage and types

README.md

@@ -14,10 +14,10 @@ A heap-based implementation of priority queue in javascript with typescript supp
 * [API](#api)
   * [constructor](#constructor)
   * [fromArray](#fromarray)
-  * [enqueue](#enqueue)
+  * [enqueue (push)](#enqueue-push)
   * [front](#front)
   * [back](#back)
-  * [dequeue](#dequeue)
+  * [dequeue (pop)](#dequeue-pop)
   * [isEmpty](#isEmpty)
   * [size](#size)
   * [toArray](#toarray)
@@ -176,7 +176,7 @@ mpq.dequeue(); // 3
 console.log(numbers); // [ 0, -1, -5, -2 ]
 ```
 
-### enqueue
+### enqueue (push)
 adds a value based on its comparison with other values in the queue in O(log(n)) runtime.
 
 ```js
@@ -192,7 +192,7 @@ const cars = [
 cars.forEach((car) => carsQueue.enqueue(car));
 
 const numbers = [3, -2, 5, 0, -1, -5, 4];
-numbers.forEach((num) => numbersQueue.enqueue(num));
+numbers.forEach((num) => numbersQueue.push(num));
 
 const bids = [
   { id: 1, value: 1000 },
@@ -224,7 +224,7 @@ console.log(numbersQueue.back()); // 5
 console.log(bidsQueue.back()); // { id: 1, value: 1000 }
 ```
 
-### dequeue
+### dequeue (pop)
 removes and returns the element with highest priority in the queue in O(log(n)) runtime.
 
 ```js
@@ -236,9 +236,9 @@ console.log(numbersQueue.dequeue()); // -5
 console.log(numbersQueue.dequeue()); // -2
 console.log(numbersQueue.dequeue()); // -1
 
-console.log(bidsQueue.dequeue()); // { id: 2, value: 20000 }
-console.log(bidsQueue.dequeue()); // { id: 5, value: 12000 }
-console.log(bidsQueue.dequeue()); // { id: 7, value: 8000 }
+console.log(bidsQueue.pop()); // { id: 2, value: 20000 }
+console.log(bidsQueue.pop()); // { id: 5, value: 12000 }
+console.log(bidsQueue.pop()); // { id: 7, value: 8000 }
 ```
 
 ### isEmpty

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datastructures-js/priority-queue",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "A heap-based implementation of priority queue in javascript with typescript support.",
   "main": "index.js",
   "scripts": {

src/maxPriorityQueue.d.ts

@@ -7,7 +7,9 @@ export class MaxPriorityQueue<T> {
   front(): T;
   back(): T;
   enqueue(value: T): MaxPriorityQueue<T>;
+  push(value: T): MaxPriorityQueue<T>;
   dequeue(): T;
+  pop(): T;
   toArray(): T[];
   clear(): void;
   static fromArray<T>(values: T[], getCompareValue?: IGetCompareValue<T>): MaxPriorityQueue<T>;

src/maxPriorityQueue.js

@@ -51,6 +51,16 @@ class MaxPriorityQueue {
     return this._heap.insert(value);
   }
 
+  /**
+   * Adds a value to the queue
+   * @public
+   * @param {number|string|object} value
+   * @returns {MaxPriorityQueue}
+   */
+  push(value) {
+    return this.enqueue(value);
+  }
+
   /**
    * Removes and returns an element with highest priority in the queue
    * @public
@@ -60,6 +70,15 @@ class MaxPriorityQueue {
     return this._heap.extractRoot();
   }
 
+  /**
+   * Removes and returns an element with highest priority in the queue
+   * @public
+   * @returns {number|string|object}
+   */
+  pop() {
+    return this.dequeue();
+  }
+
   /**
    * Returns the number of elements in the queue
    * @public

src/minPriorityQueue.d.ts

@@ -7,7 +7,9 @@ export class MinPriorityQueue<T> {
   front(): T;
   back(): T;
   enqueue(value: T): MinPriorityQueue<T>;
+  push(value: T): MinPriorityQueue<T>;
   dequeue(): T;
+  pop(): T;
   toArray(): T[];
   clear(): void;
   static fromArray<T>(values: T[], getCompareValue?: IGetCompareValue<T>): MinPriorityQueue<T>;

src/minPriorityQueue.js

@@ -50,6 +50,16 @@ class MinPriorityQueue {
     return this._heap.insert(value);
   }
 
+  /**
+   * Adds a value to the queue
+   * @public
+   * @param {number|string|object} value
+   * @returns {MinPriorityQueue}
+   */
+  push(value) {
+    return this.enqueue(value);
+  }
+
   /**
    * Removes and returns an element with highest priority in the queue
    * @public
@@ -59,6 +69,15 @@ class MinPriorityQueue {
     return this._heap.extractRoot();
   }
 
+  /**
+   * Removes and returns an element with highest priority in the queue
+   * @public
+   * @returns {number|string|object}
+   */
+  pop() {
+    return this.dequeue();
+  }
+
   /**
    * Returns the number of elements in the queue
    * @public

src/priorityQueue.d.ts

@@ -7,7 +7,9 @@ export class PriorityQueue<T> {
   front(): T;
   back(): T;
   enqueue(value: T): PriorityQueue<T>;
+  push(value: T): PriorityQueue<T>;
   dequeue(): T;
+  pop(): T;
   toArray(): T[];
   clear(): void;
   static fromArray<T>(values: T[], compare: ICompare<T>): PriorityQueue<T>;

src/priorityQueue.js

@@ -51,6 +51,16 @@ class PriorityQueue {
     return this._heap.insert(value);
   }
 
+  /**
+   * Adds a value to the queue
+   * @public
+   * @param {number|string|object} value
+   * @returns {PriorityQueue}
+   */
+  push(value) {
+    return this.enqueue(value);
+  }
+
   /**
    * Removes and returns an element with highest priority in the queue
    * @public
@@ -60,6 +70,15 @@ class PriorityQueue {
     return this._heap.extractRoot();
   }
 
+  /**
+   * Removes and returns an element with highest priority in the queue
+   * @public
+   * @returns {number|string|object}
+   */
+  pop() {
+    return this.dequeue();
+  }
+
   /**
    * Returns the number of elements in the queue
    * @public

test/PriorityQueue.test.js

@@ -69,8 +69,8 @@ describe('PriorityQueue', () => {
   describe('PriorityQueue with max logic', () => {
     const maxQ = new PriorityQueue(charComparator);
 
-    it('enqueue', () => {
-      charValues.forEach((value) => maxQ.enqueue(value));
+    it('enqueue (push)', () => {
+      charValues.forEach((value) => maxQ.push(value));
     });
 
     it('toArray', () => {
@@ -96,14 +96,14 @@ describe('PriorityQueue', () => {
       expect(maxQ.isEmpty()).to.equal(false);
     });
 
-    it('dequeue', () => {
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'z' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'x' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'm' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'k' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'f' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'c' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'b' });
+    it('dequeue (pop)', () => {
+      expect(maxQ.pop()).to.deep.equal({ id: 'z' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'x' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'm' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'k' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'f' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'c' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'b' });
       expect(maxQ.isEmpty()).to.equal(true);
     });
   });

test/maxPriorityQueue.test.js

@@ -56,8 +56,8 @@ describe('MaxPriorityQueue', () => {
     ];
     const maxQ = new MaxPriorityQueue((value) => value.id);
 
-    it('enqueue', () => {
-      values.forEach((value) => maxQ.enqueue(value));
+    it('enqueue (push)', () => {
+      values.forEach((value) => maxQ.push(value));
     });
 
     it('toArray', () => {
@@ -82,14 +82,14 @@ describe('MaxPriorityQueue', () => {
       expect(maxQ.isEmpty()).to.equal(false);
     });
 
-    it('dequeue', () => {
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'z' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'x' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'm' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'k' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'f' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'c' });
-      expect(maxQ.dequeue()).to.deep.equal({ id: 'b' });
+    it('dequeue (pop)', () => {
+      expect(maxQ.pop()).to.deep.equal({ id: 'z' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'x' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'm' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'k' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'f' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'c' });
+      expect(maxQ.pop()).to.deep.equal({ id: 'b' });
       expect(maxQ.isEmpty()).to.equal(true);
     });
   });

test/minPriorityQueue.test.js

@@ -54,8 +54,8 @@ describe('MinPriorityQueue', () => {
     ];
     const minQ = new MinPriorityQueue((value) => value.id);
 
-    it('enqueue', () => {
-      values.forEach((value) => minQ.enqueue(value));
+    it('enqueue (push)', () => {
+      values.forEach((value) => minQ.push(value));
     });
 
     it('toArray', () => {
@@ -78,14 +78,14 @@ describe('MinPriorityQueue', () => {
       expect(minQ.isEmpty()).to.equal(false);
     });
 
-    it('dequeue', () => {
-      expect(minQ.dequeue()).to.deep.equal({ id: 20 });
-      expect(minQ.dequeue()).to.deep.equal({ id: 30 });
-      expect(minQ.dequeue()).to.deep.equal({ id: 40 });
-      expect(minQ.dequeue()).to.deep.equal({ id: 50 });
-      expect(minQ.dequeue()).to.deep.equal({ id: 60 });
-      expect(minQ.dequeue()).to.deep.equal({ id: 80 });
-      expect(minQ.dequeue()).to.deep.equal({ id: 90 });
+    it('dequeue (pop)', () => {
+      expect(minQ.pop()).to.deep.equal({ id: 20 });
+      expect(minQ.pop()).to.deep.equal({ id: 30 });
+      expect(minQ.pop()).to.deep.equal({ id: 40 });
+      expect(minQ.pop()).to.deep.equal({ id: 50 });
+      expect(minQ.pop()).to.deep.equal({ id: 60 });
+      expect(minQ.pop()).to.deep.equal({ id: 80 });
+      expect(minQ.pop()).to.deep.equal({ id: 90 });
       expect(minQ.isEmpty()).to.equal(true);
     });
   });