@genome-spy/core 0.61.1 → 0.62.1

package/dist/src/utils/topK.js

@@ -1,64 +1,34 @@
 import FlatQueue from "flatqueue";
 
 /**
- * Finds the top k
- *
- * Based on ideas at https://lemire.me/blog/2017/06/21/top-speed-for-top-k-queries/
+ * Finds the top k elements in a slice of the data array, using a priority accessor.
  *
  * @param {T[]} data
  * @param {number} k
  * @param {(datum: T) => number} priorityAccessor
- * @template T
- */
-export function topK(data, k, priorityAccessor) {
-    /** @type {FlatQueue<number>} */
-    const queue = new FlatQueue();
-
-    let i;
-    for (i = 0; i < k && i < data.length; i++) {
-        queue.push(i, priorityAccessor(data[i]));
-    }
-
-    for (; i < data.length; i++) {
-        const p = priorityAccessor(data[i]);
-        if (p >= queue.peekValue()) {
-            queue.push(i, p);
-            queue.pop();
-        }
-    }
-
-    const result = [];
-
-    let index;
-    while ((index = queue.pop()) !== undefined) {
-        result.push(data[index]);
-    }
-
-    return result.reverse();
-}
-
-/**
- * Takes an array of priorities and returns the top k indices from the
- * specified slice
- *
- * @param {number[]} priorities An array of priorities
- * @param {number} k
  * @param {number} [start] Default: 0
- * @param {number} [end] Exclusive. Default: priorities.length
+ * @param {number} [end] Exclusive. Default: data.length
+ * @template T
+ * @returns {T[]}
  */
