@genome-spy/core 0.29.0 → 0.30.2

package/src/utils/iterateNestedMaps.js

@@ -1,21 +0,0 @@
-/**
- * Iterates a nested Map structure created by d3-array's group() function.
- *
- * Yields arrays that contain the compound key and the grouped data items.
- *
- * @param {Map<any, any>} map The root
- * @param {any[]} [path] The path so far.
- * @returns {Generator<[any[], any[]]>}
- */
-export default function* iterateNestedMaps(map, path = []) {
-    for (const [key, value] of map.entries()) {
-        if (value instanceof Map) {
-            for (const m of iterateNestedMaps(value, [...path, key])) {
-                yield m;
-            }
-        } else {
-            // TODO: Could recycle compound key arrays for better performance
-            yield [[...path, key], value];
-        }
-    }
-}

package/src/utils/iterateNestedMaps.test.js

@@ -1,33 +0,0 @@
-import { expect, test } from "vitest";
-import { group } from "d3-array";
-import iterateNestedMaps from "./iterateNestedMaps";
-
-const data = [
-    { name: "jim", amount: "34.0", date: "11/12/2015" },
-    { name: "carl", amount: "120.11", date: "11/12/2015" },
-    { name: "stacy", amount: "12.01", date: "01/04/2016" },
-    { name: "stacy", amount: "34.05", date: "01/04/2016" },
-    { name: "stacy", amount: "1.5", date: "02/04/2016" },
-];
-
-const groups = group(
-    data,
-    (d) => d.name,
-    (d) => d.date
-);
-
-test("iterateNestedMaps iterates correctly", () => {
-    const expected = [
-        [["jim", "11/12/2015"], [data[0]]],
-        [["carl", "11/12/2015"], [data[1]]],
-        [
-            ["stacy", "01/04/2016"],
-            [data[2], data[3]],
-        ],
-        [["stacy", "02/04/2016"], [data[4]]],
-    ];
-
-    const result = [...iterateNestedMaps(groups)];
-
-    expect(result).toEqual(expected);
-});

package/src/utils/kWayMerge.js

@@ -1,42 +0,0 @@
-import FlatQueue from "flatqueue";
-
-/**
- * Returns an iterator that merges multiple sorted arrays.
- *
- * @param {T[][]} arrays
- * @param {function(T):number} [accessor]
- * @template T
- */
-export default function* kWayMerge(arrays, accessor = (x) => +x) {
-    // https://www.wikiwand.com/en/K-way_merge_algorithm
-
-    // This could be optimized by implementing a tournament tree or
-    // by adding replaceTop to the Heap.
-    // https://docs.python.org/2/library/heapq.html#heapq.heapreplace
-
-    const k = arrays.length;
-
-    const heap = new FlatQueue();
-    const pointers = new Array(k).fill(0);
-
-    for (const [i, array] of arrays.entries()) {
-        if (array.length) {
-            heap.push(i, accessor(array[0]));
-        }
-    }
-
-    let i = 0;
-    while ((i = heap.pop()) !== undefined) {
-        const array = arrays[i];
-        let pointer = pointers[i];
-        const element = array[pointer++];
-
-        yield element;
-
-        if (pointer < array.length) {
-            const newValue = accessor(array[pointer]);
-            heap.push(i, newValue);
-            pointers[i] = pointer;
-        }
-    }
-}

package/src/utils/kWayMerge.test.js

@@ -1,26 +0,0 @@
-import { expect, test } from "vitest";
-import kWayMerge from "./kWayMerge";
-
-test("k-way merge merges multiple sorted arrays", () => {
-    /** @type {{a: number}[][]} */
-    const arrays = [];
-
-    for (let a = 0; a < 20; a++) {
-        /** @type {{a: number}[]} */
-        const array = [];
-        arrays.push(array);
-
-        let x = 0;
-        for (let i = 0; i < a; i++) {
-            x += Math.floor(Math.random() * 10);
-            array.push({ a: x });
-        }
-    }
-
-    const sorted = arrays.flat().sort((a, b) => a.a - b.a);
-
-    /** @type {function(any):number} */
-    const accessor = (d) => d.a;
-
-    expect([...kWayMerge(arrays, accessor)]).toEqual(sorted);
-});

package/src/utils/layout/flexLayout.js

