.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Math::ConvexHull 3pm" .TH Math::ConvexHull 3pm "2011-02-13" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Math::ConvexHull \- Calculate convex hulls using Graham's scan (n*log(n)) .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Math::ConvexHull qw/convex_hull/; \& $hull_array_ref = convex_hull(\e@points); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Math::ConvexHull\*(C'\fR is a simple module that calculates convex hulls from a set of points in 2D space. It is a straightforward implementation of the algorithm known as Graham's scan which, with complexity of O(n*log(n)), is the fastest known method of finding the convex hull of an arbitrary set of points. There are some methods of eliminating points that cannot be part of the convex hull. These may or may not be implemented in a future version. .PP The implementation cannot deal with duplicate points. Therefore, points which are very, very close (think floating point close) to the previous point are dropped since version 1.02 of the module. However, if you pass in randomly ordered data which contains duplicate points, this safety measure might not help you. In that case, you will have to remove duplicates yourself. .SS "\s-1EXPORT\s0" .IX Subsection "EXPORT" None by default, but you may choose to have the \f(CW\*(C`convex_hull()\*(C'\fR subroutine exported to your namespace using standard Exporter semantics. .SS "\fIconvex_hull()\fP subroutine" .IX Subsection "convex_hull() subroutine" \&\f(CW\*(C`Math::ConvexHull\*(C'\fR implements exactly one public subroutine which, surprisingly, is called \f(CW\*(C`convex_hull()\*(C'\fR. \f(CW\*(C`convex_hull()\*(C'\fR expects an array reference to an array of points and returns an array reference to an array of points in the convex hull. .PP In this context, a point is considered to be a reference to an array containing an x and a y coordinate. So an example use of \&\f(CW\*(C`convex_hull()\*(C'\fR would be: .PP .Vb 2 \& use Data::Dumper; \& use Math::ConvexHull qw/convex_hull/; \& \& print Dumper convex_hull( \& [ \& [0,0], [1,0], \& [0.2,0.9], [0.2,0.5], \& [0,1], [1,1], \& ] \& ); \& \& # Prints out the points [0,0], [1,0], [0,1], [1,1]. .Ve .PP Please note that \f(CW\*(C`convex_hull()\*(C'\fR does not return \fIcopies\fR of the points but instead returns the same array references that were passed in. .SH "SEE ALSO" .IX Header "SEE ALSO" New versions of this module can be found on http://steffen\-mueller.net or \s-1CPAN\s0. .PP After implementing the algorithm from my \s-1CS\s0 notes, I found the exact same implementation in the German translation of Orwant et al, \*(L"Mastering Algorithms with Perl\*(R". Their code reads better than mine, so if you looked at the module sources and don't understand what's going on, I suggest you have a look at the book. .PP In early 2011, much of the module was rewritten to use the formulation of the algorithm that was shown on the Wikipedia article on Graham's scan at the time. This takes care of issues with including collinear points in the hull. .PP .PP One of these days, somebody should implement Chan's algorithm instead... .SH "AUTHOR" .IX Header "AUTHOR" Steffen Mueller, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2003\-2011 by Steffen Mueller .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6 or, at your option, any later version of Perl 5 you may have available.