NAME

Venus::Random - Random Class

ABSTRACT

Random Class for Perl 5

SYNOPSIS

package main;

use Venus::Random;

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

# my $bit = $random->bit;

# 1

DESCRIPTION

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.

INHERITS

This package inherits behaviors from:

Venus::Kind::Utility

INTEGRATES

This package integrates behaviors from:

Venus::Role::Accessible

Venus::Role::Buildable

Venus::Role::Valuable

METHODS

This package provides the following methods:

alphanumeric

alphanumeric() (string)

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

Since 4.15

alphanumeric example 1

# given: synopsis

package main;

my $alphanumeric = $random->alphanumeric;

# "C"

# $alphanumeric = $random->alphanumeric;

# 0

alphanumerics

alphanumerics(number $count) (string)

The alphanumerics method returns n "alphanumeric" characters based on the number (i.e. count) provided.

Since 4.15

alphanumerics example 1

# given: synopsis

package main;

my $alphanumerics = $random->alphanumerics(5);

# "C0Mma"

# $alphanumerics = $random->alphanumerics(5);

# "x5498"

base64

base64() (string)

The base64 method returns a unique randomly generated base64 encoded string.

Since 4.15

base64 example 1

# given: synopsis

package main;

my $base64 = $random->base64;

# "gApCFiIVBS7JHxtVDkvQmOe2CU2RsVgzauI5EMMYI9s="

# $base64 = $random->base64;

# "ZdxOdj268Ge18X97cKr5yH6EJqfEdbI1OeeWJVH/XFQ="

bit

bit() (number)

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

Since 1.11

bit example 1

# given: synopsis

package main;

my $bit = $random->bit;

# 0

# $bit = $random->bit;

# 1

bits

bits(number $count) (string)

The bits method returns n "bit" characters based on the number (i.e. count) provided.

Since 4.15

bits example 1

# given: synopsis

package main;

my $bits = $random->bits(5);

# "01111"

# $bits = $random->bits(5);

# "01100"

boolean

boolean() (boolean)

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

Since 1.11

boolean example 1

# given: synopsis

package main;

my $boolean = $random->boolean;

# 0

# $boolean = $random->boolean;

# 1

byte

byte() (string)

The byte method returns random byte characters, randomly.

Since 1.11

byte example 1

# given: synopsis

package main;

my $byte = $random->byte;

# "\xBE"

# $byte = $random->byte;

# "W"

bytes

bytes(number $count) (string)

The bytes method returns n "byte" characters based on the number (i.e. count) provided.

Since 4.15

bytes example 1

# given: synopsis

package main;

my $bytes = $random->bytes(5);

# "\xBE\x57\x1C\x6C\x14"

# $bytes = $random->bytes(5);

# "\xDB\x7F\x7A\xB0\xD5"

character

character() (string)

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

Since 1.11

character example 1

# given: synopsis

package main;

my $character = $random->character;

# ")"

# $character = $random->character;

# 4

characters

characters(number $count) (string)

The characters method returns n "character" characters based on the number (i.e. count) provided.

Since 4.15

characters example 1

# given: synopsis

package main;

my $characters = $random->characters(5);

# ")48R+"

# $characters = $random->characters(5);

# "a}[Lb"

collect

collect(number $times, string | coderef $code, any @args) (number | string)

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".

Since 1.11

collect example 1

# given: synopsis

package main;

my $collect = $random->collect;

# 7

# $collect = $random->collect;

# 3

collect example 2

# given: synopsis

package main;

my $collect = $random->collect(2);

# 73

# $collect = $random->collect(2);

# 14

collect example 3

# given: synopsis

package main;

my $collect = $random->collect(5, "letter");

# "iKWMv"

# $collect = $random->collect(5, "letter");

# "Papmm"

collect example 4

# given: synopsis

package main;

my $collect = $random->collect(10, "character");

# ")48R+a}[Lb"

# $collect = $random->collect(10, "character");

# "?&0725^,0w"

digest

digest() (string)

The digest method returns a unique randomly generated "md5" digest.

Since 4.15

digest example 1

# given: synopsis

package main;

my $digest = $random->digest;

# "86eb5865c3e4a1457fbefcc93e037459"

# $digest = $random->digest;

# "9be02d56ece7efe68bc59d2ebf3c4ed7"

digit

digit() (number)

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

Since 1.11

digit example 1

# given: synopsis

package main;

my $digit = $random->digit;

# 7

# $digit = $random->digit;

# 3

digits

digits(number $count) (string)

The digits method returns n "digit" characters based on the number (i.e. count) provided.

Since 4.15

digits example 1

# given: synopsis

package main;

my $digits = $random->digits(5);

# 73140

# $digits = $random->digits(5);

# 84468

float

float(number $place, number $from, number $upto) (number)

The float method returns a random float.

Since 1.11

float example 1

# given: synopsis

package main;

my $float = $random->float;

# 1447361.5

# $float = $random->float;

# "0.0000"

float example 2

# given: synopsis

package main;

my $float = $random->float(2);

# 380690.82

# $float = $random->float(2);

