File Coverage

blib/lib/Math/Fortran.pm

Criterion	Covered	Total	%
statement	16	16	100.0
branch	6	6	100.0
condition			n/a
subroutine	6	6	100.0
pod	2	2	100.0
total	30	30	100.0

=head1 NAME

    Math::Fortran - Perl implementations of Fortran's sign() and log10()

=head1 SYNOPSIS

    use Math::Fortran qw(log10 sign);
    $v = log10($x);
    $v = sign($y);
    $v = sign($x, $y);

=head1 DESCRIPTION

This module provides and exports some mathematical functions which are
built in in Fortran but not in Perl. Currently there are only 2 included.

=head2 FUNCTIONS

=head3 log10()

Log to the base of 10

=head3 sign()

With 1 parameter, +1 if $y >= 0, -1 otherwise. With 2 parameters +abs($x) if $y >= 0, -abs($x) otherwise.

=head1 BUGS

I welcome other entries for this module and bug reports.

=head1 AUTHOR

John A.R. Williams B

John M. Gamble B (current maintainer)

=cut

package Math::Fortran;

use strict;
use warnings;
use 5.8.3;

use Exporter;
our (@ISA, @EXPORT_OK, %EXPORT_TAGS);

@ISA = qw(Exporter);

%EXPORT_TAGS = (
	all => [qw(sign log10)],
);

@EXPORT_OK = (
	@{ $EXPORT_TAGS{all} }
);

our $VERSION = 0.03;

sub log10
{
	log($_[0])/log(10);
}

sub sign
{
	my ($a1, $a2) = @_;

	if (defined $a2)
	{
		return $a2 >= 0 ? abs($a1): -abs($a1);
	}
	return $a1 >= 0 ? +1 : -1;
}

1;