1Statistics::DescriptiveU:s:eSrmoCootnhterri(b3u)ted PerlStDaotciusmteinctsa:t:iDoenscriptive::Smoother(3)
2
3
4

NAME

6       Statistics::Descriptive::Smoother - Base module for smoothing
7       statistical data
8

VERSION

10       version 3.0701
11

SYNOPSIS

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

DESCRIPTION

23       This module provide methods to smooth the trend of a series of
24       statistical data.
25
26       The methods provided are the "Exponential" and the "Weighted
27       Exponential" (see respectively
28       "Statistics::Descriptive::Smoother::Exponential" and
29       "Statistics::Descriptive::Smoother::Weightedexponential" for more
30       details).
31
32       This class is just a factory that will instantiate the object to
33       perform the chosen smoothing algorithm.
34

VERSION

36       version 3.0701
37

METHODS

39       Statistics::Descriptive::Smoother->instantiate({});
40            Create a new Smoother object.
41
42            This method require several parameters:
43
44            method
45                 Method used for the smoothing. Allowed values are:
46                 "exponential" and "weightedexponential"
47
48            coeff
49                 Smoothing coefficient. It needs to be in the [0;1] range,
50                 otherwise undef will be reutrned.  0 means that the series is
51                 not smoothed at all, while 1 the series is universally equal
52                 to the initial unsmoothed value.
53
54            data Array ref with the data of the series. At least 2 values are
55                 needed to smooth the series, undef is returned otherwise.
56
57            samples
58                 Array ref with the samples each data value has been built
59                 with. This is an optional parameter since it is not used by
60                 all the smoothing algorithm.
61
62       $smoother->get_smoothing_coeff();
63            Returns the smoothing coefficient.
64
65       $smoother->set_smoothing_coeff(0.5);
66            Set the smoothing coefficient value. It needs to be in the [0;1]
67            range, otherwise undef will be reutrned.
68

AUTHOR

70       Fabio Ponciroli
71

73       Copyright(c) 2012 by Fabio Ponciroli.
74

LICENSE

76       This file is licensed under the MIT/X11 License:
77       http://www.opensource.org/licenses/mit-license.php.
78
79       Permission is hereby granted, free of charge, to any person obtaining a
80       copy of this software and associated documentation files (the
81       "Software"), to deal in the Software without restriction, including
82       without limitation the rights to use, copy, modify, merge, publish,
83       distribute, sublicense, and/or sell copies of the Software, and to
84       permit persons to whom the Software is furnished to do so, subject to
85       the following conditions:
86
87       The above copyright notice and this permission notice shall be included
88       in all copies or substantial portions of the Software.
89
90       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
91       OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
92       MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
93       IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
94       CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
95       TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
96       SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
97

AUTHOR

99       Shlomi Fish <shlomif@cpan.org>
100

102       This software is copyright (c) 1997 by Jason Kastner, Andrea Spinelli,
103       Colin Kuskie, and others.
104
105       This is free software; you can redistribute it and/or modify it under
106       the same terms as the Perl 5 programming language system itself.
107

BUGS

109       Please report any bugs or feature requests on the bugtracker website
110       <https://github.com/shlomif/perl-Statistics-Descriptive/issues>
111
112       When submitting a bug or request, please include a test-file or a patch
113       to an existing test-file that illustrates the bug or desired feature.
114

SUPPORT

116   Perldoc
117       You can find documentation for this module with the perldoc command.
118
119         perldoc Statistics::Descriptive::Smoother
120
121   Websites
122       The following websites have more information about this module, and may
123       be of help to you. As always, in addition to those websites please use
124       your favorite search engine to discover more resources.
125
126       ·   MetaCPAN
127
128           A modern, open-source CPAN search engine, useful to view POD in
129           HTML format.
130
131           <https://metacpan.org/release/Statistics-Descriptive>
132
133       ·   Search CPAN
134
135           The default CPAN search engine, useful to view POD in HTML format.
136
137           <http://search.cpan.org/dist/Statistics-Descriptive>
138
139       ·   RT: CPAN's Bug Tracker
140
141           The RT ( Request Tracker ) website is the default bug/issue
142           tracking system for CPAN.
143
144           <https://rt.cpan.org/Public/Dist/Display.html?Name=Statistics-Descriptive>
145
146       ·   AnnoCPAN
147
148           The AnnoCPAN is a website that allows community annotations of Perl
149           module documentation.
150
151           <http://annocpan.org/dist/Statistics-Descriptive>
152
153       ·   CPAN Ratings
154
155           The CPAN Ratings is a website that allows community ratings and
156           reviews of Perl modules.
157
158           <http://cpanratings.perl.org/d/Statistics-Descriptive>
159
160       ·   CPANTS
161
162           The CPANTS is a website that analyzes the Kwalitee ( code metrics )
163           of a distribution.
164
165           <http://cpants.cpanauthors.org/dist/Statistics-Descriptive>
166
167       ·   CPAN Testers
168
169           The CPAN Testers is a network of smoke testers who run automated
170           tests on uploaded CPAN distributions.
171
172           <http://www.cpantesters.org/distro/S/Statistics-Descriptive>
173
174       ·   CPAN Testers Matrix
175
176           The CPAN Testers Matrix is a website that provides a visual
177           overview of the test results for a distribution on various
178           Perls/platforms.
179
180           <http://matrix.cpantesters.org/?dist=Statistics-Descriptive>
181
182       ·   CPAN Testers Dependencies
183
184           The CPAN Testers Dependencies is a website that shows a chart of
185           the test results of all dependencies for a distribution.
186
187           <http://deps.cpantesters.org/?module=Statistics::Descriptive>
188
189   Bugs / Feature Requests
190       Please report any bugs or feature requests by email to
191       "bug-statistics-descriptive at rt.cpan.org", or through the web
192       interface at
193       <https://rt.cpan.org/Public/Bug/Report.html?Queue=Statistics-Descriptive>.
194       You will be automatically notified of any progress on the request by
195       the system.
196
197   Source Code
198       The code is open to the world, and available for you to hack on. Please
199       feel free to browse it and play with it, or whatever. If you want to
200       contribute patches, please send me a diff or prod me to pull from your
201       repository :)
202
203       <https://github.com/shlomif/perl-Statistics-Descriptive>
204
205         git clone git://github.com/shlomif/perl-Statistics-Descriptive.git
206
207
208
209perl v5.28.0                      2018-07-1S6tatistics::Descriptive::Smoother(3)
Impressum