# 694.57

float example 3

# given: synopsis

package main;

my $float = $random->float(2, 1, 5);

# 3.98

# $float = $random->float(2, 1, 5);

# 2.37

float example 4

# given: synopsis

package main;

my $float = $random->float(3, 1, 2);

# 1.745

# $float = $random->float(3, 1, 2);

# 1.343

hexdecimal

hexdecimal() (string)

The hexdecimal method returns a hexdecimal character.

Since 4.15

hexdecimal example 1

# given: synopsis

package main;

my $hexdecimal = $random->hexdecimal;

# "b"

# $hexdecimal = $random->hexdecimal;

# 5

hexdecimals

hexdecimals(number $count) (string)

The hexdecimals method returns n "hexdecimal" characters based on the number (i.e. count) provided.

Since 4.15

hexdecimals example 1

# given: synopsis

package main;

my $hexdecimals = $random->hexdecimals(5);

# "b5161"

# $hexdecimals = $random->hexdecimals(5);

# "d77bd"

id

id() (number)

The id method returns a machine unique thread-safe random numerical identifier.

Since 4.15

id example 1

# given: synopsis

package main;

my $id = $random->id;

# 1729257495154941

letter

letter() (string)

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

Since 1.11

letter example 1

# given: synopsis

package main;

my $letter = $random->letter;

# "i"

# $letter = $random->letter;

# "K"

letters

letters(number $count) (string)

The letters method returns n "letter" characters based on the number (i.e. count) provided.

Since 4.15

letters example 1

# given: synopsis

package main;

my $letters = $random->letters(5);

# "iKWMv"

# $letters = $random->letters(5);

# "Papmm"

lowercased

lowercased() (string)

The lowercased method returns a random lowercased letter.

Since 1.11

lowercased example 1

# given: synopsis

package main;

my $lowercased = $random->lowercased;

# "t"

# $lowercased = $random->lowercased;

# "i"

new

new(any @args) (Venus::Random)

The new method constructs an instance of the package.

Since 4.15

new example 1

package main;

use Venus::Random;

my $new = Venus::Random->new;

# bless(..., "Venus::Random")

new example 2

package main;

use Venus::Random;

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

# bless(..., "Venus::Random")

new example 3

package main;

use Venus::Random;

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

# bless(..., "Venus::Random")

nonce

nonce() (string)

The nonce method returns a 10-character "alphanumeric" string.

Since 4.15

nonce example 1

# given: synopsis

package main;

my $nonce = $random->nonce;

# "j2q1G45903"

# $nonce = $random->nonce;

# "7nmi8mT5Io"

nonzero

nonzero(string | coderef $code, any @args) (number | string)

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".

Since 1.11

nonzero example 1

# given: synopsis

package main;

my $nonzero = $random->nonzero;

# 7

# $nonzero = $random->nonzero;

# 3

nonzero example 2

# given: synopsis

package main;

my $nonzero = $random->nonzero("pick");

# 1.74452500006101

# $nonzero = $random->nonzero("pick");

# 1.34270147871891

nonzero example 3

# given: synopsis

package main;

my $nonzero = $random->nonzero("number");

# 3427014

# $nonzero = $random->nonzero("number");

# 3

nonzero example 4

# given: synopsis

package main;

my $nonzero = $random->nonzero("number", 0, 10);

# 8

# $nonzero = $random->nonzero("number", 0, 10);

# 3

number

number(number $from, number $upto) (number)

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.

Since 1.11

number example 1

# given: synopsis

package main;

my $number = $random->number;

# 3427014

# $number = $random->number;

# 3

number example 2

# given: synopsis

package main;

my $number = $random->number(5, 50);

# 39

# $number = $random->number(5, 50);

# 20

number example 3

# given: synopsis

package main;

my $number = $random->number(100, 20);

# 42

# $number = $random->number(100, 20);

# 73

number example 4

# given: synopsis

package main;

my $number = $random->number(5);

# 74451

# $number = $random->number(5);

# 34269

numbers

numbers(number $count) (string)

The numbers method returns n "number" characters (between 1 and 9) based on the number (i.e. count) provided.

Since 4.15

numbers example 1

# given: synopsis

package main;

my $numbers = $random->numbers(5);

# 74141

# $numbers = $random->numbers(5);

# 85578

password

password(number $count) (string)

The password method returns n "characters" based on the number (i.e. count) provided. The default length is 16.

Since 4.15

password example 1

# given: synopsis

package main;

my $password = $random->password;

# "0*89{745axCMg0m2"

# $password = $random->password;

# "5rV22V24>6Q1v#6N"

pick

pick(Num $data) (Num)

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.

Since 1.23

pick example 1

# given: synopsis

package main;

my $pick = $random->pick;

# 0.744525000061007

# $pick = $random->pick;

# 0.342701478718908

pick example 2

# given: synopsis

package main;

my $pick = $random->pick(100);

# 74.4525000061007

# $pick = $random->pick(100);

# 34.2701478718908

pick example 3

# given: synopsis

package main;

my $pick = $random->pick(2);

