@thi.ng/geom-hull

@thi.ng/geom-hull

npm versionnpm downloads Mastodon Follow

[!NOTE] This is one of 190 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

About

Fast 2D convex hull (Graham Scan). This is a support package for @thi.ng/geom.

Current implementation is partially based on Clojure version of thi.ng/geom.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/geom-hull

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/geom-hull"></script>

Skypack documentation

For Node.js REPL:

const geomHull = await import("@thi.ng/geom-hull");

Package sizes (brotli'd, pre-treeshake): ESM: 414 bytes

Dependencies

Usage examples

One project in this repo's /examples directory is using this package:

ScreenshotDescriptionLive demoSource
Convex hull & shape clipping of 2D polygonsDemoSource

API

Generated API docs

import { grahamScan2 } from "@thi.ng/geom-hull";

grahamScan2([[0, 0], [50, 10], [100, 0], [80, 50], [100, 100], [50, 90], [0, 100]]);
// [ [ 0, 0 ], [ 100, 0 ], [ 100, 100 ], [ 0, 100 ] ]

Authors

If this project contributes to an academic publication, please cite it as:

@misc{thing-geom-hull,
title = "@thi.ng/geom-hull",
author = "Karsten Schmidt",
note = "https://thi.ng/geom-hull",
year = 2013
}

License

© 2013 - 2024 Karsten Schmidt // Apache License 2.0

Generated using TypeDoc