.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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" ''
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Geo::Distance::XS 3pm"
.TH Geo::Distance::XS 3pm "2018-11-02" "perl v5.28.0" "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"
Geo::Distance::XS \- speed up Geo::Distance
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Geo::Distance::XS;
\&
\& my $geo = Geo::Distance\->new;
\& my $distance = $geo\->distance(mile => $lon1, $lat1 => $lon2, $lat2);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Geo::Distance::XS\*(C'\fR module provides faster C implementations of the
distance calculations found in \f(CW\*(C`Geo::Distance\*(C'\fR. See the documentation for
that module for usage.
.PP
\&\s-1NOTE:\s0 As of version 0.13, Geo::Distance automatically uses this module if
it is installed.
.SH "FORMULAS"
.IX Header "FORMULAS"
In addition to the formulas offered in \f(CW\*(C`Geo::Distance\*(C'\fR, this module
implements the additional formulas:
.SS "alt: Andoyer-Lambert-Thomas Formula"
.IX Subsection "alt: Andoyer-Lambert-Thomas Formula"
This is faster than the Vincenty formula, but trades a bit of accuracy.
.SH "PERFORMANCE"
.IX Header "PERFORMANCE"
This distribution contains a benchmarking script which compares
\&\f(CW\*(C`Geo::Distance::XS\*(C'\fR with \f(CW\*(C`Geo::Distance\*(C'\fR and \f(CW\*(C`GIS::Distance::Fast\*(C'\fR. These
are the results on a MacBook 2GHz with Perl 5.14.2:
.PP
.Vb 4
\& \-\-\-\- [ Formula: hsin ] \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& perl \- distance from LA to NY: 2443.08796228363 miles
\& xs \- distance from LA to NY: 2443.08796228363 miles
\& gis_fast \- distance from LA to NY: 2443.08796228363 miles
\&
\& Rate gis_fast perl xs
\& gis_fast 24802/s \-\- \-70% \-98%
\& perl 81919/s 230% \-\- \-92%
\& xs 1003704/s 3947% 1125% \-\-
\&
\& \-\-\-\- [ Formula: tv ] \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& perl \- distance from LA to NY: 2448.24135235512 miles
\& xs \- distance from LA to NY: 2448.2413523656 miles
\& gis_fast \- distance from LA to NY: 2448.24135235512 miles
\&
\& Rate perl gis_fast xs
\& perl 18101/s \-\- \-19% \-95%
\& gis_fast 22330/s 23% \-\- \-94%
\& xs 345717/s 1810% 1448% \-\-
\&
\& \-\-\-\- [ Formula: polar ] \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& perl \- distance from LA to NY: 2766.02509696782 miles
\& xs \- distance from LA to NY: 2766.02509696782 miles
\& gis_fast \- distance from LA to NY: 2766.02509696782 miles
\&
\& Rate gis_fast perl xs
\& gis_fast 19200/s \-\- \-78% \-98%
\& perl 87682/s 357% \-\- \-93%
\& xs 1214700/s 6227% 1285% \-\-
\&
\& \-\-\-\- [ Formula: cos ] \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& perl \- distance from LA to NY: 2443.08796228363 miles
\& xs \- distance from LA to NY: 2443.08796228363 miles
\& gis_fast \- distance from LA to NY: 2443.08796228363 miles
\&
\& Rate gis_fast perl xs
\& gis_fast 24435/s \-\- \-69% \-98%
\& perl 78913/s 223% \-\- \-93%
\& xs 1147836/s 4597% 1355% \-\-
\&
\& \-\-\-\- [ Formula: gcd ] \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& perl \- distance from LA to NY: 2443.08796228363 miles
\& xs \- distance from LA to NY: 2443.08796228363 miles
\& gis_fast \- distance from LA to NY: 2443.08796228363 miles
\&
\& Rate gis_fast perl xs
\& gis_fast 18270/s \-\- \-75% \-98%
\& perl 74472/s 308% \-\- \-93%
\& xs 1102769/s 5936% 1381% \-\-
\&
\& \-\-\-\- [ Formula: mt ] \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& perl \- distance from LA to NY: 2443.08796228363 miles
\& xs \- distance from LA to NY: 2443.08796228363 miles
\& gis_fast \- distance from LA to NY: 2443.08796228363 miles
\&
\& Rate gis_fast perl xs
\& gis_fast 17935/s \-\- \-75% \-98%
\& perl 71739/s 300% \-\- \-94%
\& xs 1135525/s 6231% 1483% \-\-
.Ve
.PP
This distribution contains another benchmarking script which compares
only the \s-1XS\s0 formulas over several different coordinates:
.PP
.Vb 8
\& Rate tv hsin alt cos mt gcd polar
\& tv 16906/s \-\- \-90% \-90% \-91% \-91% \-91% \-92%
\& hsin 165414/s 878% \-\- \-4% \-8% \-10% \-13% \-17%
\& alt 172032/s 918% 4% \-\- \-5% \-7% \-9% \-14%
\& cos 180326/s 967% 9% 5% \-\- \-2% \-5% \-10%
\& mt 184357/s 991% 11% 7% 2% \-\- \-3% \-8%
\& gcd 189253/s 1019% 14% 10% 5% 3% \-\- \-6%
\& polar 200386/s 1085% 21% 16% 11% 9% 6% \-\-
\&
\& Calculated length for short distance:
\& alt : 40.3740136064528 miles
\& cos : 40.3095459813536 miles
\& gcd : 40.3095459813294 miles
\& hsin : 40.3095459813294 miles
\& mt : 40.3095459813536 miles
\& polar: 46.7467797109043 miles
\& tv : 40.3740136384531 miles
\&
\& Calculated length for long distance:
\& alt : 2448.24135691376 miles
\& cos : 2443.08796228363 miles
\& gcd : 2443.08796228363 miles
\& hsin : 2443.08796228363 miles
\& mt : 2443.08796228363 miles
\& polar: 2766.02509696782 miles
\& tv : 2448.2413523656 miles
\&
\& Calculated length for nearly antipodes:
\& alt : 12340.6455133245 miles
\& cos : 12340.327635068 miles
\& gcd : 12340.327635068 miles
\& hsin : 12340.327635068 miles
\& mt : 12340.327635068 miles
\& polar: 12368.4764642469 miles
\& tv : 12340.7483034002 miles
\&
\& Calculated length for antipodes:
\& alt : 12429.86673988 miles
\& cos : 219.005548031861 miles
\& gcd : 12438.0476860875 miles
\& hsin : 12438.0475680956 miles
\& mt : 219.005548031861 miles
\& polar: 12438.0476860875 miles
\& tv : 12370.1885059814 miles
\&
\& Calculated length for polar antipodes:
\& alt : 12429.86673988 miles
\& cos : 12438.0476860875 miles
\& gcd : 12438.0476860875 miles
\& hsin : 12438.0476860875 miles
\& mt : 12438.0476860875 miles
\& polar: 12438.0476860875 miles
\& tv : 12429.8667398787 miles
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Geo::Distance
.PP
.SH "REQUESTS AND BUGS"
.IX Header "REQUESTS AND BUGS"
Please report any bugs or feature requests to
. I will be
notified, and then you'll automatically be notified of progress on your bug as
I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\& perldoc Geo::Distance::XS
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
GitHub Source Repository
.Sp
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2014 gray , all rights reserved.
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
gray,