@naturalcycles/js-lib 15.59.1 → 15.61.0

package/dist/array/array.util.d.ts

@@ -158,6 +158,20 @@ export declare function _intersectsWith<T>(a1: T[], a2: T[] | Set<T>): boolean;
  * Passing second array as Set is more performant (it'll skip turning the array into Set in-place).
  */
 export declare function _difference<T>(a1: T[], a2: T[] | Set<T>): T[];
+/**
+ * Does NOT mutate the array, returns a filtered array instead.
+ */
+export declare function _arrayRemove<T>(a: T[], itemToRemove: T): T[];
+/**
+ * "Toggles" an item to be present or absent in the array,
+ * based on the predicate. Respects uniqueness.
+ *
+ * If predicate==false - item gets removed from the array.
+ * If predicate==true - item gets pushed to the array (unless it was already present).
+ *
+ * Pushing the item DOES MUTATE the array, same if you would do array.push manually.
+ */
+export declare function _arrayPushOrRemove<T>(a: T[], item: T, predicate: boolean): T[];
 /**
  * Returns the sum of items, or 0 for empty array.
  */

package/dist/array/array.util.js

@@ -282,6 +282,30 @@ export function _difference(a1, a2) {
     const a2set = a2 instanceof Set ? a2 : new Set(a2);
     return a1.filter(v => !a2set.has(v));
 }
+/**
+ * Does NOT mutate the array, returns a filtered array instead.
+ */
+export function _arrayRemove(a, itemToRemove) {
+    return a.filter(r => r !== itemToRemove);
+}
+/**
+ * "Toggles" an item to be present or absent in the array,
+ * based on the predicate. Respects uniqueness.
+ *
+ * If predicate==false - item gets removed from the array.
+ * If predicate==true - item gets pushed to the array (unless it was already present).
+ *
+ * Pushing the item DOES MUTATE the array, same if you would do array.push manually.
+ */
+export function _arrayPushOrRemove(a, item, predicate) {
+    if (predicate) {
+        if (!a.includes(item)) {
+            a.push(item);
+        }
+        return a;
+    }
+    return a.filter(r => r !== item);
+}
 /**
  * Returns the sum of items, or 0 for empty array.
  */

package/dist/math/math.util.d.ts

@@ -11,6 +11,19 @@ export declare function _average(values: number[]): number;
  * Same as _average, but safely returns null if input array is empty or nullish.
  */
 export declare function _averageOrNull(values: number[] | undefined | null): number | null;
+/**
+ * @returns Population standard deviation of the array of numbers
+ *
+ * @example
+ *
+ * _stdDev([2, 4, 4, 4, 5, 5, 7, 9])
+ * // 2
+ */
+export declare function _stdDev(values: number[]): number;
+/**
+ * Same as _stdDev, but safely returns null if input array is empty or nullish.
+ */
+export declare function _stdDevOrNull(values: number[] | undefined | null): number | null;
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */

package/dist/math/math.util.js

@@ -21,6 +21,30 @@ export function _average(values) {
 export function _averageOrNull(values) {
     return values?.length ? _average(values) : null;
 }
+/**
+ * @returns Population standard deviation of the array of numbers
+ *
+ * @example
+ *
+ * _stdDev([2, 4, 4, 4, 5, 5, 7, 9])
+ * // 2
+ */
+export function _stdDev(values) {
+    _assert(values.length, '_stdDev is called on empty array');
+    const avg = _average(values);
+    let sumSquaredDiff = 0;
+    for (const n of values) {
+        const diff = n - avg;
+        sumSquaredDiff += diff * diff;
+    }
+    return Math.sqrt(sumSquaredDiff / values.length);
+}
+/**
+ * Same as _stdDev, but safely returns null if input array is empty or nullish.
+ */
+export function _stdDevOrNull(values) {
+    return values?.length ? _stdDev(values) : null;
+}
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.59.1",
+  "version": "15.61.0",
   "dependencies": {
     "tslib": "^2",
     "undici": "^7",

package/src/array/array.util.ts

@@ -326,6 +326,33 @@ export function _difference<T>(a1: T[], a2: T[] | Set<T>): T[] {
   return a1.filter(v => !a2set.has(v))
 }
 
+/**
+ * Does NOT mutate the array, returns a filtered array instead.
+ */
+export function _arrayRemove<T>(a: T[], itemToRemove: T): T[] {
+  return a.filter(r => r !== itemToRemove)
+}
+
+/**
+ * "Toggles" an item to be present or absent in the array,
+ * based on the predicate. Respects uniqueness.
+ *
+ * If predicate==false - item gets removed from the array.
+ * If predicate==true - item gets pushed to the array (unless it was already present).
+ *
+ * Pushing the item DOES MUTATE the array, same if you would do array.push manually.
+ */
+export function _arrayPushOrRemove<T>(a: T[], item: T, predicate: boolean): T[] {
+  if (predicate) {
+    if (!a.includes(item)) {
+      a.push(item)
+    }
+    return a
+  }
+
+  return a.filter(r => r !== item)
+}
+
 /**
  * Returns the sum of items, or 0 for empty array.
  */

package/src/math/math.util.ts

@@ -23,6 +23,32 @@ export function _averageOrNull(values: number[] | undefined | null): number | nu
   return values?.length ? _average(values) : null
 }
 
+/**
+ * @returns Population standard deviation of the array of numbers
+ *
+ * @example
+ *
+ * _stdDev([2, 4, 4, 4, 5, 5, 7, 9])
+ * // 2
+ */
+export function _stdDev(values: number[]): number {
+  _assert(values.length, '_stdDev is called on empty array')
+  const avg = _average(values)
+  let sumSquaredDiff = 0
+  for (const n of values) {
+    const diff = n - avg
+    sumSquaredDiff += diff * diff
+  }
+  return Math.sqrt(sumSquaredDiff / values.length)
+}
+
+/**
+ * Same as _stdDev, but safely returns null if input array is empty or nullish.
+ */
+export function _stdDevOrNull(values: number[] | undefined | null): number | null {
+  return values?.length ? _stdDev(values) : null
+}
+
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */