Jimi Carlo Wills > Statistics-TheilSenEstimator-0.05 > Statistics::TheilSen

Download:
Statistics-TheilSenEstimator-0.05.tar.gz

Annotate this POD

View/Report Bugs
Source   Latest Release: Statistics-TheilSenEstimator-0.06

NAME ^

Statistics::TheilSen - Perl implementation of Theil Sen Estimator

VERSION ^

Version 0.05

SYNOPSIS ^

This is a perl implementation of the Theil Sen Estimator, which is a method of linear regression that uses medians. All of the gradients of the lines between all points are calculated, and hte median is the one reported. Sounds trivial. If you have 1000s of points, then you have millions of lines, and sort-based median methods can take ages, so Statistics::TheilSen uses the partition-based Statistics::QuickMedian.

    # OOP...
    
    use Statistics::TheilSenEstimator;

    my $tse = Statistics::TheilSenEstimator->new(\$y_values, \$x_values);
    # which is really a shortcut for:
    my $tse = Statistics::TheilSenEstimator->new();
    $tse->addData(\@y_values, \@x_values); # listrefs of numeric scalars
    
    my $status_line = $tse->run(); # might tell if you had bad values, etc
    print "y = ", $tse->m(), "x + ", $tse->c(); # y = mx + c
    
    # or procedural...
    
    use Statistics::TheilSenEstimator qw/theilsen/;

    my ($m,$c) = theilsen(\@y_values, \@x_values);

EXPORT/SUBROUTINES ^

theilsen

Accepts two list refs, the lists should be the same length. They represent y and x series which will be the subject of the regression. Returns a list of two

    use Statistics::TheilSenEstimator qw/theilsen/;

    my ($m,$b) = theilsen(\$y_values, \$x_values);

METHODS ^

new

    use Statistics::TheilSenEstimator;
    my $tse = Statistics::TheilSenEstimator->new();
    #or
    my $tse = Statistics::TheilSenEstimator->new(\@y_values, \@x_values);

returns a new Statistics::TheilSenEstimator estimator object with the optional data added.

addData

    $tse->addData(\@y_values, \@x_values);

Adds data to the y and x series. Data series should be the same length.

run

    my $status_line = $tse->run();

Runs the estimator on the data currently in the object. Returns any messages about whether errors or weird things were found in the data. Sets m and c in the object

m

    my $gradient = $tse->m();

Returns "m", the gradient of the model generated by run(). If run() was not called since addData(), then run() will be called here!

c

    my $intersect = $tse->c();

Returns "c", the intersect of the model generated by run(). If run() was not called since addData(), then run() will be called here!

AUTHOR ^

Jimi Wills, <jimi at webu.co.uk>

BUGS ^

Please report any bugs or feature requests to bug-statistics-theilsen at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Statistics-TheilSen. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Statistics::TheilSenEstimator

You can also look for information at:

ACKNOWLEDGEMENTS ^

http://en.wikipedia.org/wiki/Theil%E2%80%93Sen_estimator

LICENSE AND COPYRIGHT ^

Copyright 2013 Jimi Wills.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

syntax highlighting: