Class XoRoShiRo128StarStar

java.lang.Object

org.apache.commons.rng.core.BaseProvider

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

org.apache.commons.rng.core.source64.AbstractXoRoShiRo128

org.apache.commons.rng.core.source64.XoRoShiRo128StarStar

All Implemented Interfaces:

RandomLongSource, JumpableUniformRandomProvider, LongJumpableUniformRandomProvider, RestorableUniformRandomProvider, UniformRandomProvider

public class XoRoShiRo128StarStar
extends AbstractXoRoShiRo128

A fast all-purpose 64-bit generator.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 128 bits and the period is 2¹²⁸-1. Speed is expected to be similar to XoShiRo256StarStar.

Since:

1.3

See Also:

• Original source code
• xorshiro / xoroshiro generators

Field Summary

Fields inherited from class AbstractXoRoShiRo128

state0, state1

Constructor Summary

Constructors

Modifier	Constructor	Description
	XoRoShiRo128StarStar(long[] seed)	Creates a new instance.
	XoRoShiRo128StarStar(long seed0, long seed1)	Creates a new instance using a 2 element seed.
protected	XoRoShiRo128StarStar(XoRoShiRo128StarStar source)	Creates a copy instance.

Method Summary

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

Methods inherited from class AbstractXoRoShiRo128

getStateInternal, jump, longJump, next, performJump, 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

XoRoShiRo128StarStar

public XoRoShiRo128StarStar(long[] seed)

Creates a new instance.

Parameters:

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

XoRoShiRo128StarStar

public XoRoShiRo128StarStar(long seed0,
 long seed1)

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

Parameters:

seed0 - Initial seed element 0.

seed1 - Initial seed element 1.

XoRoShiRo128StarStar

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

Specified by:

nextOutput in class AbstractXoRoShiRo128

Returns:

the next output

copy

protected XoRoShiRo128StarStar copy()

Create a copy.

Specified by:

copy in class AbstractXoRoShiRo128

Returns:

the copy