-export function topKSlice(priorities, k, start = 0, end = priorities.length) {
+export function topK(
+    data,
+    k,
+    priorityAccessor = (x) => +x,
+    start = 0,
+    end = data.length
+) {
     /** @type {FlatQueue<number>} */
     const queue = new FlatQueue();
-
     const sliceLength = end - start;
 
     let i;
     for (i = 0; i < k && i < sliceLength; i++) {
-        queue.push(i, priorities[start + i]);
+        queue.push(i, priorityAccessor(data[start + i]));
     }
 
     for (; i < sliceLength; i++) {
-        const p = priorities[start + i];
+        const p = priorityAccessor(data[start + i]);
         if (p >= queue.peekValue()) {
             queue.push(i, p);
             queue.pop();
@@ -66,10 +36,9 @@ export function topKSlice(priorities, k, start = 0, end = priorities.length) {
     }
 
     const result = [];
-
     let index;
     while ((index = queue.pop()) !== undefined) {
-        result.push(start + index);
+        result.push(data[start + index]);
     }
 
     return result.reverse();

package/dist/src/utils/topK.test.js

@@ -1,6 +1,5 @@
 import { expect, test } from "vitest";
-import { range } from "d3-array";
-import { topK, topKSlice } from "./topK.js";
+import { topK } from "./topK.js";
 
 test("topK returns top k numbers in priority order", () => {
     /** @param {number} x */
@@ -16,49 +15,40 @@ test("topK returns top k numbers in priority order", () => {
     expect(topK([1, 1, 1], 3, priorityAccessor)).toEqual([1, 1, 1]);
 });
 
-test("topK returns top k objects in priority order", () => {
-    /** @param {{priority: number}} d */
-    const priorityAccessor = (d) => d.priority;
+test("topK returns top k objects in priority order within a start-end range", () => {
+    const arr = [0, 9, 1, 8, 2, 7, 3, 6, 4, 5].map((x) => ({ priority: x }));
+    const priorityAccessor = (/** @type {{priority: number}} */ d) =>
+        d.priority;
 
-    expect(
-        topK(
-            [0, 9, 1, 8, 2, 7, 3, 6, 4, 5].map((x) => ({ priority: x })),
-            3,
-            priorityAccessor
-        )
-    ).toEqual([9, 8, 7].map((x) => ({ priority: x })));
-});
-
-test("topK returns top k objects in priority order with large datasets", () => {
-    /** @param {number} x */
-    const priorityAccessor = (x) => x;
+    // Range: indices 2 to 8 (1,8,2,7,3,6)
+    expect(topK(arr, 2, priorityAccessor, 2, 8)).toEqual([
+        { priority: 8 },
+        { priority: 7 },
+    ]);
 
-    const n = 10000;
-    const bigArray = range(n).map((x) => Math.floor(Math.random() * 100));
-    const sortedBigArray = bigArray.slice().sort((a, b) => b - a);
+    // Range: indices 4 to 10 (2,7,3,6,4,5)
+    expect(topK(arr, 3, priorityAccessor, 4, 10)).toEqual([
+        { priority: 7 },
+        { priority: 6 },
+        { priority: 5 },
+    ]);
 
-    for (let k = 0; k < 13000; k += 1000) {
-        expect(topK(bigArray, k, priorityAccessor)).toEqual(
-            sortedBigArray.slice(0, k)
-        );
-    }
+    // Range: indices 0 to 3 (0,9,1)
+    expect(topK(arr, 2, priorityAccessor, 0, 3)).toEqual([
+        { priority: 9 },
+        { priority: 1 },
+    ]);
 });
 
-test("topKSlice returns top k indexes in priority order", () => {
-    expect(topKSlice([0, 1, 2], 3)).toEqual([2, 1, 0]);
-    expect(topKSlice([1, 2, 3], 3)).toEqual([2, 1, 0]);
-    expect(topKSlice([0, 1, 2], 1)).toEqual([2]);
-    expect(topKSlice([0, 1, 2], 6)).toEqual([2, 1, 0]);
-    expect(topKSlice([0, 1, 2, 3, 4, 5], 3)).toEqual([5, 4, 3]);
-    expect(topKSlice([0, 9, 1, 8, 2, 7, 3, 6, 4, 5], 3)).toEqual([1, 3, 5]);
-    expect(new Set(topKSlice([1, 1, 1, 2, 2, 2], 3))).toEqual(
-        new Set([3, 4, 5])
-    );
+test("topK returns empty array if start >= end", () => {
+    const arr = [1, 2, 3, 4, 5];
+    expect(topK(arr, 3, (x) => x, 4, 4)).toEqual([]);
+    expect(topK(arr, 3, (x) => x, 5, 5)).toEqual([]);
+    expect(topK(arr, 3, (x) => x, 6, 6)).toEqual([]);
 });
 
-test("topKSlice returns top k indexes from a slice in priority order", () => {
-    expect(topKSlice([0, 1, 2, 3, 4, 5], 2, 1, 5)).toEqual([4, 3]);
-    expect(topKSlice([0, 9, 1, 8, 2, 7, 3, 6, 4, 5], 3, 1, 5)).toEqual([
-        1, 3, 4,
-    ]);
+test("topK works with negative and zero priorities in a range", () => {
+    const arr = [-10, 0, 5, -2, 3, 0, -1];
+    expect(topK(arr, 2, (x) => x, 1, 6)).toEqual([5, 3]);
+    expect(topK(arr, 3, (x) => x, 0, 4)).toEqual([5, 0, -2]);
 });

package/package.json

@@ -7,7 +7,7 @@
   },
   "contributors": [],
   "license": "MIT",
-  "version": "0.61.1",
+  "version": "0.62.1",
   "jsdelivr": "dist/bundle/index.js",
   "unpkg": "dist/bundle/index.js",
   "browser": "dist/bundle/index.js",
@@ -67,5 +67,5 @@
   "devDependencies": {
     "@types/long": "^4.0.1"
   },
-  "gitHead": "092749ef334a80ee3434147f7bd2fdc09c0ede84"
+  "gitHead": "6224d0b26562632acb3f2b402362a8e2963246cc"
 }