Class XoShiRo512PlusPlus

java.lang.Object

org.apache.commons.rng.core.BaseProvider

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

org.apache.commons.rng.core.source64.AbstractXoShiRo512

org.apache.commons.rng.core.source64.XoShiRo512PlusPlus

All Implemented Interfaces:

RandomLongSource, JumpableUniformRandomProvider, LongJumpableUniformRandomProvider, RestorableUniformRandomProvider, UniformRandomProvider

public class XoShiRo512PlusPlus
extends AbstractXoShiRo512

A fast all-purpose generator.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 512 bits and the period is 2⁵¹²-1. Speed is expected to be slower than XoShiRo256StarStar.

Since:

1.3

See Also:

• Original source code
• xorshiro / xoroshiro generators

Field Summary

Fields inherited from class AbstractXoShiRo512

state0, state1, state2, state3, state4, state5, state6, state7

Constructor Summary

Constructors

Modifier	Constructor	Description
	XoShiRo512PlusPlus(long[] seed)	Creates a new instance.
	XoShiRo512PlusPlus(long seed0, long seed1, long seed2, long seed3, long seed4, long seed5, long seed6, long seed7)	Creates a new instance using an 8 element seed.
protected	XoShiRo512PlusPlus(XoShiRo512PlusPlus source)	Creates a copy instance.

Method Summary

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

Methods inherited from class AbstractXoShiRo512

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

XoShiRo512PlusPlus

public XoShiRo512PlusPlus(long[] seed)

Creates a new instance.

Parameters:

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

XoShiRo512PlusPlus

public XoShiRo512PlusPlus(long seed0,
 long seed1,
 long seed2,
 long seed3,
 long seed4,
 long seed5,
 long seed6,
 long seed7)

Creates a new instance using an 8 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.

seed4 - Initial seed element 4.

seed5 - Initial seed element 5.

seed6 - Initial seed element 6.

seed7 - Initial seed element 7.

XoShiRo512PlusPlus

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

Specified by:

nextOutput in class AbstractXoShiRo512

Returns:

the next output

copy

protected XoShiRo512PlusPlus copy()

Create a copy.

Specified by:

copy in class AbstractXoShiRo512

Returns:

the copy