Wondering what’s next for npm?Check out our public roadmap! »

    @thi.ng/geom-hull
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.92 • Public • Published

    geom-hull

    npm version npm downloads Twitter Follow

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

    About

    Fast 2D convex hull (Graham Scan).

    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
    <script type="module" src="https://unpkg.com/@thi.ng/geom-hull?module" crossorigin></script>
    
    // UMD
    <script src="https://unpkg.com/@thi.ng/geom-hull/lib/index.umd.js" crossorigin></script>

    Package sizes (gzipped, pre-treeshake): ESM: 433 bytes / CJS: 489 bytes / UMD: 598 bytes

    Dependencies

    Usage examples

    Several demos in this repo's /examples directory are using this package.

    A selection:

    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 - 2021 Karsten Schmidt // Apache Software License 2.0

    Install

    npm i @thi.ng/geom-hull

    DownloadsWeekly Downloads

    43

    Version

    0.0.92

    License

    Apache-2.0

    Unpacked Size

    28.9 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar