Clair::RandomDistribution

Gaussian


SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods

SummaryTop
Clair::RandomDistribution::Gaussian

Package variablesTop
No package variables defined.

Included modulesTop
Carp
Clair::RandomDistribution::RandomDistributionBase
constant two_pi_sqrt_inverse => 1 / sqrt (8 * atan2 (1, 1))

InheritTop
Clair::RandomDistribution::RandomDistributionBase

SynopsisTop
my $z = Gaussian->new (mean => 1.1, variance => 12, dist_size => 20);

DescriptionTop
Concrete class representing a Gaussian distributions.

MethodsTop
dist_functionNo descriptionCode
newNo descriptionCode

Methods description


None available.

Methods code


dist_functiondescriptionprevnextTop
sub dist_function {
  my $self = shift;
  return two_pi_sqrt_inverse *
    exp ( -(($_[0] - $self->{mean}) ** 2) / (2 * $self->{variance})) /
    sqrt ($self->{variance});
}

newdescriptionprevnextTop
sub new {
  my $class = shift;
  my %params = @_;

  # We require a mean and a variance
  unless ((exists $params{mean}) && (exists $params{variance})) {
    croak "Gaussian dist requires mean and variance parameters\n";
  }

  # Instantiate our base class/create representation
  $params{dist_name} = "Gaussian";
  my $self = $class->new_distribution (%params);

  return $self;
}

General documentation


Takes a random variableTop