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

Class XoShiRo128Plus

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.XoShiRo128Plus

All Implemented Interfaces:

RandomIntSource, JumpableUniformRandomProvider, LongJumpableUniformRandomProvider, RestorableUniformRandomProvider, UniformRandomProvider

public class XoShiRo128Plus
extends AbstractXoShiRo128

A fast 32-bit generator suitable for float generation. This is slightly faster than the all-purpose generator XoShiRo128StarStar.

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
	XoShiRo128Plus(int[] seed)	Creates a new instance.
	XoShiRo128Plus(int seed0, int seed1, int seed2, int seed3)	Creates a new instance using a 4 element seed.
protected	XoShiRo128Plus(XoShiRo128Plus source)	Creates a copy instance.

Method Summary

Modifier and Type	Method	Description
protected XoShiRo128Plus	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

XoShiRo128Plus

public XoShiRo128Plus(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.

XoShiRo128Plus

public XoShiRo128Plus(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.

XoShiRo128Plus

protected XoShiRo128Plus(XoShiRo128Plus 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 XoShiRo128Plus copy()

Create a copy.

Specified by:

copy in class AbstractXoShiRo128

Returns:

the copy