geo-polygonize 0.42.0 → 0.44.0

package/README.md

@@ -24,27 +24,37 @@ For an ambitious, prioritized plan covering performance, security, API consisten
 ### Library
 
 ```rust
-use geo_polygonize_core::{polygonize, Coord3D, Line3D};
-use geo_polygonize_core::options::PolygonizerOptions;
+use geo_polygonize_core::{polygonize_line_strings, PolygonizerOptions};
+use geo_types::LineString;
 
 fn main() {
-    let points = [
-        Coord3D::new(0.0, 0.0, 0.0),
-        Coord3D::new(10.0, 0.0, 0.0),
-        Coord3D::new(10.0, 10.0, 0.0),
-        Coord3D::new(0.0, 10.0, 0.0),
-    ];
-    let lines = (0..4).map(|i| Line3D::new(points[i], points[(i + 1) % 4], i as u32));
-
-    let result = polygonize(lines, &PolygonizerOptions::default())
+    let ring = LineString::from(vec![
+        (0.0, 0.0),
+        (10.0, 0.0),
+        (10.0, 10.0),
+        (0.0, 10.0),
+        (0.0, 0.0),
+    ]);
+
+    let result = polygonize_line_strings([&ring], &PolygonizerOptions::default())
         .expect("Polygonization failed");
+    let polygons = result.into_multi_polygon();
 
-    for polygon in result.polygons {
-        println!("Found polygon with area: {}", polygon.unsigned_area_2d());
+    for polygon in polygons {
+        println!("Found polygon: {polygon:?}");
     }
 }
 ```
 
+`polygonize_line_strings` accepts owned or borrowed `geo_traits::LineStringTrait`
+values. Use `polygonize` when source IDs or Z values must be supplied explicitly,
+and keep its full result when dangles, cut edges, invalid rings, or diagnostics are
+needed.
+
+Rust consumers should import the supported facade from the crate root. Graph,
+noding, containment, utility, mutable-builder, and tiled APIs are internal or
+experimental and may change without compatibility guarantees before `1.0`.
+
 ### Choosing noding and precision
 
 Polygonization quality is heavily influenced by input noding strategy.
@@ -149,6 +159,10 @@ The default return shape is a stable dictionary with `polygons` as
 `SimplePolygon` values. Use `return_polygons=True` only when you want Shapely
 `Polygon` objects.
 
+When provenance is enabled, coincident and partially overlapping input lines
+are dissolved into one topology edge while every contributing nonzero
+`line_id` remains in the polygon's sorted `boundary_line_ids`.
+
 `SnapStrategy::Grid` keeps topology and output coordinates on a configured
 fixed precision grid. The CFB profile uses `GeosCompat`: the grid establishes robust
 topology, then output nodes regain deterministic source coordinates to better