tree-multimap-typed/dist/data-structures/priority-queue/max-priority-queue.js

Tree Multimap

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.MaxPriorityQueue = void 0;
const priority_queue_1 = require("./priority-queue");
/**
 * Max-oriented priority queue (max-heap) built on {@link PriorityQueue}.
 * The default comparator orders primitive values in descending order. If you store objects,
 * you must provide a custom comparator via {@link PriorityQueueOptions}.
 * @template E Element type stored in the queue.
 * @template R Extra record/metadata associated with each element.
 * @example
 */
class MaxPriorityQueue extends priority_queue_1.PriorityQueue {
    /**
     * Creates a max-priority queue.
     * @param elements Optional initial elements to insert.
     * @param options Optional configuration (e.g., `comparator`, `toElementFn`).
     * @throws {TypeError} Thrown when using the default comparator with object elements (provide a custom comparator).
     * @remarks Complexity — Time: O(n log n) when inserting n elements incrementally; Space: O(n).
     */
    constructor(elements = [], options) {
        super(elements, Object.assign({ comparator: (a, b) => {
                if (typeof a === 'object' || typeof b === 'object') {
                    throw TypeError(`When comparing object types, a custom comparator must be defined in the constructor's options parameter.`);
                }
                if (a < b)
                    return 1;
                if (a > b)
                    return -1;
                return 0;
            } }, options));
    }
}
exports.MaxPriorityQueue = MaxPriorityQueue;