max-priority-queue-typed 2.4.4 → 2.5.0

package/src/data-structures/matrix/matrix.ts

@@ -6,10 +6,94 @@
  * @license MIT License
  */
 import type { MatrixOptions } from '../../types';
+import { ERR } from '../../common';
 
 /**
  *
  */
+/**
+ * Matrix — a numeric matrix with standard linear algebra operations.
+ *
+ * @example
+ * // Basic matrix arithmetic
+ *  const a = new Matrix([
+ *       [1, 2],
+ *       [3, 4]
+ *     ]);
+ *     const b = new Matrix([
+ *       [5, 6],
+ *       [7, 8]
+ *     ]);
+ *
+ *     const sum = a.add(b);
+ *     console.log(sum?.data); // [
+ *  //      [6, 8],
+ *  //      [10, 12]
+ *  //    ];
+ *
+ *     const diff = b.subtract(a);
+ *     console.log(diff?.data); // [
+ *  //      [4, 4],
+ *  //      [4, 4]
+ *  //    ];
+ * @example
+ * // Matrix multiplication for transformations
+ *  // 2x3 matrix * 3x2 matrix = 2x2 matrix
+ *     const a = new Matrix([
+ *       [1, 2, 3],
+ *       [4, 5, 6]
+ *     ]);
+ *     const b = new Matrix([
+ *       [7, 8],
+ *       [9, 10],
+ *       [11, 12]
+ *     ]);
+ *
+ *     const product = a.multiply(b);
+ *     console.log(product?.rows); // 2;
+ *     console.log(product?.cols); // 2;
+ *     // Row 0: 1*7+2*9+3*11=58, 1*8+2*10+3*12=64
+ *     // Row 1: 4*7+5*9+6*11=139, 4*8+5*10+6*12=154
+ *     console.log(product?.data); // [
+ *  //      [58, 64],
+ *  //      [139, 154]
+ *  //    ];
+ * @example
+ * // Matrix transpose (square matrix)
+ *  const m = new Matrix([
+ *       [1, 2, 3],
+ *       [4, 5, 6],
+ *       [7, 8, 9]
+ *     ]);
+ *
+ *     const transposed = m.transpose();
+ *     console.log(transposed.rows); // 3;
+ *     console.log(transposed.cols); // 3;
+ *     console.log(transposed.data); // [
+ *  //      [1, 4, 7],
+ *  //      [2, 5, 8],
+ *  //      [3, 6, 9]
+ *  //    ];
+ *
+ *     // Transpose of transpose = original
+ *     console.log(transposed.transpose().data); // m.data;
+ * @example
+ * // Get and set individual cells
+ *  const m = new Matrix([
+ *       [0, 0, 0],
+ *       [0, 0, 0]
+ *     ]);
+ *
+ *     m.set(0, 1, 42);
+ *     m.set(1, 2, 99);
+ *
+ *     console.log(m.get(0, 1)); // 42;
+ *     console.log(m.get(1, 2)); // 99;
+ *     console.log(m.get(0, 0)); // 0;
+ *
+ *     // Out of bounds returns undefined
+ *     console.log(m.get(5, 5)); // undefined;
+ */
 export class Matrix {
   /**
    * The constructor function initializes a matrix object with the provided data and options, or with
@@ -105,6 +189,33 @@ export class Matrix {
    * retrieve from the data array.
    * @returns The `get` function returns a number if the provided row and column indices are valid.
    * Otherwise, it returns `undefined`.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Get and set individual cells
+ *  const m = new Matrix([
+ *       [0, 0, 0],
+ *       [0, 0, 0]
+ *     ]);
+ *
+ *     m.set(0, 1, 42);
+ *     m.set(1, 2, 99);
+ *
+ *     console.log(m.get(0, 1)); // 42;
+ *     console.log(m.get(1, 2)); // 99;
+ *     console.log(m.get(0, 0)); // 0;
+ *
+ *     // Out of bounds returns undefined
+ *     console.log(m.get(5, 5)); // undefined;
    */
   get(row: number, col: number): number | undefined {
     if (this.isValidIndex(row, col)) {
@@ -123,6 +234,24 @@ export class Matrix {
    * @returns a boolean value. It returns true if the index (row, col) is valid and the value is
    * successfully set in the data array. It returns false if the index is invalid and the value is not
    * set.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Modify individual cells
+ *  const m = Matrix.zeros(2, 2);
+ *     console.log(m.set(0, 0, 5)); // true;
+ *     console.log(m.set(1, 1, 10)); // true;
+ *     console.log(m.get(0, 0)); // 5;
+ *     console.log(m.get(1, 1)); // 10;
    */
   set(row: number, col: number, value: number): boolean {
     if (this.isValidIndex(row, col)) {
@@ -147,10 +276,43 @@ export class Matrix {
    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
    * @returns The `add` method returns a new `Matrix` object that represents the result of adding the
    * current matrix with the provided `matrix` parameter.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Basic matrix arithmetic
+ *  const a = new Matrix([
+ *       [1, 2],
+ *       [3, 4]
+ *     ]);
+ *     const b = new Matrix([
+ *       [5, 6],
+ *       [7, 8]
+ *     ]);
+ *
+ *     const sum = a.add(b);
+ *     console.log(sum?.data); // [
+ *  //      [6, 8],
+ *  //      [10, 12]
+ *  //    ];
+ *
+ *     const diff = b.subtract(a);
+ *     console.log(diff?.data); // [
+ *  //      [4, 4],
+ *  //      [4, 4]
+ *  //    ];
    */
   add(matrix: Matrix): Matrix | undefined {
     if (!this.isMatchForCalculate(matrix)) {
-      throw new Error('Matrix dimensions must match for addition.');
+      throw new Error(ERR.matrixDimensionMismatch('addition'));
     }
 
     const resultData: number[][] = [];
@@ -160,10 +322,7 @@ export class Matrix {
         const a = this.get(i, j),
           b = matrix.get(i, j);
         if (a !== undefined && b !== undefined) {
-          const added = this._addFn(a, b);
-          if (added) {
-            resultData[i][j] = added;
-          }
+          resultData[i][j] = this._addFn(a, b) ?? 0;
         }
       }
     }
@@ -183,10 +342,27 @@ export class Matrix {
    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class. It
    * represents the matrix that you want to subtract from the current matrix.
    * @returns a new Matrix object with the result of the subtraction operation.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Element-wise subtraction
+ *  const a = Matrix.from([[5, 6], [7, 8]]);
+ *     const b = Matrix.from([[1, 2], [3, 4]]);
+ *     const result = a.subtract(b);
+ *     console.log(result?.toArray()); // [[4, 4], [4, 4]];
    */
   subtract(matrix: Matrix): Matrix | undefined {
     if (!this.isMatchForCalculate(matrix)) {
-      throw new Error('Matrix dimensions must match for subtraction.');
+      throw new Error(ERR.matrixDimensionMismatch('subtraction'));
     }
 
     const resultData: number[][] = [];
@@ -196,10 +372,7 @@ export class Matrix {
         const a = this.get(i, j),
           b = matrix.get(i, j);
         if (a !== undefined && b !== undefined) {
-          const subtracted = this._subtractFn(a, b);
-          if (subtracted) {
-            resultData[i][j] = subtracted;
-          }
+          resultData[i][j] = this._subtractFn(a, b) ?? 0;
         }
       }
     }
@@ -218,10 +391,43 @@ export class Matrix {
    * as a new matrix.
    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
    * @returns a new Matrix object.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Matrix multiplication for transformations
+ *  // 2x3 matrix * 3x2 matrix = 2x2 matrix
+ *     const a = new Matrix([
+ *       [1, 2, 3],
+ *       [4, 5, 6]
+ *     ]);
+ *     const b = new Matrix([
+ *       [7, 8],
+ *       [9, 10],
+ *       [11, 12]
+ *     ]);
+ *
+ *     const product = a.multiply(b);
+ *     console.log(product?.rows); // 2;
+ *     console.log(product?.cols); // 2;
+ *     // Row 0: 1*7+2*9+3*11=58, 1*8+2*10+3*12=64
+ *     // Row 1: 4*7+5*9+6*11=139, 4*8+5*10+6*12=154
+ *     console.log(product?.data); // [
+ *  //      [58, 64],
+ *  //      [139, 154]
+ *  //    ];
    */
   multiply(matrix: Matrix): Matrix | undefined {
     if (this.cols !== matrix.rows) {
-      throw new Error('Matrix dimensions must be compatible for multiplication (A.cols = B.rows).');
+      throw new Error(ERR.matrixDimensionMismatch('multiplication (A.cols must equal B.rows)'));
     }
 
     const resultData: number[][] = [];
@@ -256,10 +462,40 @@ export class Matrix {
    * The transpose function takes a matrix and returns a new matrix that is the transpose of the
    * original matrix.
    * @returns The transpose() function returns a new Matrix object with the transposed data.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Matrix transpose (square matrix)
+ *  const m = new Matrix([
+ *       [1, 2, 3],
+ *       [4, 5, 6],
+ *       [7, 8, 9]
+ *     ]);
+ *
+ *     const transposed = m.transpose();
+ *     console.log(transposed.rows); // 3;
+ *     console.log(transposed.cols); // 3;
+ *     console.log(transposed.data); // [
+ *  //      [1, 4, 7],
+ *  //      [2, 5, 8],
+ *  //      [3, 6, 9]
+ *  //    ];
+ *
+ *     // Transpose of transpose = original
+ *     console.log(transposed.transpose().data); // m.data;
    */
   transpose(): Matrix {
-    if (this.data.some(row => row.length !== this.rows)) {
-      throw new Error('Matrix must be rectangular for transposition.');
+    if (this.data.some(row => row.length !== this.cols)) {
+      throw new Error(ERR.matrixNotRectangular());
     }
 
     const resultData: number[][] = [];
@@ -284,11 +520,33 @@ export class Matrix {
   /**
    * The `inverse` function calculates the inverse of a square matrix using Gaussian elimination.
    * @returns a Matrix object, which represents the inverse of the original matrix.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Compute the inverse of a 2x2 matrix
+ *  const m = Matrix.from([[4, 7], [2, 6]]);
+ *     const inv = m.inverse();
+ *     console.log(inv); // defined;
+ *     // A * A^-1 should ≈ Identity
+ *     const product = m.multiply(inv!);
+ *     console.log(product?.get(0, 0)); // toBeCloseTo;
+ *     console.log(product?.get(0, 1)); // toBeCloseTo;
+ *     console.log(product?.get(1, 0)); // toBeCloseTo;
+ *     console.log(product?.get(1, 1)); // toBeCloseTo;
    */
   inverse(): Matrix | undefined {
     // Check if the matrix is square
     if (this.rows !== this.cols) {
-      throw new Error('Matrix must be square for inversion.');
+      throw new Error(ERR.matrixNotSquare());
     }
 
     // Create an augmented matrix [this | I]
@@ -318,7 +576,7 @@ export class Matrix {
 
       if (pivotRow === this.rows) {
         // Matrix is singular, and its inverse does not exist
-        throw new Error('Matrix is singular, and its inverse does not exist.');
+        throw new Error(ERR.matrixSingular());
       }
 
       // Swap rows to make the pivot the current row
@@ -329,7 +587,7 @@ export class Matrix {
 
       if (pivotElement === 0) {
         // Handle division by zero
-        throw new Error('Matrix is singular, and its inverse does not exist (division by zero).');
+        throw new Error(ERR.matrixSingular());
       }
 
       augmentedMatrix._scaleRow(i, 1 / pivotElement);
@@ -364,12 +622,27 @@ export class Matrix {
    * The dot function calculates the dot product of two matrices and returns a new matrix.
    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
    * @returns a new Matrix object.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Dot product of two matrices
+ *  const a = Matrix.from([[1, 2], [3, 4]]);
+ *     const b = Matrix.from([[5, 6], [7, 8]]);
+ *     const result = a.dot(b);
+ *     console.log(result?.toArray()); // [[19, 22], [43, 50]];
    */
   dot(matrix: Matrix): Matrix | undefined {
     if (this.cols !== matrix.rows) {
-      throw new Error(
-        'Number of columns in the first matrix must be equal to the number of rows in the second matrix for dot product.'
-      );
+      throw new Error(ERR.matrixDimensionMismatch('dot product (A.cols must equal B.rows)'));
     }
 
     const resultData: number[][] = [];
@@ -419,15 +692,145 @@ export class Matrix {
    * and properties as the current instance.
    */
   clone(): Matrix {
-    return new Matrix(this.data, {
-      rows: this.rows,
-      cols: this.cols,
+    return new Matrix(
+      this._data.map(row => [...row]),
+      {
+        rows: this.rows,
+        cols: this.cols,
+        addFn: this.addFn,
+        subtractFn: this.subtractFn,
+        multiplyFn: this.multiplyFn
+      }
+    );
+  }
+
+  // ─── Standard interface ─────────────────────────────────────
+
+  /**
+   * Returns [rows, cols] dimensions tuple.
+   */
+  get size(): [number, number] {
+    return [this._rows, this._cols];
+  }
+
+  isEmpty(): boolean {
+    return this._rows === 0 || this._cols === 0;
+  }
+
+  /**
+   * Returns a deep copy of the data as a plain 2D array.
+   */
+  toArray(): number[][] {
+    return this._data.map(row => [...row]);
+  }
+
+  /**
+   * Returns a flat row-major array.
+   */
+  flatten(): number[] {
+    const result: number[] = [];
+    for (const row of this._data) {
+      for (const v of row) result.push(v);
+    }
+    return result;
+  }
+
+  /**
+   * Iterates over rows.
+   */
+  [Symbol.iterator](): IterableIterator<number[]> {
+    const data = this._data;
+    let i = 0;
+    return {
+      [Symbol.iterator]() {
+        return this;
+      },
+      next(): IteratorResult<number[]> {
+        if (i < data.length) {
+          return { value: [...data[i++]], done: false };
+        }
+        return { value: undefined as any, done: true };
+      }
+    };
+  }
+
+  /**
+   * Visits each element with its row and column index.
+   */
+  forEach(callback: (value: number, row: number, col: number) => void): void {
+    for (let i = 0; i < this._rows; i++) {
+      for (let j = 0; j < this._cols; j++) {
+        callback(this._data[i][j], i, j);
+      }
+    }
+  }
+
+  /**
+   * Maps each element (number → number) and returns a new Matrix.
+   */
+  map(callback: (value: number, row: number, col: number) => number): Matrix {
+    const resultData: number[][] = [];
+    for (let i = 0; i < this._rows; i++) {
+      resultData[i] = [];
+      for (let j = 0; j < this._cols; j++) {
+        resultData[i][j] = callback(this._data[i][j], i, j);
+      }
+    }
+    return new Matrix(resultData, {
+      rows: this._rows,
+      cols: this._cols,
       addFn: this.addFn,
       subtractFn: this.subtractFn,
       multiplyFn: this.multiplyFn
     });
   }
 
+  print(): void {
+    for (const row of this._data) {
+      console.log(row.join('\t'));
+    }
+  }
+
+  // ─── Factory methods ────────────────────────────────────────
+
+  /**
+   * Creates a rows×cols zero matrix.
+   * @example
+   * ```ts
+   * const z = Matrix.zeros(2, 3); // [[0,0,0],[0,0,0]]
+   * ```
+   */
+  static zeros(rows: number, cols: number): Matrix {
+    const data: number[][] = Array.from({ length: rows }, () => new Array(cols).fill(0));
+    return new Matrix(data);
+  }
+
+  /**
+   * Creates an n×n identity matrix.
+   * @example
+   * ```ts
+   * const I = Matrix.identity(3); // [[1,0,0],[0,1,0],[0,0,1]]
+   * ```
+   */
+  static identity(n: number): Matrix {
+    const data: number[][] = Array.from({ length: n }, (_, i) =>
+      Array.from({ length: n }, (_, j) => (i === j ? 1 : 0))
+    );
+    return new Matrix(data);
+  }
+
+  /**
+   * Creates a Matrix from a plain 2D array (deep copy).
+   * @example
+   * ```ts
+   * const m = Matrix.from([[1, 2], [3, 4]]);
+   * m.get(0, 1); // 2
+   * ```
+   */
+  static from(data: number[][]): Matrix {
+    return new Matrix(data.map(row => [...row]));
+  }
+
   protected _addFn(a: number | undefined, b: number): number | undefined {
     if (a === undefined) return b;
     return a + b;

package/src/data-structures/priority-queue/max-priority-queue.ts

@@ -7,6 +7,7 @@
  */
 import type { PriorityQueueOptions } from '../../types';
 import { PriorityQueue } from './priority-queue';
+import { ERR } from '../../common';
 
 /**
  * Max-oriented priority queue (max-heap) built on {@link PriorityQueue}.
@@ -15,6 +16,63 @@ import { PriorityQueue } from './priority-queue';
  * @template E Element type stored in the queue.
  * @template R Extra record/metadata associated with each element.
  * @example
+ * // Job scheduling by priority
+ *  const jobs = new MaxPriorityQueue<number>();
+ *
+ *     jobs.add(3); // low priority
+ *     jobs.add(7); // high priority
+ *     jobs.add(5); // medium priority
+ *     jobs.add(10); // critical
+ *
+ *     // Highest priority job first
+ *     console.log(jobs.poll()); // 10;
+ *     console.log(jobs.poll()); // 7;
+ *     console.log(jobs.poll()); // 5;
+ *     console.log(jobs.poll()); // 3;
+ * @example
+ * // Auction system with highest bid tracking
+ *  interface Bid {
+ *       bidder: string;
+ *       amount: number;
+ *     }
+ *
+ *     const auction = new MaxPriorityQueue<Bid>([], {
+ *       comparator: (a, b) => b.amount - a.amount
+ *     });
+ *
+ *     auction.add({ bidder: 'Alice', amount: 100 });
+ *     auction.add({ bidder: 'Bob', amount: 250 });
+ *     auction.add({ bidder: 'Charlie', amount: 175 });
+ *
+ *     // Current highest bid
+ *     console.log(auction.peek()?.bidder); // 'Bob';
+ *     console.log(auction.peek()?.amount); // 250;
+ *
+ *     // Process winning bid
+ *     const winner = auction.poll()!;
+ *     console.log(winner.bidder); // 'Bob';
+ *     console.log(auction.peek()?.bidder); // 'Charlie';
+ * @example
+ * // CPU process scheduling
+ *  const cpuQueue = new MaxPriorityQueue<[number, string]>([], {
+ *       comparator: (a, b) => b[0] - a[0]
+ *     });
+ *
+ *     cpuQueue.add([5, 'System process']);
+ *     cpuQueue.add([1, 'Background task']);
+ *     cpuQueue.add([8, 'User interaction']);
+ *     cpuQueue.add([3, 'Network sync']);
+ *
+ *     const order = [];
+ *     while (cpuQueue.size > 0) {
+ *       order.push(cpuQueue.poll()![1]);
+ *     }
+ *     console.log(order); // [
+ *  //      'User interaction',
+ *  //      'System process',
+ *  //      'Network sync',
+ *  //      'Background task'
+ *  //    ];
  */
 export class MaxPriorityQueue<E = any, R = any> extends PriorityQueue<E, R> {
   /**
@@ -28,9 +86,7 @@ export class MaxPriorityQueue<E = any, R = any> extends PriorityQueue<E, R> {
     super(elements, {
       comparator: (a: E, b: E): number => {
         if (typeof a === 'object' || typeof b === 'object') {
-          throw TypeError(
-            `When comparing object types, a custom comparator must be defined in the constructor's options parameter.`
-          );
+          throw new TypeError(ERR.comparatorRequired('MaxPriorityQueue'));
         }
         if (a < b) return 1;
         if (a > b) return -1;

package/src/data-structures/priority-queue/min-priority-queue.ts

@@ -15,6 +15,66 @@ import { PriorityQueue } from './priority-queue';
  * @template E Element type stored in the queue.
  * @template R Extra record/metadata associated with each element.
  * @example
+ * // Shortest job first scheduling
+ *  const jobs = new MinPriorityQueue<number>();
+ *
+ *     jobs.add(8);  // 8 seconds
+ *     jobs.add(2);  // 2 seconds
+ *     jobs.add(5);  // 5 seconds
+ *     jobs.add(1);  // 1 second
+ *
+ *     // Shortest job first
+ *     console.log(jobs.poll()); // 1;
+ *     console.log(jobs.poll()); // 2;
+ *     console.log(jobs.poll()); // 5;
+ *     console.log(jobs.poll()); // 8;
+ * @example
+ * // Event-driven simulation with timestamps
+ *  interface Event {
+ *       time: number;
+ *       action: string;
+ *     }
+ *
+ *     const timeline = new MinPriorityQueue<Event>([], {
+ *       comparator: (a, b) => a.time - b.time
+ *     });
+ *
+ *     timeline.add({ time: 300, action: 'Timeout' });
+ *     timeline.add({ time: 100, action: 'Request received' });
+ *     timeline.add({ time: 200, action: 'Processing done' });
+ *     timeline.add({ time: 150, action: 'Cache hit' });
+ *
+ *     const order = [];
+ *     while (timeline.size > 0) {
+ *       order.push(timeline.poll()!.action);
+ *     }
+ *     console.log(order); // [
+ *  //      'Request received',
+ *  //      'Cache hit',
+ *  //      'Processing done',
+ *  //      'Timeout'
+ *  //    ];
+ * @example
+ * // Huffman coding frequency selection
+ *  // Character frequencies for Huffman tree building
+ *     const freq = new MinPriorityQueue<[number, string]>([], {
+ *       comparator: (a, b) => a[0] - b[0]
+ *     });
+ *
+ *     freq.add([5, 'a']);
+ *     freq.add([9, 'b']);
+ *     freq.add([12, 'c']);
+ *     freq.add([2, 'd']);
+ *
+ *     // Always pick two lowest frequencies
+ *     const first = freq.poll()!;
+ *     const second = freq.poll()!;
+ *     console.log(first[1]); // 'd';  // freq 2
+ *     console.log(second[1]); // 'a'; // freq 5
+ *
+ *     // Combined node goes back
+ *     freq.add([first[0] + second[0], first[1] + second[1]]);
+ *     console.log(freq.peek()![0]); // 7;
  */
 export class MinPriorityQueue<E = any, R = any> extends PriorityQueue<E, R> {
   /**