File Coverage

lib/Geo/Functions.pm

Criterion	Covered	Total	%
statement	62	62	100.0
branch	22	26	84.6
condition	11	19	57.8
subroutine	15	15	100.0
pod	11	11	100.0
total	121	133	90.9

package Geo::Functions;
use strict;
use warnings;
use vars qw(@ISA @EXPORT_OK);
require Exporter;
use Geo::Constants qw{RAD DEG KNOTS};

@ISA         = qw(Exporter);
@EXPORT_OK   = (qw{deg_rad rad_deg deg_dms rad_dms dms_deg dm_deg round mps_knots knots_mps});
our $VERSION = '0.08';

=head1 NAME

Geo::Functions - Package for standard Geo:: functions.

=head1 SYNOPSIS

  use Geo::Functions qw{deg_rad deg_dms rad_deg}; #import into namespace
  print "Degrees: ", deg_rad(3.14/4), "\n";

  use Geo::Functions;
  my $obj = Geo::Functions->new;
  print "Degrees: ", $obj->deg_rad(3.14/2), "\n";

=head1 DESCRIPTION

Package for standard Geo:: functions.

=head1 CONVENTIONS

Function naming convention is "format of the return" underscore "format of the parameters."  For example, you can read the deg_rad function as "degrees given radians" or "degrees from radians".

=head1 CONSTRUCTOR

=head2 new

The new() constructor

  my $obj = Geo::Functions->new();

=cut

sub new {
  my $this  = shift();
  my $class = ref($this) || $this;
  my $self  = {};
  bless $self, $class;
  $self->initialize(@_);
  return $self;
}

=head1 METHODS

=head2 initialize

=cut

sub initialize {
  my $self = shift();
  %$self   = @_;
}

=head2 deg_dms

Degrees given degrees minutes seconds.

  my $deg = deg_dms(39, 29, 17.134);
  my $deg = deg_dms(39, 29, 17.134, 'N');

=cut

sub deg_dms {
  my $self = shift();
  my $d    = ref($self) ? shift()||0 : $self;
  my $m    = shift()||0;
  my $s    = shift()||0;
  my $nsew = shift()||'N';
  my $sign = ($nsew=~m/[SW-]/i) ? -1 : 1; #matches "-" to support -1
  return $sign * ($d + ($m + $s/60)/60);
}

=head2 deg_rad

Degrees given radians.

  my $deg = deg_rad(3.14);

=cut

sub deg_rad {
  my $self = shift();
  my $rad  = ref($self) ? shift() : $self;
  return $rad*DEG();
}

=head2 rad_deg

Radians given degrees.

  my $rad = rad_deg(90);

=cut

sub rad_deg {
  my $self = shift();
  my $deg  = ref($self) ? shift() : $self;
  return $deg*RAD();
}

=head2 rad_dms

Radians given degrees minutes seconds.

  my $rad = rad_dms(45 30 20.0);

=cut

sub rad_dms {
  return rad_deg(deg_dms(@_));
}

=head2 round

Round to the nearest integer. This formula rounds toward +/- infinity.

  my $int = round(42.2);

=cut

sub round {
  my $self   = shift();
  my $number = ref($self) ? shift() : $self;
  return int($number + 0.5 * ($number <=> 0));
}

=head2 dms_deg

Degrees minutes seconds given degrees.

  my ($d, $m, $s, $sign) = dms_deg($degrees, qw{N S});
  my ($d, $m, $s, $sign) = dms_deg($degrees, qw{E W});

=cut

sub dms_deg {
  my $self   = shift();
  my $number = ref($self) ? shift() : $self;
  my @sign   = @_;
  my $sign   = $number >= 0 ? $sign[0]||1 : $sign[1]||-1;
  $number    = abs($number);
  my $d      = int($number);
  my $m      = int(($number-$d) * 60);
  my $s      = ((($number-$d) * 60) - $m) * 60;
  my @dms    = ($d, $m, $s, $sign);
  return wantarray ? @dms : join(' ', @dms);
}

=head2 dm_deg

Degrees minutes given degrees.

  my ($d, $m, $sign) = dm_deg($degrees, qw{N S});
  my ($d, $m, $sign) = dm_deg($degrees, qw{E W});

=cut

sub dm_deg {
  my $self   = shift();
  my $number = ref($self) ? shift() : $self;
  my @sign   = @_;
  my $sign   = $number >= 0 ? $sign[0]||1 : $sign[1]||-1;
  $number    = abs($number);
  my $d      = int($number);
  my $m      = ($number-$d) * 60;
  my @dm     = ($d, $m, $sign);
  return wantarray ? @dm : join(' ', @dm);
}

=head2 mps_knots

meters per second given knots

  my $mps = mps_knots(50.0);

=cut

sub mps_knots {
  my $self   = shift();
  my $number = ref($self) ? shift() : $self;
  return $number * KNOTS();
}

=head2 knots_mps

knots given meters per second

  my $knots = knots_mps(25.0);

=cut

sub knots_mps {
  my $self   = shift();
  my $number = ref($self) ? shift() : $self;
  return $number / KNOTS();
}

=head1 BUGS

Please log on GitHub

=head1 AUTHOR

Michael R. Davis

=head1 LICENSE

MIT License

Copyright (c) 2022 Michael R. Davis

=head1 SEE ALSO

L, L

=cut

1;