.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::Inverse 3pm"
.TH Geo::Inverse 3pm "2023-01-07" "perl v5.36.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::Inverse \- Calculate geographic distance from a latitude and longitude pair
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&  use Geo::Inverse;
\&  my $obj                         = Geo::Inverse\->new();                    #default "WGS84"
\&  my ($lat1, $lon1, $lat2, $lon2) = (38.87, \-77.05, 38.95, \-77.23);
\&  my ($faz, $baz, $dist)          = $obj\->inverse($lat1,$lon1,$lat2,$lon2); #array context
\&  my $dist=$obj\->inverse($lat1, $lon1, $lat2, $lon2);                       #scalar context
\&  print "Input Lat: $lat1 Lon: $lon1\en";
\&  print "Input Lat: $lat2 Lon: $lon2\en";
\&  print "Output Distance: $dist\en";
\&  print "Output Forward Azimuth: $faz\en";
\&  print "Output Back Azimuth: $baz\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a pure Perl port of the \s-1NGS\s0 program in the public domain \*(L"inverse\*(R" by Robert (Sid) Safford and Stephen J. Frakes.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
The \fBnew()\fR constructor may be called with any parameter that is appropriate to the ellipsoid method which establishes the ellipsoid.
.PP
.Vb 1
\&  my $obj = Geo::Inverse\->new(); # default "WGS84"
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "initialize"
.IX Subsection "initialize"
.SS "ellipsoid"
.IX Subsection "ellipsoid"
Method to set or retrieve the current ellipsoid object.  The ellipsoid is a Geo::Ellipsoids object.
.PP
.Vb 1
\&  my $ellipsoid = $obj\->ellipsoid;  #Default is WGS84
\&
\&  $obj\->ellipsoid(\*(AqClarke 1866\*(Aq); #Built in ellipsoids from Geo::Ellipsoids
\&  $obj\->ellipsoid({a=>1});        #Custom Sphere 1 unit radius
.Ve
.SS "inverse"
.IX Subsection "inverse"
This method is the user frontend to the mathematics. This interface will not change in future versions.
.PP
.Vb 1
\&  my ($faz, $baz, $dist) = $obj\->inverse($lat1,$lon1,$lat2,$lon2);
.Ve
.SH "BUGS"
.IX Header "BUGS"
Please open an issue on GitHub
.SH "LIMITS"
.IX Header "LIMITS"
No guarantees that Perl handles all of the double precision calculations in the same manner as Fortran.
.SH "LICENSE"
.IX Header "LICENSE"
\&\s-1MIT\s0 License
.PP
Copyright (c) 2022 Michael R. Davis
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Geo::Ellipsoid, GIS::Distance::GeoEllipsoid, Geo::Calc