@@ -1,368 +0,0 @@
-import { isNumber } from "vega-util";
-import { isStepSize } from "../../view/view";
-
-/**
- *
- * Layout calculation inspired by flexbox. The elements may have an
- * absolute size (in pixels) and a growth component for filling the
- * remaining space. Spacing around zero-sized items are collapsed.
- *
- * Read more at https://css-tricks.com/flex-grow-is-weird/
- *
- * @typedef {object} SizeDef Size definition inspired by CSS flexbox
- * @prop {number} [px] Size in pixels
- * @prop {number} [grow] Share of remaining space
- *
- * @typedef {object} LocSize One-dimensional location and size
- * @prop {number} location
- * @prop {number} size
- *
- * @typedef {object} FlexOptions
- * @prop {number} [spacing] gap between items in pixels
- * @prop {number} [devicePixelRatio] allows for snapping to "retina" pixels.
- *      Default: `undefined`, which disables the snapping.
- * @prop {number} [offset] add the offset to all locations. Default: `0`.
- * @prop {boolean} [reverse] fill from "right to left".
- *
- * @param {SizeDef[]} items
- * @param {number} containerSize in pixels
- * @param {FlexOptions} [options]
- * @returns {LocSize[]}
- */
-export function mapToPixelCoords(
-    items,
-    containerSize,
-    { spacing, devicePixelRatio, offset, reverse } = {}
-) {
-    spacing = spacing || 0;
-    offset = offset || 0;
-
-    let totalPx = 0;
-    let totalGrow = 0;
-
-    for (const size of items) {
-        totalPx += z(size.px) + (isZeroSizeDef(size) ? 0 : spacing);
-        totalGrow += z(size.grow);
-    }
-    totalPx -= spacing;
-
-    const remainingSpace = Math.max(0, containerSize - totalPx);
-
-    /** @type {function(number):number} x */
-    const round =
-        devicePixelRatio !== undefined
-            ? (x) => Math.round(x * devicePixelRatio) / devicePixelRatio
-            : (x) => x;
-
-    /**
-     * Buffer zero-sized items so that their locations can be spread evenly.
-     * They can then be interpolated nicely.
-     * @type {SizeDef[]}
-     */
-    const zeroBuffer = [];
-
-    /** @type {LocSize[]} */
-    const results = [];
-
-    /**
-     * Spread evenly
-     *
-     * @param {boolean} inMiddle
-     */
-    const flushZeroBuffer = (inMiddle) => {
-        const n = zeroBuffer.length;
-        if (!n) {
-            return;
-        }
-
-        const s = (inMiddle ? spacing : 0) * (reverse ? -1 : 1);
-
-        x -= s;
-        for (let i = 0; i < n; i++) {
-            results.push({
-                location: x + ((i + 1) / (n + 1)) * s,
-                size: 0,
-            });
-        }
-        x += s;
-
-        zeroBuffer.length = 0;
-    };
-
-    let x = reverse ? Math.max(containerSize, totalPx) : 0 + offset;
-
-    // Handle a special case
-    if (items.length == 1 && isZeroSizeDef(items[0])) {
-        return [{ location: x, size: 0 }];
-    }
-
-    for (let i = 0; i < items.length; i++) {
-        const size = items[i];
-
-        if (isZeroSizeDef(size)) {
-            zeroBuffer.push(size);
-        } else {
-            flushZeroBuffer(results.length > 0);
-
-            const advance =
-                z(size.px) +
-                (totalGrow ? (z(size.grow) / totalGrow) * remainingSpace : 0);
-
-            if (reverse) {
-                x -= advance;
-            }
-
-            results.push({ location: round(x), size: round(advance) });
-
-            if (!reverse) {
-                x += advance + spacing;
-            } else {
-                x -= spacing;
-            }
-        }
-    }
-
-    // Remove the last gap
-    x += reverse ? spacing : -spacing;
-
-    flushZeroBuffer(false);
-
-    return results;
-}
-
-/**
- * Returns the minimum size  (the sum of pixels sizes) for the flex items
- *
- * @param {Iterable<SizeDef>} items
- * @param {FlexOptions} [options]
- */
-export function getMinimumSize(items, { spacing } = { spacing: 0 }) {
-    let minimumSize = 0;
-    for (const size of items) {
-        minimumSize += z(size.px) + (isZeroSizeDef(size) ? 0 : spacing);
-    }
-    return Math.max(0, minimumSize - spacing);
-}
-
-/**
- * @param {Iterable<SizeDef>} items
- * @returns {SizeDef}
- */
-export function getLargestSize(items) {
-    let px = 0;
-    let grow = 0;
-    for (const s of items) {
-        px = Math.max(px, s.px ?? 0);
-        grow = Math.max(grow, s.grow ?? 0);
-    }
-
-    return { px, grow };
-}
-
-/**
- * Returns true if relative (stretching) elements are present
- * @param {SizeDef[]} items
- */
-export function isStretching(items) {
-    return items.some((size) => size.grow);
-}
-
-export class FlexDimensions {
-    /**
-     *
-     * @param {SizeDef} width
-     * @param {SizeDef} height
-     */
-    constructor(width, height) {
-        // TODO: Consider making immutable
-        /** @readonly */
-        this.width = width;
-        /** @readonly */
-        this.height = height;
-    }
-
-    /**
-     * Adds padding to absolute (px) dimensions
-     *
-     * @param {import("./padding").default} padding
-     */
-    addPadding(padding) {
-        return this.#addPx(padding.width, padding.height);
-    }
-
-    /**
-     * Subtracts padding from absolute (px) dimensions
-     *
-     * @param {import("./padding").default} padding
-     */
-    subtractPadding(padding) {
-        return this.#addPx(-padding.width, -padding.height);
-    }
-
-    /**
-     * @param {number} width
-     * @param {number} height
-     */
-    #addPx(width, height) {
-        return new FlexDimensions(
-            {
-                px: (this.width.px ?? 0) + width,
-                grow: this.width.grow,
-            },
-            {
-                px: (this.height.px ?? 0) + height,
-                grow: this.height.grow,
-            }
-        );
-    }
-}
-
-/**
- * A sizedef that takes no space at all.
- *
- * @type {SizeDef}
- */
-export const ZERO_SIZEDEF = Object.freeze({
-    px: 0,
-    grow: 0,
-});
-
-export const ZERO_FLEXDIMENSIONS = new FlexDimensions(
-    ZERO_SIZEDEF,
-    ZERO_SIZEDEF
-);
-
-/**
- * Is the sizeDef taking no space at all
- *
- * @param {SizeDef} sizeDef
- */
-export function isZeroSizeDef(sizeDef) {
-    return !sizeDef.px && !sizeDef.grow;
-}
-
-/**
- * Converts undefined/null to zero
- *
- * @param {number} value
- */
-function z(value) {
-    return value || 0;
-}
-
-/**
- *
- * @param {*} spec
- * @returns {spec is SizeDef}
- */
-export function isSizeDef(spec) {
-    return spec && (isNumber(spec.px) || isNumber(spec.grow));
-}
-
-/**
- *
- * @param {"container" | number | SizeDef | import("../../spec/view").Step} size
- * @returns {SizeDef}
- */
-export function parseSizeDef(size) {
-    if (isStepSize(size)) {
-        throw new Error("parseSizeDef does not accept step-based sizes.");
-    } else if (isSizeDef(size)) {
-        return size;
-    } else if (isNumber(size)) {
-        return { px: size, grow: 0 };
-    } else if (size === "container") {
-        // https://vega.github.io/vega-lite/docs/size.html#specifying-responsive-width-and-height
-        return { px: 0, grow: 1 };
-    } else if (!size) {
-        return { px: 0, grow: 1 };
-    }
-
-    throw new Error(`Invalid sizeDef: ${size}`);
-}
-
-// TODO: Find a better place for the following utilities: ////////////////////////////////////
-
-/**
- * Interpolates between two LocSizes
- *
- * @param {LocSize} from
- * @param {LocSize} to
- * @param {function():number} ratio
- * @returns {LocSize}
- */
-export function interpolateLocSizes(from, to, ratio) {
-    return {
-        get location() {
-            const r = ratio();
-            switch (r) {
-                case 0:
-                    return from.location;
-                case 1:
-                    return to.location;
-                default:
-                    return r * to.location + (1 - r) * from.location;
-            }
-        },
-
-        get size() {
-            const r = ratio();
-            switch (r) {
-                case 0:
-                    return from.size;
-                case 1:
-                    return to.size;
-                default:
-                    return r * to.size + (1 - r) * from.size;
-            }
-        },
-    };
-}
-
-/**
- * Wraps a LocSize and allows scrolling.
- *
- * @param {LocSize} locSize
- * @param {number | function():number} offset
- * @returns {LocSize}
- */
-export function translateLocSize(locSize, offset) {
-    const fn = isNumber(offset) ? () => offset : offset;
-    return {
-        get location() {
-            return locSize.location + fn();
-        },
-
-        get size() {
-            return locSize.size;
-        },
-    };
-}
-
-/**
- * Wraps a LocSize and allows scaling.
- *
- * @param {LocSize} locSize
- * @param {number | function():number} factor
- * @returns {LocSize}
- */
-export function scaleLocSize(locSize, factor) {
-    const fn = isNumber(factor) ? () => factor : factor;
-    return {
-        get location() {
-            return locSize.location * fn();
-        },
-
-        get size() {
-            return locSize.size * fn();
-        },
-    };
-}
-
-/**
- * @param {LocSize} locSize
- * @param {number} value
- */
-export function locSizeEncloses(locSize, value) {
-    return value >= locSize.location && value < locSize.location + locSize.size;
-}