/ 
BioPerl-1.6.901
River stage two • 60 direct dependents • 65 total dependents
/ Bio::Tools::RandomDistFunctions

NAME

Bio::Tools::RandomDistFunctions - A set of routines useful for generating random data in different distributions

SYNOPSIS

use Bio::Tools::RandomDistFunctions;
my $dist = Bio::Tools::RandomDistFunctions->new();
for my $v ( 1..1000 ) { 
  my $birth_dist = $dist->rand_birth_distribution($lambda);
  # ... do something with the variable
}

DESCRIPTION

Most of the code is based on the C implementation of these routines in Mike Sanderson's r8s's package. See http://loco.biosci.arizona.edu/r8s/ for information on his software.

This code tries to be fast and use available faster BigInt and GMP library methods when those modules are available.

FEEDBACK

Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Support

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:

https://redmine.open-bio.org/projects/bioperl/

AUTHOR - Jason Stajich

Email jason-at-bioperl.org

CONTRIBUTORS

Thanks to Mike Sanderson for assistance in the getting this implementation together.

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

birth_distribution

Title   : rand_birth_distribution
Usage   : my $randvar = $dist->
           rand_birth_distribution($lambda);
Function: Returns a random number from a birth process waiting 
          time with a fixed interval
          1.0.  Times are measured from 0=present,1=root;
Returns : floating point number
Args    : $lambda ( > 0 )
References : This is based on code by Mike Sanders in r8s.
             Ross, Stochastic Processes, p. 145 for the density

rand_geometric_distribution

Title   : rand_geometric_distribution
Usage   : my $randvar = $dist->rand_geometric_distribution($param);
Function: Returns a random geometric variate distributed with 
          parameter $param, according to
          c.d.f. 1 - ( 1- param) ^ n 
Returns : integer
Args    : $param ( 0 > $param < 1 )

rand_exponentional_distribution

Title   : rand_exponentional_distribution
Usage   : my $var = $dist->rand_exponentional_distribution($param);
Function: Returns a random exponential variate distributed with parameter
          $param, according to c.d.f 1 - e^(-param * x)
Returns : floating point number 
Args    : $param ( > 0 )

rand_normal_distribution

Title   : rand_normal_distribution
Usage   : my $var = $dist->rand_normal_distribution()
Function: Returns a random normal (gaussian) variate distributed 
Returns : floating point number
Args    : none