Venus::Random

Random Class

Random Class for Perl 5

method: bit method: boolean method: byte method: character method: collect method: digit method: float method: letter method: lowercased method: nonzero method: number method: pick method: range method: repeat method: reseed method: reset method: restore method: select method: symbol method: uppercased

package main;

use Venus::Random;

my $random = Venus::Random->new(42);

# my $bit = $random->bit;

# 1

This package provides an object-oriented interface for Perl's pseudo-random number generator (or PRNG) which produces a deterministic sequence of bits which approximate true randomness.

Venus::Kind::Utility

Venus::Role::Accessible Venus::Role::Buildable Venus::Role::Valuable

The bit method returns a 1 or 0 value, randomly.

bit() (Int)

{ since => '1.11', }

=example-1 bit

# given: synopsis

package main;

my $bit = $random->bit;

# 0

# $bit = $random->bit;

# 1

The boolean method returns a true or false value, randomly.

boolean() (Bool)

{ since => '1.11', }

=example-1 boolean

# given: synopsis

package main;

my $boolean = $random->boolean;

# 0

# $boolean = $random->boolean;

# 1

The byte method returns random byte characters, randomly.

byte() (Str)

{ since => '1.11', }

=example-1 byte

# given: synopsis

package main;

my $byte = $random->byte;

# "\xBE"

# $byte = $random->byte;

# "W"

The character method returns a random character, which is either a "digit", "letter", or "symbol" value.

character() (Str)

{ since => '1.11', }

=example-1 character

# given: synopsis

package main;

my $character = $random->character;

# ")"

# $character = $random->character;

# 4

The collect method dispatches to the specified method or coderef, repeatedly based on the number of $times specified, and returns the random concatenated results from each dispatched call. By default, if no arguments are provided, this method dispatches to "digit".

collect(Int $times, Str|CodeRef $code, Any @args) (Int|Str)

{ since => '1.11', }

=example-1 collect

# given: synopsis

package main;

my $collect = $random->collect;

# 7

# $collect = $random->collect;

# 3

The digit method returns a random digit between 0 and 9.

digit() (Int)

{ since => '1.11', }

=example-1 digit

# given: synopsis

package main;

my $digit = $random->digit;

# 7

# $digit = $random->digit;

# 3

The float method returns a random float.

float(Int $place, Int $from, Int $upto) (Num)

{ since => '1.11', }

=example-1 float

# given: synopsis

package main;

my $float = $random->float;

# 1447361.5

# $float = $random->float;

# "0.0000"

The letter method returns a random letter, which is either an "uppercased" or "lowercased" value.

letter() (Str)

{ since => '1.11', }

=example-1 letter

# given: synopsis

package main;

my $letter = $random->letter;

# "i"

# $letter = $random->letter;

# "K"

The lowercased method returns a random lowercased letter.

lowercased() (Str)

{ since => '1.11', }

=example-1 lowercased

# given: synopsis

package main;

my $lowercased = $random->lowercased;

# "t"

# $lowercased = $random->lowercased;

# "i"

The nonzero method dispatches to the specified method or coderef and returns the random value ensuring that it's never zero, not even a percentage of zero. By default, if no arguments are provided, this method dispatches to "digit".

nonzero(Str|CodeRef $code, Any @args) (Int|Str)

{ since => '1.11', }

=example-1 nonzero

# given: synopsis

package main;

my $nonzero = $random->nonzero;

# 7

# $nonzero = $random->nonzero;

# 3

The number method returns a random number within the range provided. If no arguments are provided, the range is from 0 to 2147483647. If only the first argument is provided, it's treated as the desired length of the number.

number(Int $from, Int $upto) (Num)

{ since => '1.11', }

=example-1 number

# given: synopsis

package main;

my $number = $random->number;

# 3427014

# $number = $random->number;

# 3

The pick method is the random number generator and returns a random number. By default, calling this method is equivalent to call "rand" in perlfunc. This method can be overridden in a subclass to provide a custom generator, e.g. a more cyptographically secure generator.

pick(Num $data) (Num)

{ since => '1.23', }

=example-1 pick

# given: synopsis

package main;

my $pick = $random->pick;

# 0.744525000061007

# $pick = $random->pick;

# 0.342701478718908

The range method returns a random number within the range provided. If no arguments are provided, the range is from 0 to 2147483647.

range(Str $name) (ArrayRef)

{ since => '1.11', }

=example-1 range

# given: synopsis

package main;

my $range = $random->range(1, 10);

# 8

# $range = $random->range(1, 10);

# 4

The repeat method dispatches to the specified method or coderef, repeatedly based on the number of $times specified, and returns the random results from each dispatched call. In list context, the results from each call is returned as a list, in scalar context the results are concatenated.

repeat(Int $times, Str|CodeRef $code, Any @args) (Int|Str)

{ since => '1.11', }

=example-1 repeat

# given: synopsis

package main;

my @repeat = $random->repeat(2);

# (7, 3)

# @repeat = $random->repeat(2);

# (1, 4)

The reseed method sets the "srand" in perlfunc (i.e. the PRNG seed) to the value provided, or the default value used on instanstiation when no seed is passed to the constructor. This method returns the object that invoked it.

reseed(Str $seed) (Random)

{ since => '1.11', }

=example-1 reseed

# given: synopsis

package main;

my $reseed = $random->reseed;

# bless({value => ...}, "Venus::Random")

# my $bit = $random->bit;

# 0

The reset method sets the "srand" in perlfunc (i.e. the PRNG seed) to the default value used on instanstiation when no seed is passed to the constructor. This method returns the object that invoked it.

reset() (Random)

{ since => '1.11', }

=example-1 reset

# given: synopsis

package main;

my $reset = $random->reset;

# bless({value => ...}, "Venus::Random")

The restore method sets the "srand" in perlfunc (i.e. the PRNG seed) to the original value used by "rand" in perlfunc. This method returns the object that invoked it.

restore() (Random)

{ since => '1.11', }

=example-1 restore

# given: synopsis

package main;

my $restore = $random->restore;

# bless({value => ...}, "Venus::Random")

The select method returns a random value from the "hashref" or "arrayref" provided.

select(ArrayRef|HashRef $data) (Any)

{ since => '1.11', }

=example-1 select

# given: synopsis

package main;

my $select = $random->select(["a".."d"]);

# "c"

# $select = $random->select(["a".."d"]);

# "b"

The symbol method returns a random symbol.

symbol() (Str)

{ since => '1.11', }

=example-1 symbol

# given: synopsis

package main;

my $symbol = $random->symbol;

# "'"

# $symbol = $random->symbol;

# ")"

The uppercased method returns a random uppercased letter.

uppercased() (Str)

{ since => '1.11', }

=example-1 uppercased

# given: synopsis

package main;

my $uppercased = $random->uppercased;

# "T"

# $uppercased = $random->uppercased;

# "I"

t/Venus.t: pdml: authors t/Venus.t: pdml: license

cpanm Venus

perl -MCPAN -e shell
install Venus