# 1.48905000012201

# $pick = $random->pick(2);

# 0.685402957437816

range

range(string $from, string $to) (number)

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

Since 1.11

range example 1

# given: synopsis

package main;

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

# 8

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

# 4

range example 2

# given: synopsis

package main;

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

# 5

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

# 8

range example 3

# given: synopsis

package main;

my $range = $random->range(0, 60);

# 45

# $range = $random->range(0, 60);

# 20

range example 4

# given: synopsis

package main;

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

# -2

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

# -4

repeat

repeat(number $times, string | coderef $code, any @args) (number | string)

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.

Since 1.11

repeat example 1

# given: synopsis

package main;

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

# (7, 3)

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

# (1, 4)

repeat example 2

# given: synopsis

package main;

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

# (1447361.5, "0.0000")

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

# ("482092.1040", 1555.7410393)

repeat example 3

# given: synopsis

package main;

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

# (")", 4)

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

# (8, "R")

reseed

reseed(string $seed) (Venus::Random)

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.

Since 1.11

reseed example 1

# given: synopsis

package main;

my $reseed = $random->reseed;

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

# my $bit = $random->bit;

# 0

reseed example 2

# given: synopsis

package main;

my $reseed = $random->reseed(42);

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

# my $bit = $random->bit;

# 0

reset

reset() (Venus::Random)

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.

Since 1.11

reset example 1

# given: synopsis

package main;

my $reset = $random->reset;

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

restore

restore() (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.

Since 1.11

restore example 1

# given: synopsis

package main;

my $restore = $random->restore;

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

select

select(arrayref | hashref $data) (any)

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

Since 1.11

select example 1

# given: synopsis

package main;

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

# "c"

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

# "b"

select example 2

# given: synopsis

package main;

my $select = $random->select({"a".."h"});

# "f"

# $select = $random->select({"a".."h"});

# "d"

shuffle

shuffle(string $string) (string)

The shuffle method returns the string provided with its characters randomly rearranged.

Since 4.15

shuffle example 1

# given: synopsis

package main;

my $shuffle = $random->shuffle('hello');

# "olhel"

# $shuffle = $random->shuffle('hello');

# "loelh"

symbol

symbol() (string)

The symbol method returns a random symbol.

Since 1.11

symbol example 1

# given: synopsis

package main;

my $symbol = $random->symbol;

# "'"

# $symbol = $random->symbol;

# ")"

symbols

symbols(number $count) (string)

The symbols method returns n "symbol" characters based on the number (i.e. count) provided.

Since 4.15

symbols example 1

# given: synopsis

package main;

my $symbols = $random->symbols(5);

# "')#=@"

# $symbols = $random->symbols(5);

# ".[+;,"

token

token() (string)

The token method returns a unique randomly generated "md5" digest.

Since 4.15

token example 1

# given: synopsis

package main;

my $token = $random->token;

# "86eb5865c3e4a1457fbefcc93e037459"

# $token = $random->token;

# "9be02d56ece7efe68bc59d2ebf3c4ed7"

uppercased

uppercased() (string)

The uppercased method returns a random uppercased letter.

Since 1.11

uppercased example 1

# given: synopsis

package main;

my $uppercased = $random->uppercased;

# "T"

# $uppercased = $random->uppercased;

# "I"

urlsafe

urlsafe() (string)

The urlsafe method returns a unique randomly generated URL-safe string based on "base64".

Since 4.15

urlsafe example 1

# given: synopsis

package main;

my $urlsafe = $random->urlsafe;

# "WtdsCPBQDKXPv2tcuFbBFcdDtJ6EZRyE3Xke0e65YRQ"

# $urlsafe = $random->urlsafe;

# "xXq7Mkwo7nLsFjMW8mvKgdzac5m4X0gFMykO1r0d7GA"

uuid

uuid() (string)

The uuid method returns a machine-unique randomly generated psuedo UUID string. Note: The identifier returned attempts to be unique across network devices but its uniqueness can't be guaranteed.

Since 4.15

uuid example 1

# given: synopsis

package main;

my $uuid = $random->uuid;

# "0d3eea5f-1826-3d37-e242-72ea44a157fd"

# $uuid = $random->uuid;

# "6e179032-c7fe-1dc6-61b8-cebd00fa06a1"

AUTHORS

Awncorp, awncorp@cpan.org

LICENSE

This program is free software, you can redistribute it and/or modify it under the terms of the Apache license version 2.0.

To install Venus, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Venus

CPAN shell

perl -MCPAN -e shell
install Venus

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

ABSTRACT

SYNOPSIS

DESCRIPTION

INHERITS

INTEGRATES

METHODS

alphanumeric

alphanumerics

base64

bit

bits

boolean

byte

bytes

character

characters

collect

digest

digit

digits

float

hexdecimal

hexdecimals

id

letter

letters

lowercased

new

nonce

nonzero

number

numbers

password

pick

range

repeat

reseed

reset

restore

select

shuffle

symbol

symbols

token

uppercased

urlsafe

uuid

AUTHORS

LICENSE

Module Install Instructions