.\" 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::Functions 3pm" .TH Geo::Functions 3pm "2022-11-21" "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::Functions \- Package for standard Geo:: functions. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Geo::Functions qw{deg_rad deg_dms rad_deg}; #import into namespace \& print "Degrees: ", deg_rad(3.14/4), "\en"; \& \& use Geo::Functions; \& my $obj = Geo::Functions\->new; \& print "Degrees: ", $obj\->deg_rad(3.14/2), "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Package for standard Geo:: functions. .SH "CONVENTIONS" .IX Header "CONVENTIONS" Function naming convention is \*(L"format of the return\*(R" underscore \*(L"format of the parameters.\*(R" For example, you can read the deg_rad function as \*(L"degrees given radians\*(R" or \*(L"degrees from radians\*(R". .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" The \fBnew()\fR constructor .PP .Vb 1 \& my $obj = Geo::Functions\->new(); .Ve .SH "METHODS" .IX Header "METHODS" .SS "initialize" .IX Subsection "initialize" .SS "deg_dms" .IX Subsection "deg_dms" Degrees given degrees minutes seconds. .PP .Vb 2 \& my $deg = deg_dms(39, 29, 17.134); \& my $deg = deg_dms(39, 29, 17.134, \*(AqN\*(Aq); .Ve .SS "deg_rad" .IX Subsection "deg_rad" Degrees given radians. .PP .Vb 1 \& my $deg = deg_rad(3.14); .Ve .SS "rad_deg" .IX Subsection "rad_deg" Radians given degrees. .PP .Vb 1 \& my $rad = rad_deg(90); .Ve .SS "rad_dms" .IX Subsection "rad_dms" Radians given degrees minutes seconds. .PP .Vb 1 \& my $rad = rad_dms(45 30 20.0); .Ve .SS "round" .IX Subsection "round" Round to the nearest integer. This formula rounds toward +/\- infinity. .PP .Vb 1 \& my $int = round(42.2); .Ve .SS "dms_deg" .IX Subsection "dms_deg" Degrees minutes seconds given degrees. .PP .Vb 2 \& my ($d, $m, $s, $sign) = dms_deg($degrees, qw{N S}); \& my ($d, $m, $s, $sign) = dms_deg($degrees, qw{E W}); .Ve .SS "dm_deg" .IX Subsection "dm_deg" Degrees minutes given degrees. .PP .Vb 2 \& my ($d, $m, $sign) = dm_deg($degrees, qw{N S}); \& my ($d, $m, $sign) = dm_deg($degrees, qw{E W}); .Ve .SS "mps_knots" .IX Subsection "mps_knots" meters per second given knots .PP .Vb 1 \& my $mps = mps_knots(50.0); .Ve .SS "knots_mps" .IX Subsection "knots_mps" knots given meters per second .PP .Vb 1 \& my $knots = knots_mps(25.0); .Ve .SH "BUGS" .IX Header "BUGS" Please log on GitHub .SH "AUTHOR" .IX Header "AUTHOR" Michael R. Davis .SH "LICENSE" .IX Header "LICENSE" \&\s-1MIT\s0 License .PP Copyright (c) 2022 Michael R. Davis .SH "SEE ALSO" .IX Header "SEE ALSO" Geo::Constants, Geo::Ellipsoids