expand documation about simplifying polygons w.r.t. validity & topology

georust · Aug 9, 2017 · c6769d0 · c6769d0
1 parent ea61f74
commit c6769d0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/src/algorithm/simplify.rs b/src/algorithm/simplify.rs
@@ -52,7 +52,7 @@ fn rdp<T>(points: &[Point<T>], epsilon: &T) -> Vec<Point<T>>
 /// The [Ramer–Douglas–Peucker
 /// algorithm](https://en.wikipedia.org/wiki/Ramer–Douglas–Peucker_algorithm) simplifes a
 /// linestring. Polygons are simplified by running the RDP algorithm on all their constituant
-/// rings.
+/// rings. This may result in invalid Polygons, and has no guarantee of perserving topology.
 ///
 /// Multi* objects are simplified by simplifing all their constituant geometries individually.
 pub trait Simplify<T, Epsilon = T> {

diff --git a/src/algorithm/simplifyvw.rs b/src/algorithm/simplifyvw.rs
@@ -146,8 +146,9 @@ fn area<T>(p1: &Point<T>, p2: &Point<T>, p3: &Point<T>) -> T
 
 /// Simplifies a geometry.
 ///
-/// Polygons are simplified by running the algorithm on all their constituant rings. Multi* objects
-/// are simplified by simplifing all their constituant geometries individually.
+/// Polygons are simplified by running the algorithm on all their constituant rings.  This may
+/// result in invalid Polygons, and has no guarantee of perserving topology.  Multi* objects are
+/// simplified by simplifing all their constituant geometries individually.
 pub trait SimplifyVW<T, Epsilon = T> {
     /// Returns the simplified representation of a geometry, using the [Visvalingam-Whyatt](http://www.tandfonline.com/doi/abs/10.1179/000870493786962263) algorithm
     ///