php8.5
Home/ Manual/ random / functions/ lcg_value

lcg_value

PHP function Deprecated as of PHP 8.4.0 Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Combined linear congruential generator

Function-8-4-0

Description

lcg_value(): float

lcg_value() returns a pseudo random number in the range of (0, 1). The function combines two CGs with periods of 2^31 - 85 and 2^31 - 249. The period of this function is equal to the product of both primes.

Cryptographically-insecure

Caution

Scaling the return value to a different interval using multiplication or addition (a so-called affine transformation) might result in a bias in the resulting value as floats are not equally dense across the number line. As not all values can be exactly represented by a float, the result of the affine transformation might also result in values outside of the requested interval.

Use Random\Randomizer::getFloat to generate a random float within an arbitrary interval. Use Random\Randomizer::getInt to generate a random integer within an arbitrary interval.

Parameters Parameters

Return Values

A pseudo random float value between 0.0 and 1.0, inclusive.

Changelog

VersionDescription
8.4.0This function has been deprecated.

See Also

  • Random\Randomizer::getFloat
  • Random\Randomizer::getInt
  • random_int()

Source: reference/random/functions/lcg-value.xml · from the official PHP manual (php/doc-en)