File Coverage

blib/lib/App/RecordStream/Aggregator/StandardDeviation.pm

Criterion	Covered	Total	%
statement	21	23	91.3
branch			n/a
condition			n/a
subroutine	7	9	77.7
pod	0	3	0.0
total	28	35	80.0

package App::RecordStream::Aggregator::StandardDeviation;

our $VERSION = "4.0.24";

use strict;
use warnings;

use App::RecordStream::Aggregator::Ord2Univariate;
use App::RecordStream::Aggregator;
use App::RecordStream::DomainLanguage::Registry;

use base 'App::RecordStream::Aggregator::Ord2Univariate';

#sub new -- passed through

#sub new_from_valuation -- passed through

sub squish
{
  my ($this, $cookie) = @_;

  my ($sum1, $sumx, $sumx2) = @$cookie;

  return sqrt(($sumx2 / $sum1) - ($sumx / $sum1) ** 2);
}

sub long_usage
{
  return <
Usage: stddev,
   Standard deviation of specified fields.

   This is computed as StdDev(X) = sqrt(E[(X - E[X])^2]).  Standard deviation
   is an indication of deviation from average value.
EOF
}

sub short_usage
{
  return "find standard deviation of provided field";
}

App::RecordStream::Aggregator->register_implementation('stddev', __PACKAGE__);

App::RecordStream::DomainLanguage::Registry::register_vfn(__PACKAGE__, 'new_from_valuation', 'stddev', 'VALUATION');

1;