Random Class Reference

Public Member Functions
	__construct ($seed=-1)
	setSeed ($seed)
	getSeed ()
	nextInt ()
	nextSignedInt ()
	nextFloat ()
	nextSignedFloat ()
	nextBoolean ()
	nextRange ($start=0, $end=0x7fffffff)
	nextBoundedInt ($bound)

Data Fields
const	X = 123456789
const	Y = 362436069
const	Z = 521288629
const	W = 88675123

Protected Attributes
	$seed

Detailed Description

XorShift128Engine Random Number Noise, used for fast seeded values Most of the code in this class was adapted from the XorShift128Engine in the php-random library.

Constructor & Destructor Documentation

__construct()

__construct

(

$seed = -1

)

Parameters

int

$seed

Integer to be used as seed.

                                           {
        if($seed === -1){
            $seed = time();
        }

        $this->setSeed($seed);
    }

Member Function Documentation

getSeed()

getSeed

(

)

                             {
        return $this->seed;
    }

nextBoolean()

nextBoolean

(

)

Returns a random boolean

Returns

bool

                                 {
        return ($this->nextSignedInt() & 0x01) === 0;
    }

nextBoundedInt()

nextBoundedInt

(

$bound

)

Parameters

$bound

Returns

int

                                          {
        return $this->nextInt() % $bound;
    }

nextFloat()

nextFloat

(

)

Returns a float between 0.0 and 1.0 (inclusive)

Returns

float

                               {
        return $this->nextInt() / 0x7fffffff;
    }

nextInt()

nextInt

(

)

Returns an 31-bit integer (not signed)

Returns

int

                             {
        return $this->nextSignedInt() & 0x7fffffff;
    }

nextRange()

nextRange	(		$start = 0,
			$end = 0x7fffffff
	)

Returns a random integer between $start and $end

Parameters

int	$start	default 0
int	$end	default 0x7fffffff

Returns

int

                                                            {
        return $start + ($this->nextInt() % ($end + 1 - $start));
    }

nextSignedFloat()

nextSignedFloat

(

)

Returns a float between -1.0 and 1.0 (inclusive)

Returns

float

                                     {
        return $this->nextSignedInt() / 0x7fffffff;
    }

nextSignedInt()

nextSignedInt

(

)

Returns a 32-bit integer (signed)

Returns

int

                                   {
        $t = ($this->x ^ ($this->x << 11)) & 0xffffffff;

        $this->x = $this->y;
        $this->y = $this->z;
        $this->z = $this->w;
        $this->w = ($this->w ^ (($this->w >> 19) & 0x7fffffff)
                ^ ($t ^ (($t >> 8) & 0x7fffffff))) & 0xffffffff;

        return $this->w;
    }

setSeed()

setSeed

(

$seed

)

Parameters

int

$seed

Integer to be used as seed.

                                  {
        $this->seed = $seed;
        $this->x = self::X ^ $seed;
        $this->y = self::Y ^ ($seed << 17) | (($seed >> 15) & 0x7fffffff) & 0xffffffff;
        $this->z = self::Z ^ ($seed << 31) | (($seed >> 1) & 0x7fffffff) & 0xffffffff;
        $this->w = self::W ^ ($seed << 18) | (($seed >> 14) & 0x7fffffff) & 0xffffffff;
    }

Field Documentation

$seed

$seed

protected

W

const W = 88675123

X

const X = 123456789

Y

const Y = 362436069

Z

const Z = 521288629

---

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

• src/pocketmine/utils/Random.php