Bio::Easel::Random(3)

NAME
Bio::Easel - The great new Bio::Easel!

VERSION
Version 0.01

SYNOPSIS
Sequence file handling through inline C with Easel.

Perhaps a little code snippet.

    use Bio::Easel::Random;

    my $foo = Bio::Easel::Random("seed" => $seed);
    ...

EXPORT
No functions currently exported.

SUBROUTINES/METHODS

  new
  Title    : new
  Incept   : EPN, Tue Apr  9 09:05:44 2013
  Usage    : Bio::Easel::Random->new
  Function : Generates a new Bio::Easel::Random object
  Args     : <fileLocation>: seed for RANDOMNESS
  Returns  : Bio::Easel::Random object

  randomness
  Title    : randomness
  Incept   : EPN, Tue Mar  5 05:44:10 2013
  Usage    : Bio::Easel::Random->randomness()
  Function : Accessor for randomness: creates (if nec) and returns an ESL_RANDOMNESS.
  Args     : none
  Returns  : randomness

  seed
  Title    : seed
  Incept   : EPN, Tue Apr  9 09:13:32 2013
  Usage    : Bio::Easel::Random->seed()
  Function : Accessor for seed, read only.
  Args     : none
  Returns  : string containing seed or undef.

  create_randomness
  Title    : create_randomness
  Incept   : EPN, Tue Apr  9 09:14:07 2013
  Usage    : Bio::Easel::Random->create_randomness
  Function : Creates an ESL_RANDOMNESS object (a random number generator) from
           : a given seed. If seed is undefined, uses one time arbitrary seed.
  Args     : <seed>: seed for random number generator, uses '0' if undefined (one-time arbitrary seed)
  Returns  : void
  Dies     : if unable to create randomness

  roll
  Title    : roll
  Incept   : EPN, Tue Apr  9 09:19:40 2013
  Usage    : Bio::Easel::Random->roll($range)
  Function : Returns a uniformly distributed integer in the range 0..$range-1.
  Args     : none
  Returns  : chosen integer from 0..$range-1
  Dies     : if $range is undefined, or not a positive integer

  random_subset_from_array
  Title    : random_subset_from_array
  Incept   : EPN, Tue Aug 20 14:23:15 2013
  Usage    : Bio::Easel::Random->random_subset_from_array($origAR, $subsetAR, $n2pick)
  Function : Returns a uniformly distributed integer in the range 0..$range-1.
  Args     : $origAR:   ref to original array we want a subset none
           : $subsetAR: ref to array to fill with subset (probably should be empty upon entry)
           : $n2pick:   number of elements to pick
  Returns  : void, fills @{$subsetAR}
  Dies     : if $n2pick > scalar(@{$subsetAR});

  DESTROY
  Title    : DESTROY
  Incept   : EPN, Tue Apr  9 09:27:02 2013
  Usage    : Bio::Easel::Random->DESTROY()
  Function : Closes and frees a Random object
  Args     : none
  Returns  : void

  _check_randomness
  Title    : _check_randomness
  Incept   : EPN, Tue Apr  9 09:25:17 2013
  Usage    : Bio::Easel::Random->_check_randomness()
  Function : Creates ESL_RANDOMNESS only if it is currently undefined
  Args     : none
  Returns  : void

  dl_load_flags

AUTHORS
Eric Nawrocki, "<nawrockie at janelia.hhmi.org>" Jody Clements, "<clementsj at janelia.hhmi.org>" Rob Finn, "<finnr at janelia.hhmi.org>" William Arndt, "<arndtw at janelia.hhmi.org>"

BUGS
Please report any bugs or feature requests to "bug-bio-easel at rt.cpan.org".

SUPPORT
You can find documentation for this module with the perldoc command.

    perldoc Bio::Easel::Random

ACKNOWLEDGEMENTS
Sean R. Eddy is the author of the Easel C library of functions for biological sequence analysis, upon which this module is based.

LICENSE AND COPYRIGHT
Copyright 2013 Eric Nawrocki.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.