Add link and change to convexHull

ianmackenzie · Jan 22, 2018 · 00b6a0f · 00b6a0f
1 parent 2f56232
commit 00b6a0f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -7,3 +7,4 @@ Matthieu Pizenberg <[email protected]> (intersections)
 Folkert de Vries <[email protected]> (length parameterization)
 Dan Fishgold <[email protected]> (interval sin/cos)
 Felix Scheinost <[email protected]> (Sphere3d)
+Jakub Hampl <[email protected]> (convex hull)
diff --git a/media/src/ConvexHull.elm b/media/src/ConvexHull.elm
@@ -71,7 +71,7 @@ view : Model -> Html Msg
 view model =
     let
         convexHull =
-            Polygon2d.fromConvexHull model.points
+            Polygon2d.convexHull model.points
     in
     Html.div [ Html.Events.onClick Click ]
         [ Svg.render2d renderBounds <|

diff --git a/src/OpenSolid/Polygon2d.elm b/src/OpenSolid/Polygon2d.elm
@@ -18,7 +18,7 @@ module OpenSolid.Polygon2d
         , clockwiseArea
         , counterclockwiseArea
         , edges
-        , fromConvexHull
+        , convexHull
         , fromVertices
         , mapVertices
         , mirrorAcross
@@ -46,7 +46,7 @@ as
 
 # Constructors
 
-@docs fromVertices, fromConvexHull
+@docs fromVertices, convexHull
 
 
 # Properties
@@ -129,8 +129,9 @@ chain =
 
 {-| Computes the [convex hull](https://en.wikipedia.org/wiki/Convex_hull) of a list of points. This is an O(n log n) operation.
 -}
-fromConvexHull : List Point2d -> Polygon2d
-fromConvexHull points =
+convexHull : List Point2d -> Polygon2d
+convexHull points =
+    -- See http://www.algorithmist.com/index.php/Monotone_Chain_Convex_Hull for a description of the algorithm.
     let
         sorted =
             points |> List.sortBy Point2d.coordinates

diff --git a/tests/Polygon2d.elm b/tests/Polygon2d.elm
@@ -32,7 +32,7 @@ convexHullIsConvex =
         (\points ->
             let
                 convexHull =
-                    Polygon2d.fromConvexHull points
+                    Polygon2d.convexHull points
 
                 edgeVectors =
                     Polygon2d.edges convexHull |> List.map LineSegment2d.vector
@@ -66,7 +66,7 @@ convexHullContainsAllPoints =
         (\points ->
             let
                 convexHull =
-                    Polygon2d.fromConvexHull points
+                    Polygon2d.convexHull points
 
                 edges =
                     Polygon2d.edges convexHull