Package org.apache.commons.rng.core.source32

Class XoShiRo128PlusPlus

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source32.IntProvider

org.apache.commons.rng.core.source32.AbstractXoShiRo128

org.apache.commons.rng.core.source32.XoShiRo128PlusPlus

All Implemented Interfaces:

RandomIntSource, JumpableUniformRandomProvider, LongJumpableUniformRandomProvider, RestorableUniformRandomProvider, UniformRandomProvider

public class XoShiRo128PlusPlus
extends AbstractXoShiRo128

A fast all-purpose 32-bit generator. For faster generation of float values try the XoShiRo128Plus generator.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 128 bits.

Since:

1.3

See Also:

• Original source code
• xorshiro / xoroshiro generators

Field Summary

Fields inherited from class org.apache.commons.rng.core.source32.AbstractXoShiRo128

state0, state1, state2, state3

Constructor Summary

Constructors

Modifier	Constructor	Description
	XoShiRo128PlusPlus(int[] seed)	Creates a new instance.
	XoShiRo128PlusPlus(int seed0, int seed1, int seed2, int seed3)	Creates a new instance using a 4 element seed.
protected	XoShiRo128PlusPlus(XoShiRo128PlusPlus source)	Creates a copy instance.

Method Summary

Modifier and Type	Method	Description
protected XoShiRo128PlusPlus	copy()	Create a copy.
protected int	nextOutput()	Use the current state to compute the next output from the generator.

Methods inherited from class org.apache.commons.rng.core.source32.AbstractXoShiRo128

getStateInternal, jump, longJump, next, setStateInternal

Methods inherited from class org.apache.commons.rng.core.source32.IntProvider

nextBoolean, nextBytes, nextBytes, nextBytesFill, nextDouble, nextInt, nextLong, resetCachedState

Methods inherited from class org.apache.commons.rng.core.BaseProvider

checkIndex, checkStateSize, composeStateInternal, extendSeed, extendSeed, fillState, fillState, restoreState, saveState, splitStateInternal, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.rng.JumpableUniformRandomProvider

jumps, jumps

Methods inherited from interface org.apache.commons.rng.LongJumpableUniformRandomProvider

longJumps, longJumps

Methods inherited from interface org.apache.commons.rng.UniformRandomProvider

doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, nextBoolean, nextBytes, nextBytes, nextDouble, nextDouble, nextDouble, nextFloat, nextFloat, nextFloat, nextInt, nextInt, nextInt, nextLong, nextLong, nextLong

Constructor Details

XoShiRo128PlusPlus

public XoShiRo128PlusPlus(int[] seed)

Creates a new instance.

Parameters:

seed - Initial seed. If the length is larger than 4, only the first 4 elements will be used; if smaller, the remaining elements will be automatically set. A seed containing all zeros will create a non-functional generator.

XoShiRo128PlusPlus

public XoShiRo128PlusPlus(int seed0,
 int seed1,
 int seed2,
 int seed3)

Creates a new instance using a 4 element seed. A seed containing all zeros will create a non-functional generator.

Parameters:

seed0 - Initial seed element 0.

seed1 - Initial seed element 1.

seed2 - Initial seed element 2.

seed3 - Initial seed element 3.

XoShiRo128PlusPlus

protected XoShiRo128PlusPlus(XoShiRo128PlusPlus source)

Creates a copy instance.

Parameters:

source - Source to copy.

Method Details

nextOutput

protected int nextOutput()

Use the current state to compute the next output from the generator. The output function shall vary with respect to different generators. This method is called from AbstractXoShiRo128.next() before the current state is updated.

Specified by:

nextOutput in class AbstractXoShiRo128

Returns:

the next output

copy

protected XoShiRo128PlusPlus copy()

Create a copy.

Specified by:

copy in class AbstractXoShiRo128

Returns:

the copy