NAME

       Statistics::Descriptive::Smoother - Base module for smoothing statistical data

SYNOPSIS

         use Statistics::Descriptive::Smoother;
         my $smoother = Statistics::Descriptive::Smoother->instantiate({
                  method   => 'exponential',
                  coeff    => 0.5,
                  data     => [1, 2, 3, 4, 5],
                  samples  => [110, 120, 130, 140, 150],
           });
         my @smoothed_data = $smoother->get_smoothed_data();

DESCRIPTION

       This module provide methods to smooth the trend of a series of statistical data.

       The methods provided are the "Exponential" and the "Weighted Exponential" (see
       respectively "Statistics::Descriptive::Smoother::Exponential" and
       "Statistics::Descriptive::Smoother::Weightedexponential" for more details).

       This class is just a factory that will instantiate the object to perform the chosen
       smoothing algorithm.

METHODS

       Statistics::Descriptive::Smoother->instantiate({});
            Create a new Smoother object.

            This method require several parameters:

            method
                 Method used for the smoothing. Allowed values are: "exponential" and
                 "weightedexponential"

            coeff
                 Smoothing coefficient. It needs to be in the [0;1] range, otherwise undef will
                 be reutrned.  0 means that the series is not smoothed at all, while 1 the series
                 is universally equal to the initial unsmoothed value.

            data Array ref with the data of the series. At least 2 values are needed to smooth
                 the series, undef is returned otherwise.

            samples
                 Array ref with the samples each data value has been built with. This is an
                 optional parameter since it is not used by all the smoothing algorithm.

       $smoother->get_smoothing_coeff();
            Returns the smoothing coefficient.

       $smoother->set_smoothing_coeff(0.5);
            Set the smoothing coefficient value. It needs to be in the [0;1] range, otherwise
            undef will be reutrned.

AUTHOR

       Fabio Ponciroli

COPYRIGHT

       Copyright(c) 2012 by Fabio Ponciroli.

LICENSE

       This file is licensed under the MIT/X11 License:
       http://www.opensource.org/licenses/mit-license.php.

       Permission is hereby granted, free of charge, to any person obtaining a copy of this
       software and associated documentation files (the "Software"), to deal in the Software
       without restriction, including without limitation the rights to use, copy, modify, merge,
       publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
       to whom the Software is furnished to do so, subject to the following conditions:

       The above copyright notice and this permission notice shall be included in all copies or
       substantial portions of the Software.

       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
       INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
       PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
       FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
       OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
       DEALINGS IN THE SOFTWARE.