/ 
Statistics-Basic-1.0
River stage two • 10 direct dependents • 15 total dependents
/ Statistics::Basic

NAME

Statistics::Basic - A collection of very basic statistics modules

SYNOPSIS

use Statistics::Basic qw(:all);

These actually return objects, not numbers. The objects will interpolate as nicely formated numbers (using Number::Format). Or the actual number will be returned when the object is used as a number.

my $median = median( 1,2,3 );
my $mean   = mean(  [1,2,3]); # array refs are ok too

my $variance = variance( 1,2,3 );
my $stddev   = stddev(   1,2,3 );

Although passing unblessed numbers and array refs to these functions works, it's sometimes better to pass vector objects so the objects can reuse calculated values.

my $v1       = $mean->query_vector;
my $variance = variance( $v1 );
my $stddev   = stddev(   $v1 );

Here, the mean used by the variance and the variance used by the standard deviation will not need to be recalculated. Now consider these two calculations.

my $covariance  = covariance(  [1 .. 3], [1 .. 3] );
my $correlation = correlation( [1 .. 3], [1 .. 3] );

The covariance above would need to be recalculated by the correlation when these functions are called this way. But, if we instead built vectors first, that wouldn't happen:

# $v1 is defined above
my $v2  = vector(1,2,3);
my $cov = covariance(  $v1, $v2 );
my $cor = correlation( $v1, $v2 );

Now $cor can reuse the variance calculated in $cov.

All of the functions above return objects that interpolate or evaluate as a single string or as a number. Statistics::Basic::LeastSquareFit and Statistics::Basic::Mode are different:

my $unimodal   = mode(1,2,3,3);
my $multimodal = mode(1,2,3);

print "The modes are: $unimodal and $multimodal.\n";
print "The first is multimodal... " if $unimodal->is_multimodal;
print "The second is multimodal.\n" if $multimodal->is_multimodal;

In the first case, $unimodal will interpolate as a string and function correctly as a number. However, in the second case, trying to use $multimodal as a number will croak an error -- it still interpolates fine though.

my $lsf = leastsquarefit($v1, $v2);

This $lsf will interpolate fine, showing "alpha: $alpha, beta: $beta", but it will croak if you try to use the object as a number.

my $v3             = $multimodal->query;
my ($alpha, $beta) = $lsf->query;
my $average        = $mean->query;

All of the objects allow you to explicitly query, if you're not in the mood to use overload.

my @answers = (
    $mode->query,
    $median->query,
    $stddev->query,
);

SHORTCUTS

The following shortcut functions can be used in place of calling the module's new() method directly.

They all take either array refs or lists as arguments, with the exception of the shortcuts that need two vectors to process (e.g. Statistics::Basic::Correlation).

vector()

Arguments to vector() can be any of: an array ref, a list of numbers, or a blessed vector object. If passed a blessed vector object, vector will just return the vector passed in.

mean() average() avg()

You can choose to call mean() as average() or avg(). Arguments can be any of: an array ref, a list of numbers, or a blessed vector object.

median()

Arguments can be any of: an array ref, a list of numbers, or a blessed vector object.

mode()

Arguments can be any of: an array ref, a list of numbers, or a blessed vector object.

variance() var()

You can choose to call variance() as var(). Arguments can be any of: an array ref, a list of numbers, or a blessed vector object. If you will also be calculating the mean of the same list of numbers it's recommended to do this:

my $vec  = vector(1,2,3);
my $mean = mean($vec);
my $var  = variance($vec);

This would also work:

my $mean = mean(1,2,3);
my $var  = variance($mean->query_vector);

This will calculate the same mean twice:

my $mean = mean(1,2,3);
my $var  = variance(1,2,3);

If you really only need the variance, ignore the above and this is fine:

my $variance = variance(1,2,3,4,5);
stddev()

Arguments can be any of: an array ref, a list of numbers, or a blessed vector object. Pass a vector object to stddev() to avoid recalculating the variance and mean if applicable (see variance()).

covariance() cov()

Arguments to covariance() or cov() must be array ref or vector objects. There must be precisely two arguments (or none, setting the vectors to two empty ones), and they must be the same length.

correlation() cor() corr()

Arguments to correlation() or cor()/corr() must be array ref or vector objects. There must be precisely two arguments (or none, setting the vectors to two empty ones), and they must be the same length.

leastsquarefit() LSF() lsf()

Arguments to leastsquarefit() or lsf()/LSF() must be array ref or vector objects. There must be precisely two arguments (or none, setting the vectors to two empty ones), and they must be the same length.

REUSE DETAILS

Most of the objects have a variety of query functions that allow you to extract the objects used within. Although, the objects are smart enough to prevent needless duplication. That is, the following would test would pass:

use Statistics::Basic qw(:all);

my $v1 = vector(1,2,3,4,5);
my $v2 = vector($v1);
my $sd = stddev( $v1 );
my $v3 = $sd->query_vector;
my $m1 = mean( $v1 );
my $m2 = $sd->query_mean;
my $m3 = Statistics::Basic::Mean->new( $v1 );
my $v4 = $m3->query_vector;

use Scalar::Util qw(refaddr);
use Test; plan tests => 5;

ok( refaddr($v1), refaddr($v2) );
ok( refaddr($v2), refaddr($v3) );
ok( refaddr($m1), refaddr($m2) );
ok( refaddr($m2), refaddr($m3) );
ok( refaddr($v3), refaddr($v4) );

# this is t/54_* in the distribution

Also, note that the mean is only calculated once even though we've calculated a variance and a standard deviation above.

Suppose you'd like a copy of the Statistics::Basic::Variance object that the Statistics::Basic::StdDev object is using. All of the objects within should be accessible with query functions as follows.

QUERY FUNCTIONS

query()

This method exists in all of the objects. Statistics::Basic::LeastSquareFit is the only one that returns two values (alpha and beta) as a list. All of the other query() methods return a single number, the number the module purports to calculate.

query_mean()

Returns the Statistics::Basic::Mean object used by Statistics::Basic::Variance and Statistics::Basic::StdDev.

query_mean1()

Returns the first Statistics::Basic::Mean object used by Statistics::Basic::Covariance, Statistics::Basic::Correlation and Statistics::Basic::LeastSquareFit.

query_mean2()

Returns the second Statistics::Basic::Mean object used by Statistics::Basic::Covariance, Statistics::Basic::Correlation and Statistics::Basic::LeastSquareFit.

query_covariance()

Returns the Statistics::Basic::Covariance object used by Statistics::Basic::Correlation and Statistics::Basic::LeastSquareFit.

query_variance()

Returns the Statistics::Basic::Variance object used by Statistics::Basic::StdDev.

query_variance1()

Returns the first Statistics::Basic::Variance object used by Statistics::Basic::LeastSquareFit.

query_variance2()

Returns the first Statistics::Basic::Variance object used by Statistics::Basic::LeastSquareFit.

query_vector()

Returns the Statistics::Basic::Vector object used by any of the single vector modules.

query_vector1()

Returns the first Statistics::Basic::Vector object used by any of the two vector modules.

query_vector2()

Returns the second Statistics::Basic::Vector object used by any of the two vector modules.

is_multimodal()

Statistics::Basic::Mode objects sometimes return Statistics::Basic::Vector objects instead of numbers. When is_multimodal() is true, the mode is a vector, not a scalar.

y_given_x()

Statistics::Basic::LeastSquareFit is meant for finding a line of best fit. This function can be used to find the y for a given x based on the calculated $beta (slope) and $alpha (y-offset).

x_given_y()

Statistics::Basic::LeastSquareFit is meant for finding a line of best fit. This function can be used to find the x for a given y based on the calculated $beta (slope) and $alpha (y-offset).

