NAME

Statistics::Descriptive::PDL::SampleWeighted - Sample weighted descriptive statistics using PDL as the back-end

VERSION

Version 0.12

SYNOPSIS

use Statistics::Descriptive::PDL::SampleWeighted;

my $stats = Statistics::Descriptive::PDL::SampleWeighted->new;
$stats->add_data([1,2,3,4], [1,3,5,6]);  #  values then weights
my $mean = $stats->mean;
my $var  = $stats->variance;

#  or you can add data using a hash ref
my %data = (1 => 1, 2 => 3, 3 => 5, 4 => 6);
$stats->add_data(\%data);

#  if you want equal weights then you need to supply them yourself
my $data = [1,2,3,4];
$stats->add_data($data, [(1) x scalar @$data]);

DESCRIPTION

This module provides basic functions used in descriptive statistics using weighted values. Inherits from Statistics::Descriptive::PDL::Weighted, with the key difference that the weights are forced to be integers.

Variance, skewness and kurtosis all use the unbiased calculations. The median and percentiles are calculated using interpolation, analogous to the unweighted case where values are repeated by the weights.

METHODS

new

Create a new statistics object. Takes no arguments.

add_data (\%data)

add_data ([1,2,3,4], [5,1,1,2)

Add data to the stats object. Appends to any existing data.

Same as Statistics::Descriptive::PDL::Weighted except that non-integer weights will be converted to integer using PDL's rules.

sum_sqr_sample_weights

Same as the sum_weights method. This is because one can consider each value as weighted by the number of samples, where each individual sample has a weight of 1.

AUTHOR

Shawn Laffan, <shawnlaffan at gmail.com>

BUGS

Please report any bugs or feature requests to https://github.com/shawnlaffan/Statistics-Descriptive-PDL/issues.

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2021 Shawn Laffan.

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.