@lowentry/utils 1.20.1 → 1.21.1

package/build/LeUtils.d.ts

@@ -119,21 +119,6 @@ export namespace LeUtils {
     function localStorageRemove(id: string): void;
     function isCurrentHostPrivate(): boolean;
     function isGivenHostPrivate(host: string): boolean;
-    function createTreeSet(elements: any[], comparator: (valueA: any, valueB: any) => number): {
-        getElements: (() => any[]);
-        getComparator: (() => ((valueA: any, valueB: any) => number));
-        size: (() => number);
-        isEmpty: (() => boolean);
-        contains: ((value: any) => boolean);
-        first: (() => any | undefined);
-        last: (() => any | undefined);
-        pollFirst: (() => any | undefined);
-        pollLast: (() => any | undefined);
-        add: ((value: any) => void);
-        addAll: ((values: any) => void);
-        getEqualValue: ((value: any) => any);
-        getEqualValueOrAdd: ((value: any) => any);
-    };
     function createTransactionalValue(value?: any): {
         value: any;
         changes: {

package/build/classes/TreeSet.d.ts

@@ -0,0 +1,115 @@
+/**
+ * A TreeSet is a set of elements, sorted by a comparator.
+ * Binary search is used to find elements, which makes it very fast to find elements.
+ *
+ * The comparator is also used to determine if two values are equal to each other.
+ * This way, you can have values that aren't the same be treated as if they are. This can be used to deal with issues such as floating point errors for example.
+ */
+export class TreeSet {
+    /**
+     * Creates a new TreeSet with the given elements and comparator.
+     *
+     * @param {*[]} [elements=[]] - The initial elements of the set.
+     * @param {(valueA:*, valueB:*) => number} [comparator=LeUtils.compare] - The comparator function to use for sorting.
+     */
+    constructor(elements?: any[], comparator?: (valueA: any, valueB: any) => number);
+    /**
+     *
+     *
+     * @param {*} value - The value to search for in the set.
+     * @returns {{found:boolean, index:number, value:*|undefined}} - An object containing whether the value was found, the index where it would be inserted, and the value at that index (if found).
+     * @private
+     */
+    private binarySearch;
+    /**
+     * Returns the elements of the set.
+     */
+    getElements(): any[];
+    /**
+     * Returns the comparator of the set.
+     *
+     * @returns {(valueA:*, valueB:*) => number}
+     */
+    getComparator(): (valueA: any, valueB: any) => number;
+    /**
+     * Returns the size of the set.
+     *
+     * @returns {number}
+     */
+    size(): number;
+    /**
+     * Returns true if the set is empty, false otherwise.
+     *
+     * @returns {boolean}
+     */
+    isEmpty(): boolean;
+    /**
+     * Returns true if the set contains a value that is equal to the given value, returns false otherwise.
+     *
+     * @param {*} value - The value to check for in the set.
+     * @return {boolean} - True if the set contains the value, false otherwise.
+     */
+    contains(value: any): boolean;
+    /**
+     * Returns the first element of the set, or undefined if it is empty.
+     *
+     * @return {*|undefined} - The first element of the set, or undefined if it is empty.
+     */
+    first(): any | undefined;
+    /**
+     * Returns the last element of the set, or undefined if it is empty.
+     *
+     * @return {*|undefined} - The last element of the set, or undefined if it is empty.
+     */
+    last(): any | undefined;
+    /**
+     * Removes and returns the first element of the set, or undefined if it is empty.
+     *
+     * @returns {*|undefined} - The first element of the set, or undefined if it is empty.
+     */
+    pollFirst(): any | undefined;
+    /**
+     * Removes and returns the last element of the set, or undefined if it is empty.
+     *
+     * @returns {*|undefined} - The last element of the set, or undefined if it is empty.
+     */
+    pollLast(): any | undefined;
+    /**
+     * Adds the given value to the set. Will only do so if no equal value already exists.
+     * @param {*} value - The value to add to the set.
+     */
+    add(value: any): void;
+    /**
+     * Adds all the given values to the set. Will only do so if no equal value already exists.
+     *
+     * @param {*} values - The values to add to the set.
+     */
+    addAll(values: any): void;
+    /**
+     * Returns an equal value that's already in the tree set, or undefined if no equal values in it exist.
+     *
+     * @param {*} value - The value to search for in the set.
+     * @return {*|undefined} - The equal value if found, or undefined if not found.
+     */
+    getEqualValue(value: any): any | undefined;
+    /**
+     * Returns an equal value that's already in the tree set. If no equal values in it exist, the given value will be added and returned.
+     *
+     * @param {*} value - The value to search for in the set.
+     * @return {*} - The equal value if found, or the added value if not found.
+     */
+    getEqualValueOrAdd(value: any): any;
+    /**
+     * Returns a string representation of the TreeSet.
+     *
+     * @returns {string} - A string representation of the TreeSet, including its elements and comparator.
+     */
+    toString(): string;
+    /**
+     * Returns a JSON representation of the TreeSet.
+     *
+     * @returns {Object} - An object containing the elements and comparator of the TreeSet.
+     */
+    toJSON(): any;
+    #private;
+}

package/build/index.d.ts

@@ -1,4 +1,5 @@
 export { LeUtils } from "./LeUtils.js";
 export { LinkedList } from "./classes/LinkedList.js";
 export { SerializableMap } from "./classes/SerializableMap.js";
+export { TreeSet } from "./classes/TreeSet.js";
 export { ISSET, IS_ARRAY, ARRAY, IS_OBJECT, OBJECT, STRING, STRING_ANY, INT, INT_ANY, FLOAT, FLOAT_ANY, INT_LAX, INT_LAX_ANY, FLOAT_LAX, FLOAT_LAX_ANY } from "./LeTypes.js";

package/index.d.ts

@@ -143,21 +143,6 @@ export declare namespace LeUtils {
     export function localStorageRemove(id: string): void;
     export function isCurrentHostPrivate(): boolean;
     export function isGivenHostPrivate(host: string): boolean;
-    export function createTreeSet(elements: any[], comparator: (valueA: any, valueB: any) => number): {
-        getElements: (() => any[]);
-        getComparator: (() => ((valueA: any, valueB: any) => number));
-        size: (() => number);
-        isEmpty: (() => boolean);
-        contains: ((value: any) => boolean);
-        first: (() => any | undefined);
-        last: (() => any | undefined);
-        pollFirst: (() => any | undefined);
-        pollLast: (() => any | undefined);
-        add: ((value: any) => void);
-        addAll: ((values: any) => void);
-        getEqualValue: ((value: any) => any);
-        getEqualValueOrAdd: ((value: any) => any);
-    };
     export function createTransactionalValue(value?: any): {
         value: any;
         changes: {
@@ -299,4 +284,120 @@ export declare function STRING(value: any): string;
 
 export declare function STRING_ANY(...values: any): string;
 
+/**
+ * A TreeSet is a set of elements, sorted by a comparator.
+ * Binary search is used to find elements, which makes it very fast to find elements.
+ *
+ * The comparator is also used to determine if two values are equal to each other.
+ * This way, you can have values that aren't the same be treated as if they are. This can be used to deal with issues such as floating point errors for example.
+ */
+export declare class TreeSet {
+    /**
+     * Creates a new TreeSet with the given elements and comparator.
+     *
+     * @param {*[]} [elements=[]] - The initial elements of the set.
+     * @param {(valueA:*, valueB:*) => number} [comparator=LeUtils.compare] - The comparator function to use for sorting.
+     */
+    constructor(elements?: any[], comparator?: (valueA: any, valueB: any) => number);
+    /**
+     *
+     *
+     * @param {*} value - The value to search for in the set.
+     * @returns {{found:boolean, index:number, value:*|undefined}} - An object containing whether the value was found, the index where it would be inserted, and the value at that index (if found).
+     * @private
+     */
+    private binarySearch;
+    /**
+     * Returns the elements of the set.
+     */
+    getElements(): any[];
+    /**
+     * Returns the comparator of the set.
+     *
+     * @returns {(valueA:*, valueB:*) => number}
+     */
+    getComparator(): (valueA: any, valueB: any) => number;
+    /**
+     * Returns the size of the set.
+     *
+     * @returns {number}
+     */
+    size(): number;
+    /**
+     * Returns true if the set is empty, false otherwise.
+     *
+     * @returns {boolean}
+     */
+    isEmpty(): boolean;
+    /**
+     * Returns true if the set contains a value that is equal to the given value, returns false otherwise.
+     *
+     * @param {*} value - The value to check for in the set.
+     * @return {boolean} - True if the set contains the value, false otherwise.
+     */
+    contains(value: any): boolean;
+    /**
+     * Returns the first element of the set, or undefined if it is empty.
+     *
+     * @return {*|undefined} - The first element of the set, or undefined if it is empty.
+     */
+    first(): any | undefined;
+    /**
+     * Returns the last element of the set, or undefined if it is empty.
+     *
+     * @return {*|undefined} - The last element of the set, or undefined if it is empty.
+     */
+    last(): any | undefined;
+    /**
+     * Removes and returns the first element of the set, or undefined if it is empty.
+     *
+     * @returns {*|undefined} - The first element of the set, or undefined if it is empty.
+     */
+    pollFirst(): any | undefined;
+    /**
+     * Removes and returns the last element of the set, or undefined if it is empty.
+     *
+     * @returns {*|undefined} - The last element of the set, or undefined if it is empty.
+     */
+    pollLast(): any | undefined;
+    /**
+     * Adds the given value to the set. Will only do so if no equal value already exists.
+     * @param {*} value - The value to add to the set.
+     */
+    add(value: any): void;
+    /**
+     * Adds all the given values to the set. Will only do so if no equal value already exists.
+     *
+     * @param {*} values - The values to add to the set.
+     */
+    addAll(values: any): void;
+    /**
+     * Returns an equal value that's already in the tree set, or undefined if no equal values in it exist.
+     *
+     * @param {*} value - The value to search for in the set.
+     * @return {*|undefined} - The equal value if found, or undefined if not found.
+     */
+    getEqualValue(value: any): any | undefined;
+    /**
+     * Returns an equal value that's already in the tree set. If no equal values in it exist, the given value will be added and returned.
+     *
+     * @param {*} value - The value to search for in the set.
+     * @return {*} - The equal value if found, or the added value if not found.
+     */
+    getEqualValueOrAdd(value: any): any;
+    /**
+     * Returns a string representation of the TreeSet.
+     *
+     * @returns {string} - A string representation of the TreeSet, including its elements and comparator.
+     */
+    toString(): string;
+    /**
+     * Returns a JSON representation of the TreeSet.
+     *
+     * @returns {Object} - An object containing the elements and comparator of the TreeSet.
+     */
+    toJSON(): any;
+    #private;
+}
+
 export { }