mortennajbjerg/random-probabilty

There is no license information available for the latest version (0.1) of this package.

0.1 2017-02-07 10:49 UTC

Unknown License

README

A class to return one or more random results based on a weighted probability.

Installation

Install this package through composer:

composer require mortennajbjerg/random-probabilty=dev-master

Examples

Retrieving a single result

<?php
require('vendor/autoload.php');

$randomProbabilty = new \RandomProbabilty\RandomProbabilty();

$randomProbabilty->add('peaches', 1);
$randomProbabilty->add('lemons', 9);
$randomProbabilty->add('oranges', 10);
$randomProbabilty->add('pears', 30);
$randomProbabilty->add('bananas', 50);

// Returns a random value based on the weighted probability
echo $RndProb->getResult(); // Ex. 'bananas'

Retrieving multiple results

<?php
require('vendor/autoload.php');

$randomProbabilty = new \RandomProbabilty\RandomProbabilty();

$randomProbabilty->add('peaches', 1);
$randomProbabilty->add('lemons', 9);
$randomProbabilty->add('oranges', 10);
$randomProbabilty->add('pears', 30);
$randomProbabilty->add('bananas', 50);

// Returns a result set of 3 values based on the weighted probability
var_dump($RndProb->getResults(3)); // Ex. ['bananas', 'bananas', 'pears']

Retrieving unique results

<?php
require('vendor/autoload.php');

$randomProbabilty = new \RandomProbabilty\RandomProbabilty();

$randomProbabilty->add('peaches', 1);
$randomProbabilty->add('lemons', 9);
$randomProbabilty->add('oranges', 10);
$randomProbabilty->add('pears', 30);
$randomProbabilty->add('bananas', 50);

// Returns a unique result set of 3 values based on the weighted probability
var_dump($RndProb->getUniqueResults(3)); // Ex. ['bananas', 'oranges', 'pears']