Faker\Provider\Biased Class Reference

Inheritance diagram for Faker\Provider\Biased:

Collaboration diagram for Faker\Provider\Biased:

Public Member Functions
	biasedNumberBetween ($min=0, $max=100, $function='sqrt')
Public Member Functions inherited from Faker\Provider\Base
	__construct (Generator $generator)
	optional ($weight=0.5, $default=null)
	unique ($reset=false, $maxRetries=10000)
	valid ($validator=null, $maxRetries=10000)

Static Protected Member Functions
static	unbiased ()
static	linearLow ($x)
static	linearHigh ($x)

Additional Inherited Members
Static Public Member Functions inherited from Faker\Provider\Base
static	randomDigit ()
static	randomDigitNotNull ()
static	randomDigitNot ($except)
static	randomNumber ($nbDigits=null, $strict=false)
static	randomFloat ($nbMaxDecimals=null, $min=0, $max=null)
static	numberBetween ($int1=0, $int2=2147483647)
static	passthrough ($value)
static	randomLetter ()
static	randomAscii ()
static	randomElements ($array=array('a', 'b', 'c'), $count=1, $allowDuplicates=false)
static	randomElement ($array=array('a', 'b', 'c'))
static	randomKey ($array=array())
static	shuffle ($arg='')
static	shuffleArray ($array=array())
static	shuffleString ($string='', $encoding='UTF-8')
static	numerify ($string='###')
static	lexify ($string='????')
static	bothify ($string='## ??')
static	asciify ($string=' ****')
static	regexify ($regex='')
static	toLower ($string='')
static	toUpper ($string='')
Protected Attributes inherited from Faker\Provider\Base
	$generator
	$unique

Member Function Documentation

biasedNumberBetween()

Faker\Provider\Biased::biasedNumberBetween	(		$min = 0,
			$max = 100,
			$function = 'sqrt'
	)

Returns a biased integer between $min and $max (both inclusive). The distribution depends on $function.

The algorithm creates two doubles, x ∈ [0, 1], y ∈ [0, 1) and checks whether the return value of $function for x is greater than or equal to y. If this is the case the number is accepted and x is mapped to the appropriate integer between $min and $max. Otherwise two new doubles are created until the pair is accepted.

Parameters

integer	$min	Minimum value of the generated integers.
integer	$max	Maximum value of the generated integers.
callable	$function	A function mapping x ∈ [0, 1] onto a double ∈ [0, 1]

Returns

integer An integer between $min and $max.

linearHigh()

static Faker\Provider\Biased::linearHigh (   $x )

staticprotected

'linearHigh' favors higher numbers. The probability increases in a linear fashion.

Returns

integer

linearLow()

static Faker\Provider\Biased::linearLow (   $x )

staticprotected

'linearLow' favors lower numbers. The probability decreases in a linear fashion.

Returns

integer

unbiased()

static Faker\Provider\Biased::unbiased ( )

staticprotected

'unbiased' creates an unbiased distribution by giving each value the same value of one.

Returns

integer

---

The documentation for this class was generated from the following file:

• vendor/fzaninotto/faker/src/Faker/Provider/Biased.php