extra-utils 5.14.0 → 5.16.0

package/README.md

@@ -87,6 +87,40 @@ function remap(
 , [newMin, newMax]: readonly [newMin: number, newMax: number]
 ): number
 
+function remapToItem<T>(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<T>
+): T
+
+interface IWeightedItem {
+  weight: number
+}
+
+function remapToWeightedItem<T>(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<T>
+, weights: NonEmptyArray<number>
+): T
+function remapToWeightedItem<T extends IWeightedItem>(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<T>
+): T
+
+function remapToIndex(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<unknown>
+): number
+
+function remapToWeightedIndex(
+  value: number
+, range: [min: number, max: number]
+, weights: NonEmptyArray<number>
+): number
+
 function lerp(
   alpha: number
 , [from, to]: readonly [from: number, to: number]

package/lib/number/index.d.ts

@@ -5,4 +5,8 @@ export * from './is-nan.js';
 export * from './is-number.js';
 export * from './clamp.js';
 export * from './remap.js';
+export * from './remap-to-item.js';
+export * from './remap-to-weighted-item.js';
+export * from './remap-to-index.js';
+export * from './remap-to-weighted-index.js';
 export * from './lerp.js';

package/lib/number/index.js

@@ -5,5 +5,9 @@ export * from './is-nan.js';
 export * from './is-number.js';
 export * from './clamp.js';
 export * from './remap.js';
+export * from './remap-to-item.js';
+export * from './remap-to-weighted-item.js';
+export * from './remap-to-index.js';
+export * from './remap-to-weighted-index.js';
 export * from './lerp.js';
 //# sourceMappingURL=index.js.map

package/lib/number/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/number/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/number/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA;AACnC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,WAAW,CAAA"}

package/lib/number/remap-to-index.d.ts

@@ -0,0 +1,2 @@
+import { NonEmptyArray } from 'justypes';
+export declare function remapToIndex(value: number, range: readonly [min: number, max: number], items: NonEmptyArray<unknown>): number;

package/lib/number/remap-to-index.js

@@ -0,0 +1,8 @@
+import { remap } from './remap.js';
+export function remapToIndex(value, range, items) {
+    const index = Math.floor(remap(value, range, [0, items.length]));
+    return index === items.length
+        ? items.length - 1
+        : index;
+}
+//# sourceMappingURL=remap-to-index.js.map

package/lib/number/remap-to-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remap-to-index.js","sourceRoot":"","sources":["../../src/number/remap-to-index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAElC,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,KAA0C,EAC1C,KAA6B;IAE7B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CACtB,KAAK,CACH,KAAK,EACL,KAAK,EACL,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAClB,CACF,CAAA;IAED,OAAO,KAAK,KAAK,KAAK,CAAC,MAAM;QACxB,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAClB,CAAC,CAAC,KAAK,CAAA;AACd,CAAC"}

package/lib/number/remap-to-item.d.ts

@@ -0,0 +1,2 @@
+import { NonEmptyArray } from 'justypes';
+export declare function remapToItem<T>(value: number, range: readonly [min: number, max: number], items: NonEmptyArray<T>): T;

package/lib/number/remap-to-item.js

@@ -0,0 +1,6 @@
+import { remapToIndex } from './remap-to-index.js';
+export function remapToItem(value, range, items) {
+    const index = remapToIndex(value, range, items);
+    return items[index];
+}
+//# sourceMappingURL=remap-to-item.js.map

package/lib/number/remap-to-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remap-to-item.js","sourceRoot":"","sources":["../../src/number/remap-to-item.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAElD,MAAM,UAAU,WAAW,CACzB,KAAa,EACb,KAA0C,EAC1C,KAAuB;IAEvB,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;IAC/C,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,CAAC"}

package/lib/number/remap-to-weighted-index.d.ts

@@ -0,0 +1,2 @@
+import { NonEmptyArray } from 'justypes';
+export declare function remapToWeightedIndex(value: number, range: readonly [min: number, max: number], weights: NonEmptyArray<number>): number;

package/lib/number/remap-to-weighted-index.js

@@ -0,0 +1,25 @@
+import { remap } from './remap.js';
+import { remapToIndex } from './remap-to-index.js';
+export function remapToWeightedIndex(value, range, weights) {
+    const newRangeMax = weights.reduce((acc, cur) => acc + Math.max(cur, 0));
+    if (newRangeMax === 0) {
+        return remapToIndex(value, range, weights);
+    }
+    else {
+        const newValue = remap(value, range, [0, newRangeMax]);
+        let remains = newRangeMax;
+        for (let i = weights.length; i--;) {
+            const weight = weights[i];
+            if (weight <= 0) {
+                continue;
+            }
+            else {
+                remains -= weight;
+                if (newValue >= remains)
+                    return i;
+            }
+        }
+        throw new Error('Impossible route');
+    }
+}
+//# sourceMappingURL=remap-to-weighted-index.js.map

package/lib/number/remap-to-weighted-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remap-to-weighted-index.js","sourceRoot":"","sources":["../../src/number/remap-to-weighted-index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAElD,MAAM,UAAU,oBAAoB,CAClC,KAAa,EACb,KAA0C,EAC1C,OAA8B;IAE9B,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;IAExE,IAAI,WAAW,KAAK,CAAC,EAAE;QAErB,OAAO,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;KAC3C;SAAM;QACL,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAA;QAEtD,IAAI,OAAO,GAAG,WAAW,CAAA;QACzB,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG;YACjC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;YACzB,IAAI,MAAM,IAAI,CAAC,EAAE;gBACf,SAAQ;aACT;iBAAM;gBACL,OAAO,IAAI,MAAM,CAAA;gBACjB,IAAI,QAAQ,IAAI,OAAO;oBAAE,OAAO,CAAC,CAAA;aAClC;SACF;QAED,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;KACpC;AACH,CAAC"}

package/lib/number/remap-to-weighted-item.d.ts

@@ -0,0 +1,6 @@
+import { NonEmptyArray } from 'justypes';
+export interface IWeightedItem {
+    weight: number;
+}
+export declare function remapToWeightedItem<T>(value: number, range: readonly [min: number, max: number], items: NonEmptyArray<T>, weights: NonEmptyArray<number>): T;
+export declare function remapToWeightedItem<T extends IWeightedItem>(value: number, range: readonly [min: number, max: number], items: NonEmptyArray<T>): T;

package/lib/number/remap-to-weighted-item.js

@@ -0,0 +1,17 @@
+import { remapToWeightedIndex } from './remap-to-weighted-index.js';
+export function remapToWeightedItem(...args) {
+    let value;
+    let range;
+    let items;
+    let weights;
+    if (args.length === 3) {
+        [value, range, items] = args;
+        weights = items.map(item => item.weight);
+    }
+    else {
+        [value, range, items, weights] = args;
+    }
+    const index = remapToWeightedIndex(value, range, weights);
+    return items[index];
+}
+//# sourceMappingURL=remap-to-weighted-item.js.map

package/lib/number/remap-to-weighted-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remap-to-weighted-item.js","sourceRoot":"","sources":["../../src/number/remap-to-weighted-item.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAiBnE,MAAM,UAAU,mBAAmB,CAA0B,GAAG,IAW7D;IAED,IAAI,KAAa,CAAA;IACjB,IAAI,KAA0C,CAAA;IAC9C,IAAI,KAAuB,CAAA;IAC3B,IAAI,OAA8B,CAAA;IAElC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,CAAA;QAC5B,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAA0B,CAAA;KAClE;SAAM;QACL,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KACtC;IAED,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACzD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;AACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-utils",
-  "version": "5.14.0",
+  "version": "5.16.0",
   "description": "Utilities for JavaScript and Typescript",
   "files": [
     "src",

package/src/number/index.ts

@@ -5,4 +5,8 @@ export * from './is-nan.js'
 export * from './is-number.js'
 export * from './clamp.js'
 export * from './remap.js'
+export * from './remap-to-item.js'
+export * from './remap-to-weighted-item.js'
+export * from './remap-to-index.js'
+export * from './remap-to-weighted-index.js'
 export * from './lerp.js'

package/src/number/remap-to-index.ts

@@ -0,0 +1,20 @@
+import { NonEmptyArray } from 'justypes'
+import { remap } from './remap.js'
+
+export function remapToIndex(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<unknown>
+): number {
+  const index = Math.floor(
+    remap(
+      value
+    , range
+    , [0, items.length]
+    )
+  )
+
+  return index === items.length
+       ? items.length - 1
+       : index
+}

package/src/number/remap-to-item.ts

@@ -0,0 +1,11 @@
+import { NonEmptyArray } from 'justypes'
+import { remapToIndex } from './remap-to-index.js'
+
+export function remapToItem<T>(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<T>
+): T {
+  const index = remapToIndex(value, range, items)
+  return items[index]
+}

package/src/number/remap-to-weighted-index.ts

@@ -0,0 +1,31 @@
+import { NonEmptyArray } from 'justypes'
+import { remap } from './remap.js'
+import { remapToIndex } from './remap-to-index.js'
+
+export function remapToWeightedIndex(
+  value: number
+, range: readonly [min: number, max: number]
+, weights: NonEmptyArray<number>
+): number {
+  const newRangeMax = weights.reduce((acc, cur) => acc + Math.max(cur, 0))
+
+  if (newRangeMax === 0) {
+    // 只有在所有权重都小于等于0的情况下会进入此路径, 所有权重此时都被视为1.
+    return remapToIndex(value, range, weights)
+  } else {
+    const newValue = remap(value, range, [0, newRangeMax])
+
+    let remains = newRangeMax
+    for (let i = weights.length; i--;) {
+      const weight = weights[i]
+      if (weight <= 0) {
+        continue
+      } else {
+        remains -= weight
+        if (newValue >= remains) return i
+      }
+    }
+
+    throw new Error('Impossible route')
+  }
+}

package/src/number/remap-to-weighted-item.ts

@@ -0,0 +1,46 @@
+import { NonEmptyArray } from 'justypes'
+import { remapToWeightedIndex } from './remap-to-weighted-index.js'
+
+export interface IWeightedItem {
+  weight: number
+}
+
+export function remapToWeightedItem<T>(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<T>
+, weights: NonEmptyArray<number>
+): T
+export function remapToWeightedItem<T extends IWeightedItem>(
+  value: number
+, range: readonly [min: number, max: number]
+, items: NonEmptyArray<T>
+): T
+export function remapToWeightedItem<T extends IWeightedItem>(...args:
+| [
+    value: number
+  , range: readonly [min: number, max: number]
+  , items: NonEmptyArray<T>
+  , weights: NonEmptyArray<number>
+  ]
+| [
+    value: number
+  , range: readonly [min: number, max: number]
+  , items: NonEmptyArray<T>
+  ]
+): T {
+  let value: number
+  let range: readonly [min: number, max: number]
+  let items: NonEmptyArray<T>
+  let weights: NonEmptyArray<number>
+
+  if (args.length === 3) {
+    [value, range, items] = args
+    weights = items.map(item => item.weight) as NonEmptyArray<number>
+  } else {
+    [value, range, items, weights] = args
+  }
+
+  const index = remapToWeightedIndex(value, range, weights)
+  return items[index]
+}