Skip to content

Commit

Permalink
Doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
urschrei committed Nov 2, 2024
1 parent 9ff5b34 commit 79290f4
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion geo/src/algorithm/bool_ops/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ use rstar::{ParentNode, RTree, RTreeNode, RTreeObject};
/// In particular, taking `union` with an empty geom should remove degeneracies
/// and fix invalid polygons as long the interior-exterior requirement above is
/// satisfied.
///
/// # Performance
///
/// For union operations on a collection of overlapping and / or adjacent [`Polygon`]s
/// (e.g. contained in a `Vec` or a [`MultiPolygon`]), using [`UnaryUnion`] will
/// yield far better performance.
pub trait BooleanOps {
type Scalar: BoolOpsNum;

Expand Down Expand Up @@ -126,7 +132,7 @@ pub enum OpType {
Xor,
}

/// Returns the [BooleanOps::union] of all contained geometries
/// Efficient [BooleanOps::union] of adjacent / overlapping geometries
///
/// For geometries with a high degree of overlap or adjacency
/// (for instance, merging a large contiguous area made up of many adjacent polygons)
Expand Down

0 comments on commit 79290f4

Please sign in to comment.