From 6e5b7195b7e05deebcd55f60c503602c55a91bb0 Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Thu, 31 Oct 2024 22:00:58 -0400 Subject: [PATCH 1/3] Allow configuring of the `i_overlay` dep, Rayon transitive dep, and document more features. --- .github/workflows/test.yml | 2 +- geo/Cargo.toml | 5 +++-- geo/src/algorithm/bool_ops/mod.rs | 2 ++ geo/src/algorithm/mod.rs | 8 +++++++- geo/src/algorithm/triangulate_earcut.rs | 2 ++ geo/src/lib.rs | 26 ++++++++++++++++++++----- 6 files changed, 36 insertions(+), 9 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ddf68ef018..cdbf06f9b2 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -116,7 +116,7 @@ jobs: uses: actions/checkout@v3 - run: cargo check --all-targets --no-default-features # we don't want to test `proj-network` because it only enables the `proj` feature - - run: cargo test --features "use-proj use-serde" + - run: cargo test --features "use-proj use-serde i_overlay earcutr multithreading" geo_traits: name: geo-traits diff --git a/geo/Cargo.toml b/geo/Cargo.toml index c8cc5f188c..9c29776cee 100644 --- a/geo/Cargo.toml +++ b/geo/Cargo.toml @@ -13,10 +13,11 @@ rust-version = "1.75" categories = ["science::geo"] [features] -default = ["earcutr", "spade"] +default = ["earcutr", "spade", "i_overlay", "multithreading"] use-proj = ["proj"] proj-network = ["use-proj", "proj/network"] use-serde = ["serde", "geo-types/serde"] +multithreading = ["i_overlay/allow_multithreading"] [dependencies] earcutr = { version = "0.4.2", optional = true } @@ -30,7 +31,7 @@ proj = { version = "0.27.0", optional = true } robust = "1.1.0" rstar = "0.12.0" serde = { version = "1.0", optional = true, features = ["derive"] } -i_overlay = "1.7.2" +i_overlay = { version = "1.7.2", optional = true } [dev-dependencies] approx = ">= 0.4.0, < 0.6.0" diff --git a/geo/src/algorithm/bool_ops/mod.rs b/geo/src/algorithm/bool_ops/mod.rs index 16287b049d..aa5abdf02d 100644 --- a/geo/src/algorithm/bool_ops/mod.rs +++ b/geo/src/algorithm/bool_ops/mod.rs @@ -8,6 +8,8 @@ use crate::geometry::{LineString, MultiLineString, MultiPolygon, Polygon}; /// Boolean Operations on geometry. /// +/// Requires the `"i_overlay"` feature, which is enabled by default. +/// /// Boolean operations are set operations on geometries considered as a subset /// of the 2-D plane. The operations supported are: intersection, union, xor or /// symmetric difference, and set-difference on pairs of 2-D geometries and diff --git a/geo/src/algorithm/mod.rs b/geo/src/algorithm/mod.rs index 344084dc3a..b47f1c56df 100644 --- a/geo/src/algorithm/mod.rs +++ b/geo/src/algorithm/mod.rs @@ -6,8 +6,12 @@ pub use kernels::{Kernel, Orientation}; pub mod area; pub use area::Area; -/// Boolean Ops such as union, xor, difference; +/// Boolean Ops such as union, xor, difference. +/// +/// Requires the `"i_overlay"` feature, which is enabled by default. +#[cfg(feature = "i_overlay")] pub mod bool_ops; +#[cfg(feature = "i_overlay")] pub use bool_ops::{BooleanOps, OpType}; /// Calculate the bounding rectangle of a `Geometry`. @@ -254,6 +258,8 @@ pub mod translate; pub use translate::Translate; /// Triangulate polygons using an [ear-cutting algorithm](https://www.geometrictools.com/Documentation/TriangulationByEarClipping.pdf). +/// +/// Requires the `"earcutr"` feature. #[cfg(feature = "earcutr")] pub mod triangulate_earcut; #[cfg(feature = "earcutr")] diff --git a/geo/src/algorithm/triangulate_earcut.rs b/geo/src/algorithm/triangulate_earcut.rs index d4d23df324..586f3cb3dc 100644 --- a/geo/src/algorithm/triangulate_earcut.rs +++ b/geo/src/algorithm/triangulate_earcut.rs @@ -1,6 +1,8 @@ use crate::{coord, CoordFloat, CoordsIter, Polygon, Triangle}; /// Triangulate polygons using an [ear-cutting algorithm](https://www.geometrictools.com/Documentation/TriangulationByEarClipping.pdf). +/// +/// Requires the `"earcutr"` feature, which is enabled by default. pub trait TriangulateEarcut { /// # Examples /// diff --git a/geo/src/lib.rs b/geo/src/lib.rs index 11cf8bc4ae..ff5bdf94a3 100644 --- a/geo/src/lib.rs +++ b/geo/src/lib.rs @@ -67,7 +67,7 @@ //! //! ## Boolean Operations //! -//! - **[`BooleanOps`]**: combine or split (Multi)Polygons using intersecton, union, xor, or difference operations +//! - **[`BooleanOps`]**: combine or split (Multi)Polygons using intersecton, union, xor, or difference operations. Requires the `"i_overlay"` feature, which is enabled by default. //! //! ## Outlier Detection //! @@ -112,7 +112,7 @@ //! //! ## Triangulation //! -//! - **[`TriangulateEarcut`](triangulate_earcut)**: Triangulate polygons using the earcut algorithm (requires the `earcutr` feature). +//! - **[`TriangulateEarcut`](triangulate_earcut)**: Triangulate polygons using the earcut algorithm. Requires the `"earcutr"` feature, which is enabled by default. //! //! ## Winding //! @@ -177,9 +177,25 @@ //! //! The following optional [Cargo features] are available: //! -//! - `proj-network`: Enables [network grid] support for the [`proj` crate]. After enabling this feature, [further configuration][proj crate file download] is required to use the network grid -//! - `use-proj`: Enables coordinate conversion and transformation of `Point` geometries using the [`proj` crate] -//! - `use-serde`: Allows geometry types to be serialized and deserialized with [Serde] +//! - `i_overlay`: +//! - Enables the `i_overlay` crate, which provides boolean operations on geometries. +//! - ☑ Enabled by default. +//! - `earcutr`: +//! - Enables the `earcutr` crate, which provides triangulation of polygons using the earcut algorithm. +//! - ☑ Enabled by default. +//! - `proj-network`: +//! - Enables [network grid] support for the [`proj` crate]. +//! - After enabling this feature, [further configuration][proj crate file download] is required to use the network grid. +//! - ☐ Disabled by default. +//! - `use-proj`: +//! - Enables coordinate conversion and transformation of `Point` geometries using the [`proj` crate] +//! - ☐ Disabled by default. +//! - `use-serde`: +//! - Allows geometry types to be serialized and deserialized with [Serde]. +//! - ☐ Disabled by default. +//! - `multithreading`: +//! - Enables multithreading support for the `i_overlay` crate. +//! - ☑ Enabled by default. //! //! # Ecosystem //! From 6e2303904d3b3470e683f194a8e21cbe3786fa67 Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Fri, 1 Nov 2024 12:21:52 -0400 Subject: [PATCH 2/3] Update Cargo.toml --- geo/Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/geo/Cargo.toml b/geo/Cargo.toml index 9c29776cee..dd6b8ebb04 100644 --- a/geo/Cargo.toml +++ b/geo/Cargo.toml @@ -31,7 +31,7 @@ proj = { version = "0.27.0", optional = true } robust = "1.1.0" rstar = "0.12.0" serde = { version = "1.0", optional = true, features = ["derive"] } -i_overlay = { version = "1.7.2", optional = true } +i_overlay = { version = "1.7.2", optional = true, default-features = false } [dev-dependencies] approx = ">= 0.4.0, < 0.6.0" From c85ed96fec60fd10bd452e49d461c6856c3103b5 Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Fri, 1 Nov 2024 14:54:31 -0400 Subject: [PATCH 3/3] apply changes --- .github/workflows/test.yml | 2 +- geo/Cargo.toml | 4 ++-- geo/src/algorithm/bool_ops/mod.rs | 2 -- geo/src/algorithm/mod.rs | 4 ---- geo/src/lib.rs | 5 +---- 5 files changed, 4 insertions(+), 13 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index cdbf06f9b2..598c60b2c1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -116,7 +116,7 @@ jobs: uses: actions/checkout@v3 - run: cargo check --all-targets --no-default-features # we don't want to test `proj-network` because it only enables the `proj` feature - - run: cargo test --features "use-proj use-serde i_overlay earcutr multithreading" + - run: cargo test --features "use-proj use-serde earcutr multithreading" geo_traits: name: geo-traits diff --git a/geo/Cargo.toml b/geo/Cargo.toml index 9c29776cee..b9a63b2773 100644 --- a/geo/Cargo.toml +++ b/geo/Cargo.toml @@ -13,7 +13,7 @@ rust-version = "1.75" categories = ["science::geo"] [features] -default = ["earcutr", "spade", "i_overlay", "multithreading"] +default = ["earcutr", "spade", "multithreading"] use-proj = ["proj"] proj-network = ["use-proj", "proj/network"] use-serde = ["serde", "geo-types/serde"] @@ -31,7 +31,7 @@ proj = { version = "0.27.0", optional = true } robust = "1.1.0" rstar = "0.12.0" serde = { version = "1.0", optional = true, features = ["derive"] } -i_overlay = { version = "1.7.2", optional = true } +i_overlay = "1.7.2" [dev-dependencies] approx = ">= 0.4.0, < 0.6.0" diff --git a/geo/src/algorithm/bool_ops/mod.rs b/geo/src/algorithm/bool_ops/mod.rs index aa5abdf02d..16287b049d 100644 --- a/geo/src/algorithm/bool_ops/mod.rs +++ b/geo/src/algorithm/bool_ops/mod.rs @@ -8,8 +8,6 @@ use crate::geometry::{LineString, MultiLineString, MultiPolygon, Polygon}; /// Boolean Operations on geometry. /// -/// Requires the `"i_overlay"` feature, which is enabled by default. -/// /// Boolean operations are set operations on geometries considered as a subset /// of the 2-D plane. The operations supported are: intersection, union, xor or /// symmetric difference, and set-difference on pairs of 2-D geometries and diff --git a/geo/src/algorithm/mod.rs b/geo/src/algorithm/mod.rs index b47f1c56df..6f92320cfc 100644 --- a/geo/src/algorithm/mod.rs +++ b/geo/src/algorithm/mod.rs @@ -7,11 +7,7 @@ pub mod area; pub use area::Area; /// Boolean Ops such as union, xor, difference. -/// -/// Requires the `"i_overlay"` feature, which is enabled by default. -#[cfg(feature = "i_overlay")] pub mod bool_ops; -#[cfg(feature = "i_overlay")] pub use bool_ops::{BooleanOps, OpType}; /// Calculate the bounding rectangle of a `Geometry`. diff --git a/geo/src/lib.rs b/geo/src/lib.rs index ff5bdf94a3..88bf61aa85 100644 --- a/geo/src/lib.rs +++ b/geo/src/lib.rs @@ -67,7 +67,7 @@ //! //! ## Boolean Operations //! -//! - **[`BooleanOps`]**: combine or split (Multi)Polygons using intersecton, union, xor, or difference operations. Requires the `"i_overlay"` feature, which is enabled by default. +//! - **[`BooleanOps`]**: combine or split (Multi)Polygons using intersecton, union, xor, or difference operations. //! //! ## Outlier Detection //! @@ -177,9 +177,6 @@ //! //! The following optional [Cargo features] are available: //! -//! - `i_overlay`: -//! - Enables the `i_overlay` crate, which provides boolean operations on geometries. -//! - ☑ Enabled by default. //! - `earcutr`: //! - Enables the `earcutr` crate, which provides triangulation of polygons using the earcut algorithm. //! - ☑ Enabled by default.