polyops 0.0.5

Martinez-Rueda polygon clipping algorithm: Boolean operations (intersection, union, difference, xor) over polygons and multipolygons. Rust port of martinez-polygon-clipping.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# PolyOps

Fast polygon Boolean operations in Rust, with first-class Node.js bindings.

PolyOps is a faithful port of [`martinez-polygon-clipping`](https://github.com/w8r/martinez)
(Alex Milevski's JavaScript implementation of the Martinez-Rueda-Feito algorithm)
into idiomatic Rust, with a [`napi-rs`](https://napi.rs) wrapper so the same
engine can be consumed from Node.js without giving up native performance.

> **Status:** published. `polyops` 0.0.4 is on
> [crates.io](https://crates.io/crates/polyops) and
> [npm](https://www.npmjs.com/package/polyops) (prebuilt binaries for macOS,
> Linux gnu/musl, and Windows), with full behavioral parity against
> `martinez-polygon-clipping@0.8.1` over the upstream fixture corpus. The API
> is still `0.0.x` and may change before `0.1`.

## Operations

```
intersection(subject, clipping)
union       (subject, clipping)
difference  (subject, clipping)
xor         (subject, clipping)
```

All four operate on GeoJSON-shaped `Polygon` or `MultiPolygon` coordinate
arrays, matching the upstream JS API.

## Packages

| Registry   | Name              | Source                  |
|------------|-------------------|-------------------------|
| crates.io  | `polyops`         | `crates/polyops`        |
| npm        | `polyops`         | `crates/polyops-napi`   |

## Performance

`polyops` (Rust, single-thread) runs the upstream `union` benchmarks
**~1.8×–2.9× faster** than `martinez-polygon-clipping@0.8.1`. The Node binding
routes coordinates through typed-array buffers **by default** (only flat data
crosses the N-API boundary), so it's **faster than martinez at every size** —
~1.9× on a small clip-path intersection, ~2–2.6× on large unions — with the
same drop-in, GeoJSON-shaped API:

```js
const polyops = require('polyops'); // drop-in martinez-compatible API, fast by default
polyops.union(subjectCoords, clippingCoords);
```

For pipelines that keep geometry in buffer form, `pack`/`unpack` and the raw
`*Flat` ops are also exported (skip repacking across calls). Full numbers +
methodology in [`BENCHMARKS.md`](BENCHMARKS.md).

## Layout

```
PolyOps/
├── crates/
│   ├── polyops/          pure-Rust crate (algorithm, types, tests)
│   └── polyops-napi/     napi-rs binding, published to npm
├── parity/               Node harness: runs martinez-polygon-clipping@0.8.1
│                         against all upstream fixtures, emits goldens
└── .github/workflows/    CI: cargo test + parity tests
```

## Development

```bash
cargo test          # runs unit + parity tests
cargo bench         # runs benchmarks
cargo clippy        # lints
cargo fmt --check
```

To regenerate the parity goldens against the latest upstream:

```bash
cd parity
npm install
npm run generate
```

## License

MIT. See [`LICENSE`](LICENSE). Credit to Alexander Milevski for the JS
reference implementation and to Martinez/Rueda/Feito for the algorithm.