@softsky/utils 2.3.1 → 2.3.3

package/README.md

@@ -61,11 +61,28 @@ ${\textsf{\color{CornflowerBlue}function}}$ combinations - Return all combinatio
 ${\textsf{\color{CornflowerBlue}function}}$ permutations - Return all permutations of items in array
 
 ---
-${\textsf{\color{CornflowerBlue}function}}$ pushToSorted - Push data in array so array is always kept sorted
+${\textsf{\color{CornflowerBlue}function}}$ pushToSorted - Push data to sorted array. Array will always be kept sorted.
 
-Compare must return true when found position to push in.
-For example if we return `[false, false, true, false]`,
-Array will become `[false, false, Element, true, false]`.
+Compare function should compare your needed value with value on index passed to it.
+If compare returns 0 it means we found target.
+If compare returns > 0 it means target is smaller.
+If compare returns < 0 it means target is bigger.
+
+```ts
+pushToSorted(numArray, 10,  x => x - 10);
+```
+
+---
+${\textsf{\color{CornflowerBlue}function}}$ removeFromArray - Delete value from array.
+Only deletes first encountered.
+
+Returns index of deleted value.
+
+---
+${\textsf{\color{CornflowerBlue}function}}$ removeLastFromArray - Delete value from array.
+Only deletes last encountered.
+
+Returns index of deleted value.
 
 ---
 

package/dist/arrays.d.ts

@@ -14,7 +14,7 @@ export declare function swap<T>(array: T[], index: number, index2: number): T[];
  * If compare returns > 0 it means we have to cut out bigger side of array.
  * If compare returns < 0 it means we have to cut out smaller side of array.
  */
-export declare function binarySearch(size: number, compare: (index: number) => number): number;
+export declare function binarySearch(size: number, compare: (index: number) => number, returnClosest?: boolean): number;
 /** Split array into sub arrays of spicified size */
 export declare function chunk<T>(array: T[], chunkSize: number): T[][];
 /** Return all combinations of items in array */
@@ -22,10 +22,29 @@ export declare function combinations<T>(array: T[]): T[][];
 /** Return all permutations of items in array */
 export declare function permutations<T>(array: T[]): T[][];
 /**
- * Push data in array so array is always kept sorted
+ * Push data to sorted array. Array will always be kept sorted.
  *
- * Compare must return true when found position to push in.
- * For example if we return `[false, false, true, false]`,
- * Array will become `[false, false, Element, true, false]`.
+ * Compare function should compare your needed value with value on index passed to it.
+ * If compare returns 0 it means we found target.
+ * If compare returns > 0 it means target is smaller.
+ * If compare returns < 0 it means target is bigger.
+ *
+ * ```ts
+ * pushToSorted(numArray, 10,  x => x - 10);
+ * ```
+ */
+export declare function pushToSorted<T>(array: T[], element: T, compare: (x: T) => number): void;
+/**
+ * Delete value from array.
+ * Only deletes first encountered.
+ *
+ * Returns index of deleted value.
+ */
+export declare function removeFromArray<T>(array: T[], value: T): number;
+/**
+ * Delete value from array.
+ * Only deletes last encountered.
+ *
+ * Returns index of deleted value.
  */
-export declare function pushToSorted<T>(array: T[], element: T, compare: (element: T) => boolean): void;
+export declare function removeLastFromArray<T>(array: T[], value: T): number;

package/dist/arrays.js

@@ -32,12 +32,14 @@ export function swap(array, index, index2) {
  * If compare returns > 0 it means we have to cut out bigger side of array.
  * If compare returns < 0 it means we have to cut out smaller side of array.
  */
-export function binarySearch(size, compare) {
+export function binarySearch(size, compare, returnClosest) {
     let low = 0;
-    let high = size - 1;
+    let high = size;
     let position = -1;
-    while (low <= high) {
-        const mid = Math.trunc((low + high) / 2);
+    while (high >= low) {
+        const mid = ((low + high) / 2) | 0;
+        if (returnClosest)
+            position = mid;
         const compared = compare(mid);
         if (compared === 0) {
             position = mid;
@@ -94,13 +96,42 @@ export function permutations(array) {
     return result;
 }
 /**
- * Push data in array so array is always kept sorted
+ * Push data to sorted array. Array will always be kept sorted.
+ *
+ * Compare function should compare your needed value with value on index passed to it.
+ * If compare returns 0 it means we found target.
+ * If compare returns > 0 it means target is smaller.
+ * If compare returns < 0 it means target is bigger.
  *
- * Compare must return true when found position to push in.
- * For example if we return `[false, false, true, false]`,
- * Array will become `[false, false, Element, true, false]`.
+ * ```ts
+ * pushToSorted(numArray, 10,  x => x - 10);
+ * ```
  */
 export function pushToSorted(array, element, compare) {
-    const index = array.findIndex(compare);
-    array.splice(index === -1 ? array.length : index, 0, element);
+    const index = binarySearch(array.length, (x) => compare(array[x]), true);
+    array.splice(index, 0, element);
+}
+/**
+ * Delete value from array.
+ * Only deletes first encountered.
+ *
+ * Returns index of deleted value.
+ */
+export function removeFromArray(array, value) {
+    const index = array.indexOf(value);
+    if (index !== -1)
+        array.splice(index, 1);
+    return index;
+}
+/**
+ * Delete value from array.
+ * Only deletes last encountered.
+ *
+ * Returns index of deleted value.
+ */
+export function removeLastFromArray(array, value) {
+    const index = array.lastIndexOf(value);
+    if (index !== -1)
+        array.splice(index, 1);
+    return index;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@softsky/utils",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "JavaScript/TypeScript utilities",
   "main": "dist/index.js",
   "scripts": {
     "lint": "eslint \"./src/**/*.ts\" --fix && tsc",
     "gen-readme": "bun ./generate-readme.ts",
-    "prepublishOnly": "bun run test && bun run lint && bun run gen-readme",
+    "prepublishOnly": "npm i && bun run test && bun run lint && bun run gen-readme",
     "test": "bun test"
   },
   "repository": {