Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/heaps

heaps

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Various heap implementations for arbitrary values and with customizable ordering.

Type agnostic binary heap & d-ary heap implementations with customizable ordering and fanout / tree arity (in case of DHeap). Both Heap and DHeap have an identical base API, however the former provides several additional operations.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/heaps
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/heaps?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/heaps/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 1.52 KB / CJS: 1.58 KB / UMD: 1.67 KB

Dependencies

API

Generated API docs

import { Heap, DHeap } from "@thi.ng/heaps";

// with initial values, custom comparator and heap arity
const h = new DHeap<number>(
    [5, 2, 10, 15, 18, 23, 22, -1],
    {
        // custom comparator
        compare: (a, b) => b - a,
        // branch size (DHeap only)
        d: 4
    }
);

h.pop();
// 23
h.pop();
// 22

// insert new value unless it's a new root
// else pop and return current root
h.pushPop(16)
// 18

h.push(24);

Authors

Karsten Schmidt

License

© 2017 - 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc