Class XoShiRo256StarStar

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source64.LongProvider

org.apache.commons.rng.core.source64.AbstractXoShiRo256

org.apache.commons.rng.core.source64.XoShiRo256StarStar

All Implemented Interfaces:

RandomLongSource, JumpableUniformRandomProvider, LongJumpableUniformRandomProvider, RestorableUniformRandomProvider, UniformRandomProvider

public class XoShiRo256StarStar
extends AbstractXoShiRo256

A fast all-purpose 64-bit generator.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 256 bits and the period is 2²⁵⁶-1.

Since:

1.3

See Also:

• Original source code
• xorshiro / xoroshiro generators

Field Summary

Fields inherited from class AbstractXoShiRo256

state0, state1, state2, state3

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class AbstractXoShiRo256

getStateInternal, jump, longJump, next, setStateInternal

Methods inherited from class LongProvider

nextBoolean, nextInt, nextLong, resetCachedState

Methods inherited from class BaseProvider

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

Methods inherited from class Object

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

Methods inherited from interface JumpableUniformRandomProvider

jumps, jumps

Methods inherited from interface LongJumpableUniformRandomProvider

longJumps, longJumps

Methods inherited from interface 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

XoShiRo256StarStar

public XoShiRo256StarStar(long[] 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.

XoShiRo256StarStar

public XoShiRo256StarStar(long seed0,
 long seed1,
 long seed2,
 long 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.

XoShiRo256StarStar

protected XoShiRo256StarStar(XoShiRo256StarStar source)

Creates a copy instance.

Parameters:

source - Source to copy.

Method Details

nextOutput

protected long 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 AbstractXoShiRo256.next() before the current state is updated.

Specified by:

nextOutput in class AbstractXoShiRo256

Returns:

the next output

copy

protected XoShiRo256StarStar copy()

Create a copy.

Specified by:

copy in class AbstractXoShiRo256

Returns:

the copy