data-structure-typed 2.6.0 → 2.6.2

package/dist/types/data-structures/matrix/matrix.d.ts

@@ -134,6 +134,35 @@ export declare class Matrix {
      * @returns The `_multiplyFn` property is being returned.
      */
     get multiplyFn(): (a: number, b: number) => number;
+    /**
+     * Returns [rows, cols] dimensions tuple.
+     */
+    get size(): [number, number];
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
     /**
      * The `get` function returns the value at the specified row and column index if it is a valid index.
      * @param {number} row - The `row` parameter represents the row index of the element you want to
@@ -142,64 +171,22 @@ export declare 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;
+     * @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;
     /**
@@ -213,55 +200,13 @@ export declare 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;
+     * @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;
     /**
@@ -276,70 +221,28 @@ export declare 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]
-   *  //    ];
+     * @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;
     /**
@@ -348,54 +251,21 @@ export declare 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]];
+     * @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;
     /**
@@ -403,249 +273,93 @@ export declare 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]
-   *  //    ];
+     * @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;
     /**
      * 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;
+     * @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;
     /**
      * 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;
+     * @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;
     /**
      * 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]];
+     * @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;
     /**
@@ -664,10 +378,6 @@ export declare class Matrix {
      * and properties as the current instance.
      */
     clone(): Matrix;
-    /**
-     * Returns [rows, cols] dimensions tuple.
-     */
-    get size(): [number, number];
     isEmpty(): boolean;
     /**
      * Returns a deep copy of the data as a plain 2D array.
@@ -690,31 +400,6 @@ export declare class Matrix {
      */
     map(callback: (value: number, row: number, col: number) => number): Matrix;
     print(): void;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
     protected _addFn(a: number | undefined, b: number): number | undefined;
     protected _subtractFn(a: number, b: number): number;
     protected _multiplyFn(a: number, b: number): number;

package/dist/types/data-structures/priority-queue/max-priority-queue.d.ts

@@ -65,12 +65,7 @@ import { PriorityQueue } from './priority-queue';
  *     while (cpuQueue.size > 0) {
  *       order.push(cpuQueue.poll()![1]);
  *     }
- *     console.log(order); // [
- *  //      'User interaction',
- *  //      'System process',
- *  //      'Network sync',
- *  //      'Background task'
- *  //    ];
+ *     console.log(order); // ['User interaction', 'System process', 'Network sync', 'Background task'];
  */
 export declare class MaxPriorityQueue<E = any, R = any> extends PriorityQueue<E, R> {
     /**