.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Statistics::Descriptive::Smoother::Weightedexponential 3pm" .TH Statistics::Descriptive::Smoother::Weightedexponential 3pm 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Statistics::Descriptive::Smoother::Weigthedexponential \- Implement weighted exponential smoothing .SH VERSION .IX Header "VERSION" version 3.0801 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 8 \& use Statistics::Descriptive::Smoother; \& my $smoother = Statistics::Descriptive::Smoother\->instantiate({ \& method => \*(Aqweightedexponential\*(Aq, \& coeff => 0.5, \& data => [1, 2, 3, 4, 5], \& samples => [110, 120, 130, 140, 150], \& }); \& my @smoothed_data = $smoother\->get_smoothed_data(); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module implement the weighted exponential smoothing algorithm to smooth the trend of a series of statistical data. .PP This algorithm can help to control large swings in the unsmoothed data that arise from small samples for those data points. .PP The algorithm implements the following formula: .PP W(0) = N(0) .PP W(t) = ( W(t\-1) * CoeffA + N(t) * CoeffB ) / (CoeffA + CoeffB) .PP CoeffA = C * ( W(t\-1) / (W(t\-1) + N(t) ) ) .PP CoeffB = (1 \- C) * ( N(t) * (W(t\-1) + N(t)) ) .PP S(t) = (S(t\-1)*CoeffA + X(t)*CoeffB) / (CoeffA + CoeffB) .PP where: .IP \(bu 3 t = index in the series .IP \(bu 3 S(t) = smoothed series value at position t .IP \(bu 3 C = smoothing coefficient. Value in the [0;1] range. \f(CW0\fR means that the series is not smoothed at all, while \f(CW1\fR the series is universally equal to the initial unsmoothed value. .IP \(bu 3 X(t) = unsmoothed series value at position t .SH METHODS .IX Header "METHODS" .ie n .IP $stats\->\fBget_smoothed_data()\fR; 5 .el .IP \f(CW$stats\fR\->\fBget_smoothed_data()\fR; 5 .IX Item "$stats->get_smoothed_data();" Returns a copy of the smoothed data array. .SH AUTHOR .IX Header "AUTHOR" Fabio Ponciroli .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright(c) 2012 by Fabio Ponciroli. .SH LICENSE .IX Header "LICENSE" This file is licensed under the MIT/X11 License: http://www.opensource.org/licenses/mit\-license.php. .PP 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: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP 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. .SH SUPPORT .IX Header "SUPPORT" .SS Websites .IX Subsection "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. .IP \(bu 4 MetaCPAN .Sp A modern, open-source CPAN search engine, useful to view POD in HTML format. .Sp .IP \(bu 4 RT: CPAN's Bug Tracker .Sp The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN. .Sp .IP \(bu 4 CPANTS .Sp The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution. .Sp .IP \(bu 4 CPAN Testers .Sp The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions. .Sp .IP \(bu 4 CPAN Testers Matrix .Sp The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms. .Sp .IP \(bu 4 CPAN Testers Dependencies .Sp The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. .Sp .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests by email to \f(CW\*(C`bug\-statistics\-descriptive at rt.cpan.org\*(C'\fR, or through the web interface at . You will be automatically notified of any progress on the request by the system. .SS "Source Code" .IX Subsection "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 :) .PP .PP .Vb 1 \& git clone git://github.com/shlomif/perl\-Statistics\-Descriptive.git .Ve .SH AUTHOR .IX Header "AUTHOR" Shlomi Fish .SH BUGS .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP 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. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 1997 by Jason Kastner, Andrea Spinelli, Colin Kuskie, and others. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.