This function can produce divide-by-zero errors since it must divide by the slope to find the x value. (The slope should rarely be zero though, that's a vertical line and would represent very odd data points.)

INSERT and SET FUNCTIONS

These objects are all intended to be useful while processing long columns of data, like data you'd find in a database.

insert()

Vectors know how to stay the same size and accept new elements.

my $v1 = vector(1,2,3); # a 3 touple
   $v1->insert(4); # still a 3 touple

print "$v1\n"; # prints: [2, 3, 4]

$v1->insert(7); # still a 3 touple
print "$v1\n"; # prints: [3, 4, 7]

All of the other Statistics::Basic modules have this function too. The modules that track two vectors will need two arguments to insert though.

my $mean = mean([1,2,3]);
   $mean->insert(4);

print "mean: $mean\n"; # prints 3 ... (2+3+4)/3

my $correlation = correlation($mean->query_vector,
    $mean->query_vector->copy);

print "correlation: $correlation\n"; # 1

$correlation->insert(3,4);
print "correlation: $correlation\n"; # 0.5

Also, note that the underlying vectors keep track of recalculating automatically.

my $v = vector(1,2,3);
my $m = mean($v);
my $s = stddev($v);

The mean has not been calculated yet.

print "$s; $m\n"; # 0.82; 2

The mean has been calculated once (even though the stddev uses it).

$v->insert(4); print "$s; $m\n"; 0.82; 3
$m->insert(5); print "$s; $m\n"; 0.82; 4
$s->insert(6); print "$s; $m\n"; 0.82; 5

The mean has been calculated thrice more and only thrice more.

ginsert()

You can grow the vectors instead of sliding them FIFO style.

my $v = vector(1,2,3);
my $m = mean($v);
my $s = stddev($v);

$v->ginsert(4); print "$s; $m\n"; 1.12; 2.5
$m->ginsert(5); print "$s; $m\n"; 1.41; 3
$s->ginsert(6); print "$s; $m\n"; 1.71; 1.71

Of course, with a correlation, or a covariance, it'd look more like this:

my $c = correlation([1,2,3], [3,4,5]);
   $c->ginsert(7,7);

print "c=$c\n"; # c=0.98
set_vector()

This allows you to set the vector to a known state. It takes either array ref or vector objects.

my $v1 = vector(1,2,3);
my $v2 = $v1->copy;
   $v2->set_vector([4,5,6]);

my $m = mean();

$m->set_vector([1,2,3]);
$m->set_vector($v2);

my $c = correlation();

$c->set_vector($v1,$v2);
$c->set_vector([1,2,3], [4,5,6]);
set_size()

This sets the size of the vector. When the vector is made bigger, the vector is filled to the new length with leading zeros (i.e., they are the first to be kicked out after new insert()s.

my $v = vector(1,2,3);
   $v->set_size(7);

print "$v\n"; # [0, 0, 0, 0, 1, 2, 3]

my $m = mean();
   $m->set_size(7);

print "", $m->query_vector, "\n";
 # [0, 0, 0, 0, 0, 0, 0]

my $c = correlation([3],[3]);
   $c->set_size(7);

print "", $c->query_vector1, "\n";
print "", $c->query_vector2, "\n";
 # [0, 0, 0, 0, 0, 0, 3]
 # [0, 0, 0, 0, 0, 0, 3]

ENVIRONMENT VARIABLES

$ENV{DEBUG}

Try setting $ENV{DEBUG}=1; or $ENV{DEBUG}=2; to see the internals.

Also, from your bash prompt you can 'DEBUG=1 perl ./myprog.pl' to enable debugging dynamically.

$ENV{UNBIAS}

This module uses the sum(X - mean(X))/N definition of variance. If you wish to use the unbiased, sum(X-mean(X)/(N-1) definition, then set the $ENV{UNBIAS}=1;

This feature was requested by Robert McGehee <xxxxxxxx@wso.williams.edu>.

$ENV{IRES}

$ENV{IRES}, which defaults to 2, is passed to Number::Format as the second argument to format_number during string interpolation (see: overload).

AUTHOR

Paul Miller <jettero@cpan.org>

I am using this software in my own projects... If you find bugs, please please please let me know. :) Actually, let me know if you find it handy at all. Half the fun of releasing this stuff is knowing that people use it.

COPYRIGHT

LGPL! I included a lgpl-2.1.txt.gz for your reading enjoyment.

SEE ALSO

perl(1), Number::Format, overload