1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
|
package Statistics::Descriptive::Smoother::Exponential;
$Statistics::Descriptive::Smoother::Exponential::VERSION = '3.0801';
use strict;
use warnings;
use parent 'Statistics::Descriptive::Smoother';
sub _new
{
my ( $class, $args ) = @_;
return bless $args || {}, $class;
}
# The name of the variables used in the code refers to the explanation in the pod
sub get_smoothed_data
{
my ($self) = @_;
my @smoothed_values;
push @smoothed_values, @{ $self->{data} }[0];
my $C = $self->get_smoothing_coeff();
foreach my $sample_idx ( 1 .. $self->{count} - 1 )
{
my $smoothed_value = $C * ( $smoothed_values[-1] ) +
( 1 - $C ) * $self->{data}->[$sample_idx];
push @smoothed_values, $smoothed_value;
}
return @smoothed_values;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Statistics::Descriptive::Smoother::Exponential - Implement exponential smoothing
=head1 VERSION
version 3.0801
=head1 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();
=head1 DESCRIPTION
This module implement the exponential smoothing algorithm to smooth the trend of a series of statistical data.
This algorithm works well for unsmoothed data build with big number of samples. If this is not
the case you might consider using the C<Weighted Exponential> one.
The algorithm implements the following formula:
S(0) = X(0)
S(t) = C*S(t-1) + (1-C)*X(t)
where:
=over 3
=item * t = index in the series
=item * S(t) = smoothed series value at position t
=item * C = smoothing coefficient. Value in the [0;1] range. C<0> means that the series is not smoothed at all,
while C<1> the series is universally equal to the initial unsmoothed value.
=item * X(t) = unsmoothed series value at position t
=back
=head1 METHODS
=over 5
=item $stats->get_smoothed_data();
Returns a copy of the smoothed data array.
=back
=head1 AUTHOR
Fabio Ponciroli
=head1 COPYRIGHT
Copyright(c) 2012 by Fabio Ponciroli.
=head1 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.
=for :stopwords cpan testmatrix url bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
=head1 SUPPORT
=head2 Websites
The following websites have more information about this module, and may be of help to you. As always,
in addition to those websites please use your favorite search engine to discover more resources.
=over 4
=item *
MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.
L<https://metacpan.org/release/Statistics-Descriptive>
=item *
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
L<https://rt.cpan.org/Public/Dist/Display.html?Name=Statistics-Descriptive>
=item *
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
L<http://cpants.cpanauthors.org/dist/Statistics-Descriptive>
=item *
CPAN Testers
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
L<http://www.cpantesters.org/distro/S/Statistics-Descriptive>
=item *
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
L<http://matrix.cpantesters.org/?dist=Statistics-Descriptive>
=item *
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
L<http://deps.cpantesters.org/?module=Statistics::Descriptive>
=back
=head2 Bugs / Feature Requests
Please report any bugs or feature requests by email to C<bug-statistics-descriptive at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/Public/Bug/Report.html?Queue=Statistics-Descriptive>. You will be automatically notified of any
progress on the request by the system.
=head2 Source Code
The code is open to the world, and available for you to hack on. Please feel free to browse it and play
with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull
from your repository :)
L<https://github.com/shlomif/perl-Statistics-Descriptive>
git clone git://github.com/shlomif/perl-Statistics-Descriptive.git
=head1 AUTHOR
Shlomi Fish <shlomif@cpan.org>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://github.com/shlomif/perl-Statistics-Descriptive/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 1997 by Jason Kastner, Andrea Spinelli, Colin Kuskie, and others.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|