geom-hull

Note

This is one of 199 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
• Status
• Installation
• Dependencies
• Usage examples
• API
• Authors
• License

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

ESM import:

import * as hull from "@thi.ng/geom-hull";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/geom-hull"></script>

JSDelivr documentation

For Node.js REPL:

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

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

Dependencies

• @thi.ng/math
• @thi.ng/vectors

Usage examples

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

Screenshot	Description	Live demo	Source
	Convex hull & shape clipping of 2D polygons	Demo	Source

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

• Karsten Schmidt

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