data-structure-typed 1.35.0 → 1.40.0-rc

package/dist/data-structures/matrix/vector2d.js

@@ -1,42 +1,130 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Vector2D = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 class Vector2D {
-    constructor(x = 0, y = 0, w = 1) {
+    constructor(x = 0, y = 0, w = 1 // needed for matrix multiplication
+    ) {
         this.x = x;
         this.y = y;
         this.w = w;
     }
+    /**
+     * The function checks if the x and y values of a point are both zero.
+     * @returns A boolean value indicating whether both the x and y properties of the object are equal to 0.
+     */
     get isZero() {
         return this.x === 0 && this.y === 0;
     }
+    /**
+     * The above function calculates the length of a vector using the Pythagorean theorem.
+     * @returns The length of a vector, calculated using the Pythagorean theorem.
+     */
     get length() {
         return Math.sqrt(this.x * this.x + this.y * this.y);
     }
+    /**
+     * The function calculates the square of the length of a vector.
+     * @returns The method is returning the sum of the squares of the x and y values.
+     */
     get lengthSq() {
         return this.x * this.x + this.y * this.y;
     }
+    /**
+     * The "rounded" function returns a new Vector2D object with the x and y values rounded to the nearest whole number.
+     * @returns The method is returning a new instance of the Vector2D class with the x and y values rounded to the nearest
+     * whole number.
+     */
     get rounded() {
         return new Vector2D(Math.round(this.x), Math.round(this.y));
     }
+    /**
+     * The function "add" takes two Vector2D objects as parameters and returns a new Vector2D object with the sum of their
+     * x and y components.
+     * @param {Vector2D} vector1 - The parameter `vector1` is an instance of the `Vector2D` class. It represents a
+     * 2-dimensional vector with an `x` and `y` component.
+     * @param {Vector2D} vector2 - The parameter "vector2" is of type Vector2D. It represents a 2-dimensional vector with
+     * an x and y component.
+     * @returns The method is returning a new instance of the Vector2D class with the x and y components of the two input
+     * vectors added together.
+     */
     static add(vector1, vector2) {
         return new Vector2D(vector1.x + vector2.x, vector1.y + vector2.y);
     }
+    /**
+     * The subtract function takes two Vector2D objects as parameters and returns a new Vector2D object with the x and y
+     * components subtracted.
+     * @param {Vector2D} vector1 - The parameter `vector1` is an instance of the `Vector2D` class, representing a
+     * 2-dimensional vector. It has properties `x` and `y` which represent the x and y components of the vector
+     * respectively.
+     * @param {Vector2D} vector2 - The parameter "vector2" is a Vector2D object. It represents the second vector that you
+     * want to subtract from the first vector.
+     * @returns The method is returning a new Vector2D object with the x and y components subtracted from vector1 and
+     * vector2.
+     */
     static subtract(vector1, vector2) {
         return new Vector2D(vector1.x - vector2.x, vector1.y - vector2.y);
     }
+    /**
+     * The function subtracts a given value from the x and y components of a Vector2D object and returns a new Vector2D
+     * object.
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector with
+     * x and y components.
+     * @param {number} value - The "value" parameter is a number that will be subtracted from both the x and y components
+     * of the "vector" parameter.
+     * @returns A new Vector2D object with the x and y values subtracted by the given value.
+     */
     static subtractValue(vector, value) {
         return new Vector2D(vector.x - value, vector.y - value);
     }
+    /**
+     * The function multiplies a Vector2D object by a given value.
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector with
+     * x and y components.
+     * @param {number} value - The "value" parameter is a number that represents the value by which the x and y components
+     * of the vector will be multiplied.
+     * @returns A new Vector2D object with the x and y values multiplied by the given value.
+     */
     static multiply(vector, value) {
         return new Vector2D(vector.x * value, vector.y * value);
     }
+    /**
+     * The function divides the x and y components of a Vector2D by a given value and returns a new Vector2D.
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector with
+     * x and y components.
+     * @param {number} value - The value parameter is a number that will be used to divide the x and y components of the
+     * vector.
+     * @returns A new instance of the Vector2D class with the x and y values divided by the given value.
+     */
     static divide(vector, value) {
         return new Vector2D(vector.x / value, vector.y / value);
     }
+    /**
+     * The function checks if two Vector2D objects are equal by comparing their x and y values.
+     * @param {Vector2D} vector1 - The parameter `vector1` is of type `Vector2D`, which represents a 2-dimensional vector.
+     * It has two properties: `x` and `y`, which represent the x and y components of the vector, respectively.
+     * @param {Vector2D} vector2 - The parameter "vector2" is of type Vector2D.
+     * @returns a boolean value, which indicates whether the two input vectors are equal or not.
+     */
     static equals(vector1, vector2) {
         return vector1.x === vector2.x && vector1.y === vector2.y;
     }
+    /**
+     * The function checks if two Vector2D objects are equal within a specified rounding factor.
+     * @param {Vector2D} vector1 - The first vector to compare.
+     * @param {Vector2D} vector2 - The parameter "vector2" is a Vector2D object, which represents a 2-dimensional vector.
+     * It is used as one of the inputs for the "equalsRounded" function.
+     * @param [roundingFactor=12] - The roundingFactor parameter is used to determine the threshold for considering two
+     * vectors as equal. If the absolute difference in the x and y components of the vectors is less than the
+     * roundingFactor, the vectors are considered equal.
+     * @returns a boolean value.
+     */
     static equalsRounded(vector1, vector2, roundingFactor = 12) {
         const vector = Vector2D.abs(Vector2D.subtract(vector1, vector2));
         if (vector.x < roundingFactor && vector.y < roundingFactor) {
@@ -44,57 +132,156 @@ class Vector2D {
         }
         return false;
     }
+    /**
+     * The normalize function takes a vector as input and returns a normalized version of the vector.Normalizes the vector if it matches a certain condition
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D.
+     * @returns the normalized vector if its length is greater than a very small value (epsilon), otherwise it returns the
+     * original vector.
+     */
     static normalize(vector) {
         const length = vector.length;
         if (length > 2.220446049250313e-16) {
+            // Epsilon
             return Vector2D.divide(vector, length);
         }
         return vector;
     }
+    /**
+     * The function truncates a vector to a maximum length if it exceeds that length.Adjusts x and y so that the length of the vector does not exceed max
+     * @param {Vector2D} vector - A 2D vector represented by the Vector2D class.
+     * @param {number} max - The `max` parameter is a number that represents the maximum length that the `vector` should
+     * have.
+     * @returns either the original vector or a truncated version of the vector, depending on whether the length of the
+     * vector is greater than the maximum value specified.
+     */
     static truncate(vector, max) {
         if (vector.length > max) {
             return Vector2D.multiply(Vector2D.normalize(vector), max);
         }
         return vector;
     }
+    /**
+     * The function returns a new Vector2D object that is perpendicular to the input vector.The vector that is perpendicular to this one
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D.
+     * @returns A new Vector2D object is being returned.
+     */
     static perp(vector) {
         return new Vector2D(-vector.y, vector.x);
     }
+    /**
+     * The reverse function takes a Vector2D object and returns a new Vector2D object with the negated x and y values.
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector. It
+     * has two properties: "x" and "y", which represent the x and y components of the vector, respectively.
+     * @returns A new Vector2D object with the negated x and y values of the input vector. Returns the vector that is the reverse of this vector
+     */
     static reverse(vector) {
         return new Vector2D(-vector.x, -vector.y);
     }
+    /**
+     * The function takes a Vector2D object as input and returns a new Vector2D object with the absolute values of its x
+     * and y components.
+     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector. It
+     * has two properties: "x" and "y", which represent the x and y components of the vector, respectively.
+     * @returns The method is returning a new Vector2D object with the absolute values of the x and y components of the
+     * input vector.
+     */
     static abs(vector) {
         return new Vector2D(Math.abs(vector.x), Math.abs(vector.y));
     }
+    /**
+     * The dot function calculates the dot product of two 2D vectors.The dot product of v1 and v2
+     * @param {Vector2D} vector1 - The parameter `vector1` represents a 2D vector with its x and y components.
+     * @param {Vector2D} vector2 - The "vector2" parameter is a Vector2D object. It represents a two-dimensional vector
+     * with an x and y component.
+     * @returns The dot product of the two input vectors.
+     */
     static dot(vector1, vector2) {
         return vector1.x * vector2.x + vector1.y * vector2.y;
     }
+    // /**
+    //  * Transform vectors based on the current tranformation matrices: translation, rotation and scale
+    //  * @param vectors The vectors to transform
+    //  */
+    // static transform(vector: Vector2D, transformation: Matrix2D): Vector2D {
+    //     return Matrix2D.multiplyByVector(transformation, vector)
+    // }
+    // /**
+    //  * Transform vectors based on the current tranformation matrices: translation, rotation and scale
+    //  * @param vectors The vectors to transform
+    //  */
+    // static transformList(vectors: Vector2D[], transformation: Matrix2D): Vector2D[] {
+    //     return vectors.map(vector => Matrix2D.multiplyByVector(transformation, vector))
+    // }
+    /**
+     * The function calculates the distance between two points in a two-dimensional space.
+     * @param {Vector2D} vector1 - The parameter `vector1` represents the first vector in 2D space, while `vector2`
+     * represents the second vector. Each vector has an `x` and `y` component, which represent their respective coordinates
+     * in the 2D space.
+     * @param {Vector2D} vector2 - The `vector2` parameter represents the second vector in the calculation of distance. It
+     * is an instance of the `Vector2D` class, which typically has properties `x` and `y` representing the coordinates of
+     * the vector in a 2D space.
+     * @returns The distance between vector1 and vector2.
+     */
     static distance(vector1, vector2) {
         const ySeparation = vector2.y - vector1.y;
         const xSeparation = vector2.x - vector1.x;
         return Math.sqrt(ySeparation * ySeparation + xSeparation * xSeparation);
     }
+    /**
+     * The function calculates the squared distance between two 2D vectors.
+     * @param {Vector2D} vector1 - The parameter `vector1` represents the first vector, which is an instance of the
+     * `Vector2D` class. It contains the x and y coordinates of the vector.
+     * @param {Vector2D} vector2 - The `vector2` parameter represents the second vector in a two-dimensional space. It has
+     * properties `x` and `y` which represent the coordinates of the vector.
+     * @returns the square of the distance between the two input vectors.
+     */
     static distanceSq(vector1, vector2) {
         const ySeparation = vector2.y - vector1.y;
         const xSeparation = vector2.x - vector1.x;
         return ySeparation * ySeparation + xSeparation * xSeparation;
     }
+    /**
+     * The sign function determines the sign of the cross product between two 2D vectors.
+     * (assuming the Y axis is pointing down, X axis to right like a Window app)
+     * @param {Vector2D} vector1 - The parameter `vector1` is of type `Vector2D`, which represents a 2-dimensional vector.
+     * It likely has properties `x` and `y` representing the x and y components of the vector, respectively.
+     * @param {Vector2D} vector2 - The above code defines a function called "sign" that takes two parameters: vector1 and
+     * vector2. Both vector1 and vector2 are of type Vector2D.
+     * @returns either -1 or 1. Returns positive if v2 is clockwise of this vector, negative if counterclockwise
+     */
     static sign(vector1, vector2) {
         if (vector1.y * vector2.x > vector1.x * vector2.y) {
             return -1;
         }
         return 1;
     }
+    /**
+     * The function calculates the angle between a given vector and the negative y-axis.
+     * @param {Vector2D} vector - The "vector" parameter is an instance of the Vector2D class, which represents a
+     * 2-dimensional vector. It has two properties: "x" and "y", which represent the x and y components of the vector,
+     * respectively.
+     * @returns the angle between the given vector and the vector (0, -1) in radians.Returns the angle between origin and the given vector in radians
+     */
     static angle(vector) {
         const origin = new Vector2D(0, -1);
         const radian = Math.acos(Vector2D.dot(vector, origin) / (vector.length * origin.length));
         return Vector2D.sign(vector, origin) === 1 ? Math.PI * 2 - radian : radian;
     }
+    /**
+     * The function "random" generates a random Vector2D object with x and y values within the specified range.
+     * @param {number} maxX - The maxX parameter represents the maximum value for the x-coordinate of the random vector.
+     * @param {number} maxY - The `maxY` parameter represents the maximum value for the y-coordinate of the generated
+     * random vector.
+     * @returns a new instance of the Vector2D class with random x and y values.
+     */
     static random(maxX, maxY) {
         const randX = Math.floor(Math.random() * maxX - maxX / 2);
         const randY = Math.floor(Math.random() * maxY - maxY / 2);
         return new Vector2D(randX, randY);
     }
+    /**
+     * The function sets the values of x and y to zero.
+     */
     zero() {
         this.x = 0;
         this.y = 0;

package/dist/data-structures/matrix/vector2d.js.map

@@ -1 +1 @@
-{"version":3,"file":"vector2d.js","sourceRoot":"","sources":["../../../src/data-structures/matrix/vector2d.ts"],"names":[],"mappings":";;;AAOA,MAAa,QAAQ;IACnB,YACS,IAAY,CAAC,EACb,IAAY,CAAC,EACb,IAAY,CAAC;QAFb,MAAC,GAAD,CAAC,CAAY;QACb,MAAC,GAAD,CAAC,CAAY;QACb,MAAC,GAAD,CAAC,CAAY;IACnB,CAAC;IAMJ,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAMD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAMD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;IAOD,IAAI,OAAO;QACT,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IAYD,MAAM,CAAC,GAAG,CAAC,OAAiB,EAAE,OAAiB;QAC7C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAaD,MAAM,CAAC,QAAQ,CAAC,OAAiB,EAAE,OAAiB;QAClD,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAWD,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,KAAa;QAClD,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IAUD,MAAM,CAAC,QAAQ,CAAC,MAAgB,EAAE,KAAa;QAC7C,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IAUD,MAAM,CAAC,MAAM,CAAC,MAAgB,EAAE,KAAa;QAC3C,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IASD,MAAM,CAAC,MAAM,CAAC,OAAiB,EAAE,OAAiB;QAChD,OAAO,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IAYD,MAAM,CAAC,aAAa,CAAC,OAAiB,EAAE,OAAiB,EAAE,cAAc,GAAG,EAAE;QAC5E,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,CAAC,GAAG,cAAc,IAAI,MAAM,CAAC,CAAC,GAAG,cAAc,EAAE;YAC1D,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAQD,MAAM,CAAC,SAAS,CAAC,MAAgB;QAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,MAAM,GAAG,qBAAqB,EAAE;YAElC,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACxC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAUD,MAAM,CAAC,QAAQ,CAAC,MAAgB,EAAE,GAAW;QAC3C,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;YACvB,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;SAC3D;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAOD,MAAM,CAAC,IAAI,CAAC,MAAgB;QAC1B,OAAO,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAQD,MAAM,CAAC,OAAO,CAAC,MAAgB;QAC7B,OAAO,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IAUD,MAAM,CAAC,GAAG,CAAC,MAAgB;QACzB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IASD,MAAM,CAAC,GAAG,CAAC,OAAiB,EAAE,OAAiB;QAC7C,OAAO,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IACvD,CAAC;IA4BD,MAAM,CAAC,QAAQ,CAAC,OAAiB,EAAE,OAAiB;QAClD,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC;IAC1E,CAAC;IAUD,MAAM,CAAC,UAAU,CAAC,OAAiB,EAAE,OAAiB;QACpD,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,OAAO,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;IAC/D,CAAC;IAWD,MAAM,CAAC,IAAI,CAAC,OAAiB,EAAE,OAAiB;QAC9C,IAAI,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE;YACjD,OAAO,CAAC,CAAC,CAAC;SACX;QAED,OAAO,CAAC,CAAC;IACX,CAAC;IASD,MAAM,CAAC,KAAK,CAAC,MAAgB;QAC3B,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACzF,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7E,CAAC;IASD,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAKD,IAAI;QACF,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAlTD,4BAkTC;AAED,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"vector2d.js","sourceRoot":"","sources":["../../../src/data-structures/matrix/vector2d.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,MAAa,QAAQ;IACnB,YACS,IAAY,CAAC,EACb,IAAY,CAAC,EACb,IAAY,CAAC,CAAC,mCAAmC;;QAFjD,MAAC,GAAD,CAAC,CAAY;QACb,MAAC,GAAD,CAAC,CAAY;QACb,MAAC,GAAD,CAAC,CAAY;IACnB,CAAC;IAEJ;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAG,CAAC,OAAiB,EAAE,OAAiB;QAC7C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAiB,EAAE,OAAiB;QAClD,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,KAAa;QAClD,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAgB,EAAE,KAAa;QAC7C,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAC,MAAgB,EAAE,KAAa;QAC3C,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,OAAiB,EAAE,OAAiB;QAChD,OAAO,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CAAC,OAAiB,EAAE,OAAiB,EAAE,cAAc,GAAG,EAAE;QAC5E,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,CAAC,GAAG,cAAc,IAAI,MAAM,CAAC,CAAC,GAAG,cAAc,EAAE;YAC1D,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,MAAgB;QAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,MAAM,GAAG,qBAAqB,EAAE;YAClC,UAAU;YACV,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACxC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAgB,EAAE,GAAW;QAC3C,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;YACvB,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;SAC3D;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,MAAgB;QAC1B,OAAO,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,MAAgB;QAC7B,OAAO,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,CAAC,MAAgB;QACzB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,OAAiB,EAAE,OAAiB;QAC7C,OAAO,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM;IACN,oGAAoG;IACpG,6CAA6C;IAC7C,MAAM;IACN,2EAA2E;IAC3E,+DAA+D;IAC/D,IAAI;IAEJ,MAAM;IACN,oGAAoG;IACpG,6CAA6C;IAC7C,MAAM;IACN,oFAAoF;IACpF,sFAAsF;IACtF,IAAI;IAEJ;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAiB,EAAE,OAAiB;QAClD,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,OAAiB,EAAE,OAAiB;QACpD,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QAC1C,OAAO,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,OAAiB,EAAE,OAAiB;QAC9C,IAAI,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE;YACjD,OAAO,CAAC,CAAC,CAAC;SACX;QAED,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,MAAgB;QAC3B,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACzF,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAlTD,4BAkTC;AAED,kBAAe,QAAQ,CAAC"}

package/dist/data-structures/priority-queue/index.d.ts

@@ -0,0 +1,3 @@
+export * from './priority-queue';
+export * from './min-priority-queue';
+export * from './max-priority-queue';

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

@@ -0,0 +1,15 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { PriorityQueue } from './priority-queue';
+import type { PriorityQueueOptions } from '../../types';
+export declare class MaxPriorityQueue<E = any> extends PriorityQueue<E> {
+    constructor(options?: Omit<PriorityQueueOptions<number>, 'comparator'>);
+    constructor(options: PriorityQueueOptions<E>);
+    static heapify<E extends number>(options?: Omit<PriorityQueueOptions<E>, 'comparator'>): MaxPriorityQueue<E>;
+    static heapify<E>(options: PriorityQueueOptions<E>): MaxPriorityQueue<E>;
+}

package/dist/data-structures/priority-queue/max-priority-queue.js

@@ -1,8 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MaxPriorityQueue = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 const priority_queue_1 = require("./priority-queue");
 class MaxPriorityQueue extends priority_queue_1.PriorityQueue {
+    /**
+     * The constructor initializes a priority queue with an optional comparator function.
+     * @param [options] - The `options` parameter is an optional object that can contain various properties to configure
+     * the priority queue.
+     */
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
                 ? options.comparator
@@ -11,6 +23,12 @@ class MaxPriorityQueue extends priority_queue_1.PriorityQueue {
                     return bKey - aKey;
                 } }));
     }
+    /**
+     * The function `heapify` creates a max priority queue from the given options and returns it.
+     * @param options - The `options` parameter is an object that contains configuration options for creating a priority
+     * queue. It can have the following properties:
+     * @returns a MaxPriorityQueue object.
+     */
     static heapify(options) {
         const maxPQ = new MaxPriorityQueue(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
                 ? options.comparator

package/dist/data-structures/priority-queue/max-priority-queue.js.map

@@ -1 +1 @@
-{"version":3,"file":"max-priority-queue.js","sourceRoot":"","sources":["../../../src/data-structures/priority-queue/max-priority-queue.ts"],"names":[],"mappings":";;;AAOA,qDAA+C;AAG/C,MAAa,gBAA0B,SAAQ,8BAAgB;IAS7D,YAAY,OAAgE;QAC1E,KAAK,iCACA,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;IACL,CAAC;IAWD,MAAM,CAAU,OAAO,CAAI,OAAgC;QACzD,MAAM,KAAK,GAAG,IAAI,gBAAgB,iCAC7B,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;QACH,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA7CD,4CA6CC"}
+{"version":3,"file":"max-priority-queue.js","sourceRoot":"","sources":["../../../src/data-structures/priority-queue/max-priority-queue.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,qDAA+C;AAG/C,MAAa,gBAA0B,SAAQ,8BAAgB;IAI7D;;;;OAIG;IACH,YAAY,OAAgE;QAC1E,KAAK,iCACA,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;IACL,CAAC;IAKD;;;;;OAKG;IACH,MAAM,CAAU,OAAO,CAAI,OAAgC;QACzD,MAAM,KAAK,GAAG,IAAI,gBAAgB,iCAC7B,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;QACH,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA7CD,4CA6CC"}

package/dist/data-structures/priority-queue/min-priority-queue.d.ts

@@ -0,0 +1,15 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { PriorityQueue } from './priority-queue';
+import type { PriorityQueueOptions } from '../../types';
+export declare class MinPriorityQueue<E = any> extends PriorityQueue<E> {
+    constructor(options?: Omit<PriorityQueueOptions<number>, 'comparator'>);
+    constructor(options: PriorityQueueOptions<E>);
+    static heapify<E extends number>(options?: Omit<PriorityQueueOptions<E>, 'comparator'>): MinPriorityQueue<E>;
+    static heapify<E>(options: PriorityQueueOptions<E>): MinPriorityQueue<E>;
+}

package/dist/data-structures/priority-queue/min-priority-queue.js

@@ -1,8 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MinPriorityQueue = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 const priority_queue_1 = require("./priority-queue");
 class MinPriorityQueue extends priority_queue_1.PriorityQueue {
+    /**
+     * The constructor initializes a priority queue with an optional comparator function.
+     * @param [options] - The `options` parameter is an optional object that can contain various configuration options for
+     * the `PriorityQueue` constructor.
+     */
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
                 ? options.comparator
@@ -11,6 +23,13 @@ class MinPriorityQueue extends priority_queue_1.PriorityQueue {
                     return aKey - bKey;
                 } }));
     }
+    /**
+     * The function `heapify` creates a new MinPriorityQueue instance and sets the comparator function based on the options
+     * provided, and then fixes the heap structure of the queue.
+     * @param options - The `options` parameter is an object that contains configuration options for creating a priority
+     * queue. It can have the following properties:
+     * @returns a MinPriorityQueue object.
+     */
     static heapify(options) {
         const minPQ = new MinPriorityQueue(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
                 ? options.comparator

package/dist/data-structures/priority-queue/min-priority-queue.js.map

@@ -1 +1 @@
-{"version":3,"file":"min-priority-queue.js","sourceRoot":"","sources":["../../../src/data-structures/priority-queue/min-priority-queue.ts"],"names":[],"mappings":";;;AAOA,qDAA+C;AAG/C,MAAa,gBAA0B,SAAQ,8BAAgB;IAS7D,YAAY,OAAgE;QAC1E,KAAK,iCACA,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;IACL,CAAC;IAYD,MAAM,CAAU,OAAO,CAAI,OAAgC;QACzD,MAAM,KAAK,GAAG,IAAI,gBAAgB,iCAC7B,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;QACH,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA9CD,4CA8CC"}
+{"version":3,"file":"min-priority-queue.js","sourceRoot":"","sources":["../../../src/data-structures/priority-queue/min-priority-queue.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,qDAA+C;AAG/C,MAAa,gBAA0B,SAAQ,8BAAgB;IAI7D;;;;OAIG;IACH,YAAY,OAAgE;QAC1E,KAAK,iCACA,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;IACL,CAAC;IAKD;;;;;;OAMG;IACH,MAAM,CAAU,OAAO,CAAI,OAAgC;QACzD,MAAM,KAAK,GAAG,IAAI,gBAAgB,iCAC7B,OAAO,KACV,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;gBAC7B,CAAC,CAAC,OAAO,CAAC,UAAU;gBACpB,CAAC,CAAC,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE;oBACb,MAAM,IAAI,GAAG,CAAsB,EACjC,IAAI,GAAG,CAAsB,CAAC;oBAChC,OAAO,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC,IACL,CAAC;QACH,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA9CD,4CA8CC"}

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

@@ -0,0 +1,180 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { PriorityQueueComparator, PriorityQueueDFSOrderPattern, PriorityQueueOptions } from '../../types';
+export declare class PriorityQueue<E = any> {
+    /**
+     * The constructor initializes a priority queue with the given options, including an array of nodes and a comparator
+     * function.
+     * @param options - The `options` parameter is an object that contains the following properties:
+     */
+    constructor(options: PriorityQueueOptions<E>);
+    protected _nodes: E[];
+    get nodes(): E[];
+    get size(): number;
+    /**
+     * The `heapify` function creates a new PriorityQueue instance and fixes the heap property.
+     * @param options - The "options" parameter is an object that contains the configuration options for the PriorityQueue.
+     * It can include properties such as "comparator" which specifies the comparison function used to order the elements in
+     * the priority queue, and "initialValues" which is an array of initial values to be added to the priority
+     * @returns a new instance of the PriorityQueue class after performing the heapify operation on it.
+     */
+    static heapify<E>(options: PriorityQueueOptions<E>): PriorityQueue<E>;
+    /**
+     * The function checks if a priority queue is valid by creating a new priority queue with a fix option and then calling
+     * the isValid method.
+     * @param options - An object containing options for creating a priority queue. The options object should have the
+     * following properties:
+     * @returns the result of calling the `isValid()` method on a new instance of the `PriorityQueue` class.
+     */
+    static isPriorityQueueified<E>(options: Omit<PriorityQueueOptions<E>, 'isFix'>): boolean;
+    /**
+     * Starting from TypeScript version 5.0 and onwards, the use of distinct access modifiers for Getters and Setters is not permitted. As an alternative, to ensure compatibility, it is necessary to adopt a Java-style approach for Setters (using the same name as the property) while utilizing separate method names for Getters.
+     */
+    getNodes(): E[];
+    /**
+     * The "add" function adds a node to the heap and ensures that the heap property is maintained.
+     * @param {E} node - The parameter "node" is of type E, which means it can be any data type. It represents the node
+     * that needs to be added to the heap.
+     */
+    add(node: E): void;
+    /**
+     * The "has" function checks if a given node is present in the list of nodes.
+     * @param {E} node - The parameter `node` is of type `E`, which means it can be any type. It represents the node that
+     * we want to check if it exists in the `nodes` array.
+     * @returns a boolean value indicating whether the given node is included in the array of nodes.
+     */
+    has(node: E): boolean;
+    /**
+     * The `peek` function returns the first element of the `nodes` array if it exists, otherwise it returns `null`.
+     * @returns The `peek()` function is returning the first element (`E`) of the `nodes` array if the `size` is not zero.
+     * Otherwise, it returns `null`.
+     */
+    peek(): E | null;
+    /**
+     * The `poll` function removes and returns the top element from a heap data structure.
+     * @returns The `poll()` method returns a value of type `E` or `null`.
+     */
+    poll(): E | null;
+    /**
+     * The `leaf` function returns the last element in the `nodes` array or `null` if the array is empty.
+     * @returns The method `leaf()` is returning the last element (`E`) in the `nodes` array if it exists. If the array is
+     * empty or the last element is `null`, then it returns `null`.
+     */
+    leaf(): E | null;
+    /**
+     * The function checks if the size of an object is equal to zero and returns a boolean value indicating whether the
+     * object is empty or not.
+     * @returns The method `isEmpty()` is returning a boolean value indicating whether the size of the object is equal to
+     * 0.
+     */
+    isEmpty(): boolean;
+    /**
+     * The clear function clears the nodes array.
+     */
+    clear(): void;
+    /**
+     * The toArray function returns an array containing all the elements in the nodes property.
+     * @returns An array of type E, which is the elements of the nodes property.
+     */
+    toArray(): E[];
+    /**
+     * The `clone` function returns a new instance of the `PriorityQueue` class with the same nodes and comparator as the
+     * original instance.
+     * @returns The `clone()` method is returning a new instance of the `PriorityQueue` class with the same `nodes` and
+     * `comparator` properties as the original instance.
+     */
+    clone(): PriorityQueue<E>;
+    /**
+     * The `isValid` function recursively checks if a binary tree satisfies a certain condition.
+     * @returns The function `isValid()` returns a boolean value.
+     */
+    isValid(): boolean;
+    /**
+     * O(n log n), In scenarios with smaller data sizes, heap sort is generally expected to be slower than QuickSort or MergeSort.
+     */
+    /**
+     * The function sorts the elements in a data structure and returns them in an array.
+     * Plan to support sorting of duplicate elements.
+     * @returns The `sort()` method is returning an array of type `E[]`.
+     */
+    sort(): E[];
+    /**
+     * The dfs function performs a depth-first search traversal on a binary tree and returns an array of visited nodes
+     * based on the specified traversal order.
+     * @param {PriorityQueueDFSOrderPattern} dfsMode - The dfsMode parameter is a string that specifies the order in which
+     * the nodes should be visited during the Depth-First Search (dfs) traversal. It can have one of the following values:
+     * @returns an array of type `(E | null)[]`.
+     */
+    dfs(dfsMode: PriorityQueueDFSOrderPattern): (E | null)[];
+    protected _setNodes(value: E[]): void;
+    protected readonly _comparator: PriorityQueueComparator<E>;
+    /**
+     * The function compares two numbers using a custom comparator function.
+     * @param {number} a - The parameter "a" is a number that represents the index of a node in an array.
+     * @param {number} b - The parameter "b" is a number.
+     * @returns the result of the comparison between the elements at indices `a` and `b` in the `nodes` array. The
+     * comparison is done using the `_comparator` function, and if the result is greater than 0, `true` is returned,
+     * indicating that the element at index `a` is greater than the element at index `b`.
+     */
+    protected _compare(a: number, b: number): boolean;
+    /**
+     * The function swaps two elements in an array.
+     * @param {number} a - The parameter "a" is a number that represents the index of an element in an array.
+     * @param {number} b - The parameter "b" is a number.
+     */
+    protected _swap(a: number, b: number): void;
+    /**
+     * The function checks if a given index is valid within an array.
+     * @param {number} index - The parameter "index" is of type number and represents the index value that needs to be
+     * checked for validity.
+     * @returns A boolean value indicating whether the given index is valid or not.
+     */
+    protected _isValidIndex(index: number): boolean;
+    /**
+     * The function returns the index of the parent node given the index of a child node in a binary tree.
+     * @param {number} child - The "child" parameter is a number representing the index of a child node in a binary tree.
+     * @returns the parent of the given child node.
+     */
+    protected _getParent(child: number): number;
+    /**
+     * The function returns the index of the left child node in a binary tree given the index of its parent node.
+     * @param {number} parent - The parameter "parent" is a number that represents the index of a node in a binary tree.
+     * @returns the left child of a given parent node in a binary tree.
+     */
+    protected _getLeft(parent: number): number;
+    /**
+     * The function returns the index of the right child node in a binary tree given the index of its parent node.
+     * @param {number} parent - The parameter "parent" is a number that represents the index of a node in a binary tree.
+     * @returns the right child of a given parent node in a binary tree.
+     */
+    protected _getRight(parent: number): number;
+    /**
+     * The function returns the index of the smallest child node of a given parent node.
+     * @param {number} parent - The parent parameter is a number that represents the index of the parent node in a binary
+     * tree.
+     * @returns the minimum value between the parent node and its left and right child nodes.
+     */
+    protected _getComparedChild(parent: number): number;
+    /**
+     * The function `_heapifyUp` is used to maintain the heap property by moving an element up the heap until it is in the
+     * correct position.
+     * @param {number} start - The start parameter is the index of the element that needs to be moved up in the heap.
+     */
+    protected _heapifyUp(start: number): void;
+    /**
+     * The function performs a heapify operation by comparing and swapping elements in a binary heap.
+     * @param {number} start - The start parameter is the index of the element in the heap from where the heapifyDown
+     * operation should start.
+     */
+    protected _heapifyDown(start: number): void;
+    /**
+     * The _fix function performs a heapify operation on the elements of the heap starting from the middle and moving
+     * towards the root.
+     */
+    protected _fix(): void;
+}